Godot Engine Integration

Configure Hyperstone to work with your Godot Engine installation for seamless project management, building, and testing.

What You'll Need

• Godot Engine 4.x installed on your system
• Recommended version: Godot 4.6 or higher
• The path to your Godot executable

Supported Versions

Hyperstone supports Godot 4.x versions:

• ✅ Godot 4.6+ (Recommended)
• ✅ Godot 4.5
• ✅ Godot 4.4
• ✅ Godot 4.3
• ✅ Godot 4.2
• ⚠️ Godot 4.0-4.1 (May have limited compatibility)
• ❌ Godot 3.x (Not supported)

Why 4.6+? Godot 4.6 includes important stability improvements, better export templates, and enhanced C# support that work best with Hyperstone's features.

Finding Your Godot Executable Path

The location of your Godot executable depends on your operating system and how you installed it.

Linux

If installed via package manager:

which godot4
# or
which godot

Common locations:

• /usr/bin/godot4
• /usr/bin/godot
• /usr/local/bin/godot4
• ~/.local/bin/godot4

If downloaded manually:

• ~/Downloads/Godot_v4.6_linux.x86_64
• ~/Applications/Godot_v4.6_linux.x86_64
• Wherever you extracted the downloaded file

Windows

If installed via Steam:

C:\Program Files (x86)\Steam\steamapps\common\Godot Engine\godot.exe

If downloaded manually:

C:\Users\YourUsername\Downloads\Godot_v4.6_win64.exe
C:\Program Files\Godot\Godot_v4.6_win64.exe

Tip: Right-click on the Godot shortcut → Properties → "Target" field shows the full path

macOS

If installed via Homebrew:

which godot

If downloaded manually:

/Applications/Godot.app/Contents/MacOS/Godot

Tip: Right-click Godot.app → Show Package Contents → Contents → MacOS → Godot

Setting Up in Hyperstone

Step 1: Open Settings

1. Launch Hyperstone
2. Navigate to Settings → Local Settings
3. Find the Engine Configuration section

Step 2: Enter the Path

1. Click on the Godot Executable Path input field
2. Paste the full path to your Godot executable
3. Examples:
   • Linux: /usr/bin/godot4
   • Windows: C:\Program Files\Godot\Godot_v4.6_win64.exe
   • macOS: /Applications/Godot.app/Contents/MacOS/Godot

Or use Auto-detect:

1. Click the Auto-detect button
2. Hyperstone will search common locations for Godot
3. If found, the path will be filled automatically

Or use Browse:

1. Click the Browse button
2. Navigate to your Godot executable
3. Select it and click Open

Step 3: Verify the Installation

1. Click the Test Engine button next to the path field
2. Hyperstone will check if:
   • The path exists
   • The file is executable
   • It's a valid Godot 4.x installation
3. You should see a success message with the detected Godot version

Step 4: Save

1. Click Save Settings to apply the settings
2. Hyperstone is now configured to use your Godot installation

What This Enables

Once configured, Hyperstone can:

• Launch Projects: Open your projects directly in Godot Editor
• Build Exports: Create builds for Linux, Windows, Web, and other platforms
• Run Tests: Execute your game in test mode
• Shader Lab: Preview and edit shaders with live reload
• Scene Preview: Quick preview of scenes without opening the full editor
• Headless Builds: Create builds without opening the Godot UI

Testing Your Configuration

After setting up Godot integration, test it by:

1. Opening a Godot project in Hyperstone
2. Clicking the Open in Godot button
3. The project should open in the Godot Editor

If it doesn't work, check the troubleshooting section below.

Using Multiple Godot Versions

If you have multiple Godot versions installed:

1. Hyperstone currently supports one Godot path at a time
2. Set the path to your primary/recommended version (4.6+)
3. You can manually change the path in settings when needed

Future Feature: Hyperstone will support multiple Godot versions per project in a future update.

Troubleshooting

"Godot Not Found" Error

• Check the path: Make sure you copied the complete path including the filename
• Check permissions: Ensure the file is executable
  • Linux/macOS: Run chmod +x /path/to/godot if needed
• Check file exists: Navigate to the path in your file manager to verify

"Invalid Godot Version" Error

• Check version: Hyperstone requires Godot 4.x
• Update Godot: Download the latest version from godotengine.org (opens in a new tab)
• Check executable: Make sure you're pointing to the actual Godot binary, not a launcher script

"Permission Denied" Error

Linux/macOS:

chmod +x /path/to/godot

Windows:

• Right-click the Godot executable
• Properties → Security → Edit
• Ensure your user has "Read & Execute" permissions

Projects Won't Open in Godot

• Check project.godot: Ensure your project has a valid project.godot file
• Check Godot version: Some projects require specific Godot versions
• Check console: Look at Hyperstone's console for error messages

Builds Fail

• Export templates: Make sure you've installed export templates in Godot
  • Open Godot → Editor → Manage Export Templates
  • Download templates for your Godot version
• Check export presets: Ensure your project has export presets configured
• Check permissions: Ensure Hyperstone has write access to the build output directory

Installing Godot (If Not Installed)

Linux

Via Package Manager (Recommended):

# Flatpak
flatpak install flathub org.godotengine.Godot
 
# Snap
snap install godot-4
 
# Arch Linux
sudo pacman -S godot

Manual Download:

1. Visit godotengine.org/download (opens in a new tab)
2. Download "Godot Engine - Linux/X11 64-bit"
3. Extract and make executable: chmod +x Godot_v4.6_linux.x86_64

Windows

Via Steam:

1. Open Steam
2. Search for "Godot Engine"
3. Install (Free)

Manual Download:

1. Visit godotengine.org/download (opens in a new tab)
2. Download "Godot Engine - Windows 64-bit"
3. Extract the ZIP file
4. Run the .exe file

macOS

Via Homebrew:

brew install godot

Manual Download:

1. Visit godotengine.org/download (opens in a new tab)
2. Download "Godot Engine - macOS Universal"
3. Open the DMG file
4. Drag Godot.app to Applications folder

Export Templates

For building/exporting games, you need to install export templates:

1. Open Godot Editor
2. Go to Editor → Manage Export Templates
3. Click Download and Install
4. Select your Godot version (should match your installation)
5. Wait for download and installation to complete

Note: Export templates are version-specific. If you update Godot, you'll need to download new templates.

Updating Godot

When you update Godot:

1. Download and install the new version
2. Update the path in Hyperstone settings if the location changed
3. Click Verify to confirm the new version
4. Install new export templates in Godot

Removing the Integration

To remove Godot integration:

1. Go to Settings → Local Settings
2. Find the Engine Configuration section
3. Clear the executable path field
4. Click Save Settings

Note: This only removes the integration from Hyperstone. It doesn't uninstall Godot from your system.

Related Documentation

• Settings - Complete settings guide
• Installation & Setup - Initial configuration