Townscaper-style modular building sandbox
docs/GETTING_STARTED.md — full first-time setup, troubleshooting, and an in-app walkthrough.
| Platform | Command |
|---|---|
| Windows (PowerShell) | .\scripts\setup.ps1 |
| macOS (Terminal) | chmod +x scripts/*.sh && ./scripts/setup-mac.sh |
| Linux | chmod +x scripts/*.sh && ./scripts/setup.sh |
Then run:
cargo runFirst compile can take 10–30+ minutes; later runs are much faster.
- Rust (stable)
- Windows: Visual Studio Build Tools with Desktop development with C++ (provides
link.exe) - macOS: Xcode Command Line Tools (
xcode-select --install) — see Getting started → macOS - Linux:
build-essentialor equivalent
| Input | Action |
|---|---|
1 / 2 / 3 |
Place / Select / Paint |
| Tab | Toggle Place ↔ Select |
| LMB | Place / select / paint face |
| Q / E | Rotate |
| Del | Delete selection |
| Alt + RMB | Delete block under cursor |
| Ctrl+Z / Ctrl+Y | Undo / redo (macOS: Control, not Command) |
| WASD + RMB drag + scroll | Camera |
Rebind keys in Settings → Keybindings. Full list: PORT.md.
| Path | Description |
|---|---|
src/ |
Game code (Bevy plugins, systems, UI) |
assets/mods/ |
Built-in mod packs |
docs/ |
Formats, porting notes, getting started |
scripts/ |
setup.ps1, setup-mac.sh, setup.sh, run.ps1, run.sh |
- Built-in:
assets/mods/sample_pack/mod.json - User mods: OS app data folder — see GETTING_STARTED.md
- Getting started — setup scripts + walkthrough
- PORT.md — port status and controls
- docs/data_formats.md —
mod.json, sections - docs/godot_gotchas.md — Godot → Bevy notes
- Godot reference:
~/Documents/builder(original project) - Port spec:
PORT.mdanddocs/