worldbox-observer-mod/README.md
2026-07-14 12:58:19 -05:00

31 lines
904 B
Markdown

# IdleSpectator
WorldBox NeoModLoader mod: AFK camera spectator (Phase 1 Hello World is working).
## Layout
- `IdleSpectator/` - mod source (`mod.json`, `Main.cs`) loaded by NML
- `scripts/verify-nml.sh` - checks that the Hello World line appears in Player.log
## Game API notes (for later spectator work)
Useful real types (not placeholders): `MoveCamera`, `WorldLog` / `WorldLogMessage`, `WarManager`, `BattleKeeperManager`, `Actor`, `MapBox` (`locatePosition`, `locateAndFollow`).
## Deploy
Symlink the mod into the game Mods folder (already done on this machine):
```bash
ln -sfn "$(pwd)/IdleSpectator" \
"$HOME/.local/share/Steam/steamapps/common/worldbox/Mods/IdleSpectator"
```
Requires NeoModLoader in `worldbox_Data/StreamingAssets/mods/` and **Experimental Mode** enabled in Settings.
## Verify
```bash
./scripts/verify-nml.sh
```
Look for: `[NML]: [IdleSpectator]: Hello World!`