Hails
d8794cbc1f
- Retail (the recomp, reference only): the vehicle collision callback sets the alarm only
while the car is parked (StayingParked) and the contact vector exceeds 0.1
(livingworld vehicle characteristics); any collider; every contact restarts the alarm and
parked timers; StopAlarming after 8 s; no pull-out while alarming; no impact sound.
- Engine: VehicleParked, VehicleImpact { vehicle, by, impact }, CarAlarmRule
(AlarmTuning from the setup export world_tuning.vehicle_alarm), VehicleAlarmStarted;
the alarm holds horn state 6 for whole console frames past the time.
- Mods: world_audio event 'impact', traffic option parked, sdk.world_audio.alarm_rule,
read(key).alarm. The world-audio test mod's parked taxi alarms on contact.
- No-mod e2e bench byte-identical (84 / 84); tests; doc 15, traffic spec.
Tools
The top-level scripts here are the repository's own tooling: setup and asset preparation (setup.py,
prepare_assets.py, asset_pipeline/, owned_game/), the updater, release and build helpers, and their
tests. They are documented where they are used (the main README and the scripts' own help).
The folders below are standalone helper tools for development and research. Each has a README.md
with what it does, its inputs, usage, example output and requirements. They read your own copy of the
game; none of them contain game code or data. Default work folders are under .local/ (gitignored).
| Folder | What it is for |
|---|---|
audio-file-inspect/ |
Readers for the audio formats: ABKC banks and MOIR projects, SPLC banks, .ems emitter files, .grain data; decode bank samples. |
audio-e2e/ |
Scripted scenarios for the headless audio render and analysis of the renders (diffs, levels, voices, bus share). |
audio-bench/ |
Audio performance: hashed e2e bench runs, timing summaries, emitter bank memory. |
recomp-trace/ |
For use with the Skate 3 recomp's research hooks (research-hooks branch): read and analyse trace sessions. Reference only; you build the recomp and set up the paths yourself. |
The general research and regression helpers (regression checks, setup equivalence, collision / world-stream / vault inspection, recomp code search) are in their own PR, #37.
See docs/hails-additions/14-published-tools.md for the background.