Files
chemo-sim/docs/BUILD_GUIDE.md
T
zwitschi 8462a2fde7
Build / Export windows (push) Successful in 10m56s
Build / Export linux (push) Successful in 6m10s
feat: Implement nausea symptom system and related features
- Added SymptomManager autoload for managing symptom intensities.
- Introduced nausea tilt effect for camera roll based on nausea intensity.
- Created color desaturation shader and overlay for visual feedback.
- Developed TreatmentManager to handle nausea ramping during IV treatment.
- Added hospital room scene with first-person controller and interactions.
- Implemented sit-down interaction for the treatment chair.
- Created IV insertion sequence with animations and completion signal.
- Added player controller with movement and interaction capabilities.
- Integrated nausea effects into the player experience with smooth transitions.
2026-05-30 14:14:38 +02:00

77 lines
1.8 KiB
Markdown

# Build Guide
Chemo-Sim — How to build from source.
## Prerequisites
- [Godot 4.x](https://godotengine.org/download) (lock to a specific minor version, not "latest")
- Git
- (Windows) PowerShell 5+
- (Linux) bash
## Quick Start
```bash
git clone <repo-url> chemo-sim
cd chemo-sim
```
Open `project.godot` in the Godot editor, or run:
```bash
godot --editor
```
## Local Export
### Windows
```bash
godot --export-release Windows "build/windows/chemo-sim.exe"
```
### Linux
```bash
godot --export-release Linux "build/linux/chemo-sim.x86_64"
```
## CI/CD (Gitea Actions)
Builds run automatically on push to `main`. See `.gitea/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](https://semver.org/): `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/chemo-sim.x86_64` |
| Godot version mismatch | Check CI config and local Godot version match |