Skip to content

setup.md

Latest commit

 

History

History
234 lines (167 loc) · 6.87 KB

setup.md

File metadata and controls

234 lines (167 loc) · 6.87 KB

Workstation Setup

Shared workstation setup for both source trees in this repo.

.NET 9 SDK

Godot 4.5+ requires .NET 9.

Linux (Ubuntu/Debian)

wget -q https://dot.net/v1/dotnet-install.sh -O /tmp/dotnet-install.sh
chmod +x /tmp/dotnet-install.sh
/tmp/dotnet-install.sh --channel 9.0 --install-dir ~/.dotnet

Add to ~/.bashrc:

export PATH="$HOME/.dotnet:$PATH"
export DOTNET_ROOT="$HOME/.dotnet"

macOS

brew install dotnet@9

Verify

dotnet --version   # 9.0.x

System Packages

sudo apt-get install vulkan-tools xvfb ffmpeg imagemagick
  • vulkan-tools — vulkaninfo for GPU validation
  • xvfb — virtual X11 display. Godot needs a display server for any rendering (including offscreen --write-movie), even with an NVIDIA GPU. On headless machines (SSH, CI), xvfb provides this.
  • ffmpeg — AVI→MP4 conversion, video frame extraction
  • imagemagick — image resize, flip, crop for sprite pipelines
# ImageMagick 7 (provides `magick` CLI — apt only has v6)
wget https://imagemagick.org/archive/binaries/magick
chmod +x magick
sudo mv magick /usr/local/bin/

macOS

brew install coreutils ffmpeg dotnet@9
  • coreutils — provides gtimeout; the capture script falls back to a perl-based timeout if missing
  • ffmpeg — AVI→MP4 conversion
  • macOS uses Metal natively — no xvfb or Vulkan setup needed.

Python

Requires Python 3.10+.

python3 --version
pip install -r claude/skills/godogen/tools/requirements.txt
# or
pip install -r codex/skills/godogen/tools/requirements.txt

The two requirements files should stay aligned. Install either one in the source repo.

In a published game repo, the same file lives at:

  • .claude/skills/godogen/tools/requirements.txt for Claude Code
  • .agents/skills/godogen/tools/requirements.txt for Codex

Godot (.NET edition)

The .NET edition is required — the standard Godot build cannot run C# scripts. Download from the Mono/.NET column on the Godot downloads page.

Linux

VERSION=$(curl -s https://api.github.com/repos/godotengine/godot/releases/latest | grep -oP '"tag_name": "\K[^"]+' | sed 's/-stable//')
echo "Installing Godot .NET $VERSION"
cd /tmp
wget https://github.com/godotengine/godot/releases/download/${VERSION}-stable/Godot_v${VERSION}-stable_mono_linux_x86_64.zip
unzip Godot_v${VERSION}-stable_mono_linux_x86_64.zip
sudo mv Godot_v${VERSION}-stable_mono_linux_x86_64/Godot_v${VERSION}-stable_mono_linux.x86_64 /usr/local/bin/godot
sudo mv Godot_v${VERSION}-stable_mono_linux_x86_64/GodotSharp /usr/local/bin/GodotSharp

GodotSharp/ must live next to the godot binary. Godot resolves it relative to itself — if you symlink godot, the directory must be next to the real binary, not the symlink.

macOS

# Download .NET build from godotengine.org, or:
brew install --cask godot-mono

Godot must be on PATH as godot. If installed from the .app bundle:

sudo ln -sf /Applications/Godot_mono.app/Contents/MacOS/Godot /usr/local/bin/godot

Verify

godot --version          # should show version
godot --headless --quit  # should exit cleanly (may show RID warnings — harmless)

If godot --headless --quit crashes with assembly errors, GodotSharp/ is not being found. Check it's next to the binary:

ls "$(dirname "$(which godot)")"/GodotSharp/

Android Export

OpenJDK 17

sudo apt-get install -y openjdk-17-jdk

Android SDK

Download command-line tools from https://developer.android.com/studio#command-line-tools-only and install:

sudo mkdir -p /opt/android-sdk/cmdline-tools
cd /tmp && wget -q https://dl.google.com/android/repository/commandlinetools-linux-11076708_latest.zip -O cmdline-tools.zip
sudo unzip -o cmdline-tools.zip -d /opt/android-sdk/cmdline-tools/
sudo mv /opt/android-sdk/cmdline-tools/cmdline-tools /opt/android-sdk/cmdline-tools/latest

Install required SDK components:

sudo /opt/android-sdk/cmdline-tools/latest/bin/sdkmanager --sdk_root=/opt/android-sdk \
  "platform-tools" "build-tools;35.0.1" "platforms;android-35" \
  "cmake;3.10.2.4988404" "ndk;28.1.13356709"

Export Templates

Download the TPZ matching your Godot version and unpack:

VERSION=$(godot --version | cut -d. -f1-3)
TEMPLATE_DIR=~/.local/share/godot/export_templates/${VERSION}.stable
mkdir -p "$TEMPLATE_DIR"
cd /tmp
wget -q "https://github.com/godotengine/godot/releases/download/${VERSION}-stable/Godot_v${VERSION}-stable_export_templates.tpz" -O export_templates.tpz
unzip -o export_templates.tpz -d /tmp/tpz_extract
mv /tmp/tpz_extract/templates/* "$TEMPLATE_DIR/"

Debug Keystore

Generate once (Godot uses this for debug signing):

mkdir -p ~/.local/share/godot/keystores
keytool -genkey -v -keystore ~/.local/share/godot/keystores/debug.keystore \
  -alias androiddebugkey -keyalg RSA -keysize 2048 -validity 10000 \
  -storepass android -keypass android \
  -dname "CN=Android Debug,O=Android,C=US"

Godot Editor Settings

Run godot --headless --quit once in any project to generate the settings file, then set Android paths in ~/.config/godot/editor_settings-4.5.tres:

export/android/debug_keystore = "/home/<user>/.local/share/godot/keystores/debug.keystore"
export/android/debug_keystore_user = "androiddebugkey"
export/android/debug_keystore_pass = "android"
export/android/java_sdk_path = "/usr/lib/jvm/java-17-openjdk-amd64"
export/android/android_sdk_path = "/opt/android-sdk"

All three keystore fields must be set together or Godot silently fails.

Verify

java -version                    # 17.x
/opt/android-sdk/platform-tools/adb --version
ls ~/.local/share/godot/export_templates/*/android_debug.apk

API Keys

Set in environment:

  • GOOGLE_API_KEY — Gemini image generation (references, characters, precise work)
  • XAI_API_KEY — xAI Grok image/video generation (textures, simple objects)
  • TRIPO3D_API_KEY — image-to-3D conversion (3D games only)

Notifications (optional)

tg-push is a single-shot CLI that sends text plus an optional image or video to Telegram. The agent uses it to report progress, QA verdicts, and the final video — especially useful when a run executes on a remote server.

pipx install tg-push

Set TG_BOT_TOKEN (from @BotFather) and TG_CHAT_ID in the environment.

Verify All

dotnet --version                 # 9.0.x
godot --version                  # 4.x.x.stable.mono
nvidia-smi                       # GPU available
python3 -c "import rembg; print('rembg ok')"

Verify rendering pipeline (GPU + xvfb):

# NVIDIA Vulkan driver
VK_ICD_FILENAMES=/usr/share/vulkan/icd.d/nvidia_icd.json vulkaninfo --summary 2>&1 | grep "deviceName"

# xvfb + Godot (headless rendering — the actual capture path)
xvfb-run -a godot --headless --quit