Docs
The paperwork
The plan, the design calls, and the scopes, rendered from docs/ in the repository every time the site is built. What you read here is what the agents read.
Project
- Directiondocs/direction.mdThe north star for Life Framework. Read this before choosing what to build. docs/roadmap/ holds the scoped plan; docs/features.md holds what exists; docs/decisions.md holds the design calls that set...
- Decisionsdocs/decisions.mdProduct and design calls that set the taste of Life Framework. Each entry is a decision someone could reasonably have made the other way.
- Ecosystem leverage mapdocs/ecosystem.mdWhat the Reforger community and free-asset sites can give Life Framework, and under which terms. Surveyed 2026-11-08.
- Life/RP benchmarkdocs/research/life-rp-benchmark.mdWhat the life and roleplay genre built over fifteen years, what kept its players, what drove them away, and what that means for Life Framework after M1. Researched 2026-11-08.
Roadmap
- Roadmapdocs/roadmap/README.mdThe gameplay plan for the base mod.
- M1: Playtest Towndocs/roadmap/m1-playtest-town.mdM1 is done when a stranger joins a dedicated server hosted from the maintainer's PC and gets through the whole loop with nobody helping.
- M2 Living Town (outline)docs/roadmap/m2-outline.mdM2 leads with four themes the maintainer picked on 2026-11-08: moderation, medic, comms, and investigation. This file is an outline, not a plan.
- M1-25: the DebugWorld villagedocs/roadmap/m1-25-village.mdIssue #120. Decisions 2026-11-08 "Every M1 site moves onto one street now" and "The playtest town is a 1989 Everon village with a test annex" (decisions).
- Phasesdocs/roadmap/phases/README.mdPhases are playable cuts, in order. A later phase does not start by skipping the proof on the earlier one.
- After releasedocs/roadmap/phases/after-release.mdPlay the release cut, fix what breaks, then add the larger loops that are still missing. Order is by dependency, not by size.
- Alphadocs/roadmap/phases/alpha.mdA small group plays the systems already in the repository. This phase adds no new crime types, jobs, or assets. It proves the skeleton is stable enough to build the release scopes on.
- Releasedocs/roadmap/phases/release.mdThe first public feature set. Every item uses 1989 places and base-game assets. The shared breach is forced entry; the robberies are places that use it.
- Scopesdocs/roadmap/scopes/README.mdA scope is one plan a contributor can finish without boiling the framework. It names the player loop, what ships in the first slice, which assets are legal, and the proof.
- Bank robberydocs/roadmap/scopes/crime/bank-robbery.mdPhase: Release Extends: forced entry, Money, Crime, hand-carry
- Contrabanddocs/roadmap/scopes/crime/contraband.mdPhase: Release Extends: Gathering, Processing, Trader, hideouts, Police confiscation
- Forced entrydocs/roadmap/scopes/crime/forced-entry.mdPhase: Release Extends: door locks (Houses), crime alerts, police
- Gas station robberydocs/roadmap/scopes/crime/gas-station-robbery.mdPhase: Release Extends: Crime, Money
- Hospital robberydocs/roadmap/scopes/crime/hospital-robbery.mdPhase: Release Extends: forced entry, Crime, Money
- Jailbreakdocs/roadmap/scopes/crime/jailbreak.mdPhase: Release Extends: forced entry, jailing
- Craftingdocs/roadmap/scopes/later/crafting.mdPhase: After release Extends: Processing
- Eventsdocs/roadmap/scopes/later/events.mdPhase: After release Extends: notifications, the world markers used by jobs and missions
- Private housingdocs/roadmap/scopes/later/housing.mdPhase: After release Extends: Houses doors and keys, Money, persistence
- Police missionsdocs/roadmap/scopes/later/police-missions.mdPhase: After release Extends: ranks, tasks, Police
- Revivedocs/roadmap/scopes/later/revive.mdPhase: After release Extends: Survival, character death
- Tasksdocs/roadmap/scopes/later/tasks.mdPhase: After release Extends: Quests (LF_QuestTrackerComponent)
- UI kitdocs/roadmap/scopes/later/ui-kit.mdPhase: After release Extends: the workspace-widget screens already used by faction pick, character creation, and the death screen. Those screens stay as they are.
- Hideoutsdocs/roadmap/scopes/ownership/hideouts.mdPhase: Release Extends: Houses locks, organizations
- Organizationsdocs/roadmap/scopes/ownership/organizations.mdPhase: Release Extends: Account, Banking rules, persistence
- Vehiclesdocs/roadmap/scopes/ownership/vehicles.mdPhase: Release Extends: VehicleLock, LicensePlate, Shop
- Jailingdocs/roadmap/scopes/police/jailing.mdPhase: Release Extends: Police arrest, Account wanted
- Police ranksdocs/roadmap/scopes/police/ranks.mdPhase: Release Extends: License, Whitelist, Police duty
- Civilian jobsdocs/roadmap/scopes/work/civilian-jobs.mdPhase: Release Extends: Jobs, Level, License, Money
- Resourcesdocs/roadmap/scopes/work/resources.mdPhase: Release Extends: Gathering, Processing, Resources, Trader
- What the scopes reusedocs/roadmap/sources.mdThree sources, in this order.
- Testing plandocs/roadmap/testing/README.mdEvery roadmap setup is done only when three gates are green. A scope doc's Proof section is the short list. This file is the case list, the DebugWorld entities, and the shots.
Community guides (2025)
- Guide for contributers new to Githubwebsite/content/docs/guide-for-contributers-new-to-github.mdTime required: ~5-10 Minutes
- Welcomewebsite/content/docs/welcome.mdFounded 30th of November 2025.
- Architecture & Principleswebsite/content/docs/architecture-principles.mdWelcome to the development documentation for our Life Mod. Our goal is to build a framework that is flexible, easy to configure, and friendly to modders.