--- import Base from '../layouts/Base.astro'; import PageHeader from '../components/PageHeader.astro'; import NotBuilt from '../components/NotBuilt.astro'; import SupportedGames from '../components/SupportedGames.astro'; import platform from '../data/platform.json'; import { games } from '../data/games/index.mjs'; /** * `/modules/` — PLAN.md §13 phase 4, restructured in §16 phase 17. * * §10 gave this page four jobs: what a module is, a worked example, writing your own, and * the Integration Kit with its draft badge (D8). They are in that order because they are * increasing commitment — a reader deciding whether to install one, a reader wondering what * they get, a reader considering building one. * * --------------------------------------------------------------------------------------- * TWO GAMES, EACH ON ITS OWN PAGE * --------------------------------------------------------------------------------------- * The worked example was the Ultima Online module, listed in that game's words. Since phase * 17 there are two modules, and D63 keeps a game's vocabulary on its own pages, so this page * is core: a card per game, in core's words, from `games/index.mjs`, each linking to * `/modules/uo/` or `/modules/rust/`, where the game's real feature list is (D75). What the * modules share — a sidecar, their own tables, their own releases — stays here, said once. * * --------------------------------------------------------------------------------------- * THE DRAFT CHIP IS A DECISION, NOT A DISCLAIMER * --------------------------------------------------------------------------------------- * D8 marks the Integration Kit draft until a second module is successfully built against * it by somebody outside this project, and requires that status to carry its removal * condition. Both are here: the chip, and the sentence that says what takes it down. The * same absence appears in `notBuilt.mjs`, so a reader who scrolls past the chip meets it * again in the list of things that do not exist. */ const title = 'Modules'; const description = 'What a module is, the two game modules that exist — Ultima Online and Rust — and what it ' + 'takes to write one for another game.'; const gitea = `${platform.gitea.base}/${platform.gitea.org}`; const docs = `${gitea}/docs/src/branch/main`; /** The three ways a module reaches a running deployment. None of them is a build. */ const installPaths = [ { name: 'From the admin panel', body: 'Paste the URL of a release manifest into Admin → Modules and press restart when it ' + 'asks. The site downloads the artifact, verifies the checksum the manifest declares, ' + 'inspects the whole archive before writing a single file, and unpacks it.', fits: 'The click path, for a host you have no shell on.', }, { name: 'From your environment', body: 'Name the module and its version in one environment variable and the container ' + 'resolves it at every start. Already at that version means no network call at all, so ' + 'a restart with the internet down comes up unchanged.', fits: 'A compose-managed host, where the running set should be a line you version-control.', }, { name: 'By hand', body: 'Unpack the tarball into the modules directory and restart. The bundle is already ' + 'assembled — the client half is prebuilt and its one runtime dependency ships inside.', fits: 'Development, and any host where the other two do not fit.', }, ]; ---

A module is the entire game-specific half of a deployment, packaged: its routes, its screens, its database tables, its navigation rows and its slice of the API documentation. The core site holds accounts, Teams, the wiki, posts, moderation and the admin panel, and knows nothing about any game at all.

That division is not an aspiration bolted on afterwards. The Ultima Online support was extracted out of the site into a module, and every URL it had before the move it still has — which is the only version of this claim worth making. Rust followed, built against the same seam.

What you get

What installing one actually does

Installing

Three ways in, and none of them is a build

Which one you use is a question about your host, not about the module. All three end the same way: a restart, and the module's screens appear in the navigation.

    { installPaths.map((path) => (
  1. {path.name}

    {path.body}

    {path.fits}

  2. )) }

The game modules

Two games, one module each

Both were built inside this project, and a deployment runs one of them — the site refuses to start a second. Each has a page of its own, in its own game's words, and a documentation group that starts from installing it.

Each connects to a real server

A module talks to the sidecar beside your game server, not to the game. You deploy that side with the installer and give the admin panel its address and token; nothing here requires the game to exist, and with no server configured the site renders normally and shows it offline.

Each owns its own tables

Its schema is applied by the site on every boot and its data is its own. A module declares which versions of the core interface it speaks — the site runs {' '}{platform.moduleApi} — and refuses to load against one it does not.

Each is a separate release

Versioned, tagged and published on its own cadence, independently of the site. Upgrading one does not mean upgrading the other, as long as the declared interface range still holds.

Writing your own

The Integration Kit

Draft

A four-chapter book on putting a different game on this platform — the module, the sidecar beside your game server, the plugin inside it — plus a template module that continuous integration builds against a pinned version of the core site, so the instructions cannot quietly stop working.

Why it says draft

Because nobody outside this project has yet followed it to a working module, and that is the only test of a set of instructions that counts. The badge comes off when somebody does — that is the stated condition, not a mood, and it is written down so a future reader knows when to take it down.

Everything it teaches is real and in use. What is untested is whether it is sufficient: whether someone with no access to this project's context can get from an empty repository to a running module using it alone.