Commit Graph

11 Commits

Author SHA1 Message Date
aa2245b315 docs: the front door is a platform, not a UO bridge
The org landing page still opened with "A website + game bridge for private
Ultima Online (ServUO) shards" and listed six repositories. The module system
made the first untrue and Phase 5 made the second wrong by two: Module-uo and
Integration-kit.

Reframed rather than patched. Runic Gateway is a website platform for game
communities that knows nothing about any particular game; everything
game-specific arrives as an installable module, and Ultima Online is the first
one. The repo table splits accordingly — the platform (website, Android-app,
docs, Integration-kit) and UO support (Module-uo, link, servuo-plugins,
installer) — and "How they fit together" now leads with the three layers any
game needs (plugin, sidecar, module) before the UO specifics, including the rule
that the website process never opens a connection to a game server.

Quick start gains step 2: install a module. Paste a release's install-manifest
URL into Admin -> Modules, or declare MODULES=<id>@<version>=<url> on a
compose-managed host. Both were checked against server/.env.example rather than
written from memory.

One honest blockquote says the module system lives on the website's `edge`
branch until the cutover, so nobody clones `main` looking for a Modules screen
that is not there yet.

Co-Authored-By: Claude <noreply@anthropic.com>
2026-08-12 14:29:25 -05:00
f7bd697bfa Merge pull request 'docs: bring the org profile up to current state' (#1) from docs/installer-first-setup into main
Reviewed-on: #1
2026-08-07 21:40:38 +00:00
f98005eec0 docs: bring the org profile up to current state
Last touched 2026-07-23, before the installer repo existed.

- Six repos, not five: add installer to the table.
- Quick start: steps 2 (cargo build the sidecar) and 3 (see the plugin
  repo for deploy steps) collapse into one installer run, which is how a
  shard is actually set up now. The by-hand path is kept as a note.
- Day-two commands and the note that the installer does not install
  itself, so nobody looks for `runicgateway` on PATH.
- Mention what shipped since: the player-vendor marketplace, the spawn
  atlas, the admin-configurable shard visibility framework, and the
  account-security layer (TOTP + trusted devices, link-only SSO, bot
  scoring).
- "Where to go next" leads with INSTALL.md; the link and servuo-plugins
  entry is now about working on them rather than deploying them.

Verified rather than assumed: JDK 17 and min SDK 29 still match
app/build.gradle.kts, and Node 20+ still matches the website README and
its Dockerfile.

Co-Authored-By: Claude <noreply@anthropic.com>
2026-08-07 16:38:35 -05:00
d1eec6b7a0 Update README.md 2026-07-23 06:56:32 +00:00
57533754c7 fix: restore readable README (was double-base64-encoded)
Re-commit the org profile as plain markdown. The prior commit passed
pre-encoded content, which the API base64-encoded a second time and
rendered as gibberish.

Co-Authored-By: Claude <noreply@anthropic.com>
2026-07-21 01:11:39 +00:00
83635b3de6 docs: add Android-app as the fifth repo to the org profile
Weave the native Android client through the profile README: fifth row in
the pieces table, a second client branch in the architecture diagram, a
"how it fits" note (API-only client, self-configuring URL, ntfy push, no
Play Services), a Quick start section, a where-to-go-next pointer, and a
CI badge.

Co-Authored-By: Claude <noreply@anthropic.com>
2026-07-21 01:09:05 +00:00
fe4661189b Update README.md
Signed-off-by: Colby Whitlock <whitlocktech@gmail.com>
2026-07-19 03:12:31 +00:00
9c7bd6a882 docs: drop the PR-checks badge 2026-07-18 21:01:14 +00:00
bbb010a266 docs: move profile README to repo root 2026-07-18 20:59:23 +00:00
b8987c653b docs: add org profile README at repo root 2026-07-18 20:59:17 +00:00
8881a006be docs: add org profile README (overview, pieces, quick start, CI badges) 2026-07-18 20:51:28 +00:00