worldbox-observer-mod/README.md
2026-07-14 15:55:22 -05:00

36 lines
1.2 KiB
Markdown

# IdleSpectator
WorldBox NeoModLoader mod: AFK Idle Spectator camera director.
## Controls
- **I** - toggle Idle Spectator on/off
- **F9** - toggle Character Chronicle side panel (non-modal; works with focus)
- Dragging the camera while Spectator is on turns it off (after a short grace period)
## What it follows
Priority (wiki-aligned):
1. **Epic** - wars, kingdom fall/shatter, city destroyed, disasters
2. **Story** - kings, clans, alliances, favorites, new kingdoms/cities
3. **Action** - live battles/skirmishes (civ or wild), fighting units
4. **Curiosity** - new subspecies (low priority; will not interrupt fights)
5. **Ambient** - highest-scoring alive creature on the map (works on fresh animal-only worlds)
While watching, a **dossier caption** shows who they are (species, kills, age, roles).
Lingering on someone writes a **Chronicle** line; F9 lists them and click jumps the camera.
## Layout
- `IdleSpectator/` - mod source (`mod.json` + C#), loaded/compiled by NML
- `scripts/verify-nml.sh` - load verification helper
## Deploy
```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.