lurelockv1.0
developers · documentation

The docs, in the open.

The whole point of a bootstrapper that whispers “show me every file” is that it should be auditable. These pages describe how the project is built, why it's organised this way, and exactly what the manager does and doesn't do. The source is public; the license is not permissive — read the legal note before copying anything.

00

Reading order

If you only read one page, read the legal one. Then: source → flags → mods → theming.

  1. 01

    Building from source

    Tools, layout, and the exact commands to produce the same exe the release ships. Ten minutes, no build farm.

  2. 02

    Flag reference

    The decision table: every flag the project knows about, rated supported / placebo / rejected / community / tweaks, with what it does.

  3. 03

    The mod format

    What a mod folder looks like, how stamps work, what the manifest records, and how to restore a clean client.

  4. 04

    Theming guide

    A theme is one JSON file mapping Lurelock's UI slots to shared UI overrides. Reference for every key.

  5. 05

    Architecture

    The manager's runtime: profile store, manifest, cache ledger, hook bus, and the boot sequence in detail.

  6. 06

    Contributor guidelines

    Issues, flag submissions, review standards. The project is small and intends to stay small.

House style Docs are written for readers, not for robots: no forced filler, no marketing verbs, and every safety claim is stated as a limitation rather than a promise.