chemo-sim/docs/BUILD_GUIDE.md

Build Guide

Chemo-Sim — How to build from source.

Prerequisites

• Godot 4.x (lock to a specific minor version, not "latest")
• Git
• (Windows) PowerShell 5+
• (Linux) bash

Quick Start

git clone <repo-url> chemo-sim
cd chemo-sim

Open project.godot in the Godot editor, or run:

godot --editor

Local Export

Windows

godot --export-release Windows "build/windows/YOU_GET_CHEMO.exe"

Linux

godot --export-release Linux "build/linux/YOU_GET_CHEMO.x86_64"

CI/CD (GitHub Actions)

Builds run automatically on push to main. See .github/workflows/build.yml.

To trigger manually:

1. Go to Actions tab
2. Select "Build" workflow
3. Run workflow

Artifacts appear in the workflow run summary.

Export Templates

Export templates are in export_templates/:

• windows.export
• linux.export

These configure platform-specific settings (icon, version, etc.). Edit via Godot Editor → Project → Export.

Versioning

Follow Semantic Versioning: MAJOR.MINOR.PATCH

• MAJOR: Breaking changes / major content milestones
• MINOR: New features / new minigames
• PATCH: Bug fixes

Set version in project.godot → application/config/version.

Troubleshooting

Problem	Fix
Export fails with missing templates	Download export templates in Godot Editor → Manage Export Templates
Linux build won't run	chmod +x build/linux/YOU_GET_CHEMO.x86_64
Godot version mismatch	Check CI config and local Godot version match