Skip to content

development.md

Latest commit

 

History

History
74 lines (48 loc) · 1.3 KB

development.md

File metadata and controls

74 lines (48 loc) · 1.3 KB

WorldObserver — Development

WorldObserver is part of the DREAM mod family (Build 42):

Prereqs (for the dev/ scripts): rsync, inotifywait (inotify-tools), inkscape, and a Lua 5.1 interpreter for the smoke test.

Submodules

git submodule update --init external/LQR external/lua-reactivex

Sync

Deploy to your local Workshop wrapper folder:

./dev/sync-workshop.sh

Watch

Watch + deploy (default: Workshop wrapper under ~/Zomboid/Workshop):

./dev/watch.sh

Tests

Headless unit tests:

busted --helper=tests/helper.lua tests/unit

Note: tests assume DREAMBase is available at ../DREAMBase (DREAM layout) or external/DREAMBase.

Lint

luacheck Contents/mods/WorldObserver/42/media/lua/shared/WorldObserver Contents/mods/WorldObserver/42/media/lua/shared/WorldObserver.lua

LQR tests (submodule)

cd external/LQR
busted tests/unit

Pre-commit hooks

This repo ships a .pre-commit-config.yaml mirroring CI (luacheck + unit tests).

Enable hooks:

pre-commit install

Run on demand:

pre-commit run --all-files

Loader smoke test (after syncing):

./dev/sync-workshop.sh
SOURCE=workshop ./dev/smoke.sh