18 lines
1.0 KiB
Markdown
18 lines
1.0 KiB
Markdown
# Development
|
|
|
|
Requirements:
|
|
- `just`
|
|
- `jq`
|
|
- `luacheck`
|
|
- [CraftOS-PC](docs/install-craftos-pc.md) ≥ v2.8.3 — local harness for the CC:Tweaked sandbox; see [`docs/craftos_pc_glossary.md`](docs/craftos_pc_glossary.md) for CLI flags, mounting, `periphemu`, save data, and troubleshooting references.
|
|
|
|
After cloning the repository, run:
|
|
|
|
```sh
|
|
just install
|
|
```
|
|
|
|
This installs the local Git hooks, including a pre-commit hook that runs `just ci`.
|
|
|
|
`just ci` is the local verification entry point. Today it verifies that `craftos --version` reports v2.8.3 or newer, runs `just check` for `luacheck`, and runs `just test` for CraftOS-PC headless smoke tests. Use `just craftos` to launch CraftOS-PC with repo-local save data under `.craftos` and read-only mounts for `/trapos`, `/apis`, `/programs`, `/servers`, and `/startup`. `just repl` opens the same environment with `--cli` for human interactive use only; LLM agents must not run it. Use the CraftOS-PC glossary when adjusting `--headless`, `--exec`, `--script`, `--rom`, or `--mount-*` usage.
|