This package is structured for Codex, not Claude.
Codex should use AGENTS.md as the persistent project instruction file, then work from the current handoff pack in docs/handoff/.
A repo scaffold for starting development of Liminal Dominion Version 0.1.
This is not the full game. This is not a finished Unreal build. This repo is the planning, data, prototype, and content scaffold the team is using to build Version 0.1.
Read AGENTS.md, then read `docs/handoff/CURRENT_STATUS.md` and `docs/handoff/NEXT_CODEX_TASKS.md`. Continue from the current Unreal graybox, DataTable import, and Blueprint wiring phase rather than restarting the old validation-first scaffold tasks.
- Unreal Engine 5
- Primary playable target: Windows 10/11 PC
- Secondary development target: macOS
- Graybox-only
- Data-driven items/factions
- One faction hub shell
- One personal room shell
- One Level 1 Service Halls raid zone
- One entity
- One extraction loop
- Expanded JSON schemas and seed data cover V0.1 items, factions, loot, entities, storage, sanity, extractions, hub upgrades, player state, and run state.
scripts/validate_seed_data.pyvalidates schemas, duplicate IDs, and cross-data references.- Prototype Python modules model registries, loot rolls, inventory/storage, capped personal-storage overflow, sanity, extraction requirements, project-board contributions, end-to-end run outcomes, and local profile persistence before Unreal integration.
- A content-first UE5 project now exists in
LiminalDominion.uproject,Config/, andContent/. - The current Unreal graybox automation includes shell geometry, route landmarks, and smoke-test step signage inside the repo-owned maps.
- The earlier C++ gameplay scaffold is preserved in
Source_Legacy/and can be re-enabled later when the Windows toolchain is ready. - Non-Unreal framework docs and prototypes now cover faction loadouts, no-team-kill social rules, trader purchases, the 21-NPC master roster, NPC/quest contracts, weapons/ammo, Trail String navigation, gun-noise responses, loot density, project-board contribution rules, the playable loop contract, and a local save-profile contract.
docs/planning/MISSING_SYSTEMS_ROADMAP.mdtracks the gap between this scaffold, the V0.1 graybox, and the full game.
Start with docs/SYSTEM_INDEX.md when handing the project to another AI agent or developer.
The current repo handoff pack now lives under docs/handoff/ and supersedes the earlier starter-pack framing.
On macOS Terminal:
python3 -m pip install -r requirements.txt
python3 scripts/validate_seed_data.py
python3 -m unittest discover -s tests -v
python3 scripts/check_dev_environment.py
python3 scripts/playable_loop_model.py
python3 scripts/persistence_model.pyOn Windows PowerShell:
py -3 -m pip install -r requirements.txt
py -3 scripts/validate_seed_data.py
py -3 -m unittest discover -s tests -v
py -3 scripts/check_dev_environment.py
py -3 scripts/playable_loop_model.py
py -3 scripts/persistence_model.pyTo run the Windows Unreal startup sequence from the repo:
powershell -ExecutionPolicy Bypass -File scripts/start_windows_unreal.ps1The current visualization-first startup opens the repo-owned LD_Hub_Greybox map by default. If code modules are re-enabled later, the same script will require Visual Studio 2022 build tools and a Windows 10/11 SDK.
See docs/technical/CROSS_PLATFORM_COMPATIBILITY.md for macOS Terminal basics, Windows PowerShell equivalents, and the Windows-first build policy.
See docs/technical/UNREAL_PROJECT_SETUP.md for the first UE5 editor open, map creation, Blueprint pass, and Windows build gate.
See docs/technical/INSTALL_UNREAL_MAC.md for installing Unreal Engine through Epic Games Launcher on this Mac.
See docs/technical/WINDOWS_UNREAL_HANDOFF.md for moving setup to a Windows PC with enough storage for Unreal.
This repo is configured for the GitHub remote https://github.com/The-Daly/liminal.git.
Use GitHub Desktop for browser/app-based sign-in and pushing without Terminal credential prompts. See docs/technical/GITHUB_DESKTOP_SETUP.md.