diff --git a/README.md b/README.md index 3efa2f7..f1a4999 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Players get the same public content and self-service on the web **or** a native The platform itself knows nothing about any particular game. Everything game-specific — routes, tables, pages, navigation, notifications — arrives as an installable **module**, installed from the admin panel with nothing to build. *Ultima Online* (ServUO) is the -first game, and one installer sets up its shard side. +first game, *Rust* (Oxide and Carbon) the second, and one installer sets up the game side of either. @@ -20,7 +20,7 @@ first game, and one installer sets up its shard side. ## The pieces -Runic Gateway is eight repositories that deploy together but build independently. +Runic Gateway is thirteen repositories that deploy together but build independently. **The platform** — the same for every game: @@ -30,6 +30,7 @@ Runic Gateway is eight repositories that deploy together but build independently | [**Android-app**](https://gitea.whitlocktech.com/RunicGateway/Android-app) | Kotlin (Jetpack Compose) | The **native Android client** — public content + player self-service, purely an API client of the website backend. Same features as the browser client *minus* every admin console. Never touches a game server. | | [**docs**](https://gitea.whitlocktech.com/RunicGateway/docs) | Markdown | All project documentation — design docs, the module contract, the wire-protocol spec, the integration guide, the Android plan, research. Start here when you want the *why*. | | [**Integration-kit**](https://gitea.whitlocktech.com/RunicGateway/Integration-kit) | Markdown + a buildable template | **How to put a *different* game on a Runic Gateway site.** A four-chapter book and a module template that builds and loads. Read this if your game is not Ultima Online. | +| [**runicgateway.com**](https://gitea.whitlocktech.com/RunicGateway/runicgateway.com) | Astro | The platform's own **public site** at [runicgateway.com](https://runicgateway.com) — what Runic Gateway is, how to install it, and the developer docs. Not a game site. | **Ultima Online support** — the first game, and the worked example everything else is measured against: @@ -40,6 +41,15 @@ Runic Gateway is eight repositories that deploy together but build independently | [**servuo-plugins**](https://gitea.whitlocktech.com/RunicGateway/servuo-plugins) | C# | The **ServUO plugin** — the shard side of the bridge. Compiled by ServUO at boot; dials the sidecar over loopback and emits game events / accepts commands. | | [**installer**](https://gitea.whitlocktech.com/RunicGateway/installer) | Rust | The **installer** — one binary per OS that deploys the plugin and the sidecar onto a shard host as a matched, protocol-checked pair, registers the service, and hands you the values the website needs. How you set a shard up. | +**Rust support** — the second game, the same three layers, built from the Integration-kit: + +| Repo | Language | What it is | +|------|----------|------------| +| [**Module-Rust**](https://gitea.whitlocktech.com/RunicGateway/Module-Rust) | JavaScript (Node + React) | The **Rust module** — everything that makes a site a site for Rust. Installed into a website as `modules/rust/`; released as a versioned bundle. | +| [**Rust-Link**](https://gitea.whitlocktech.com/RunicGateway/Rust-Link) | Rust | The **rust-link** sidecar — the Rust mirror of uo-link: terminates the game plugin's loopback link and serves the WebSocket + REST API the website consumes. Ships a Pterodactyl egg. | +| [**Rust-Plugins**](https://gitea.whitlocktech.com/RunicGateway/Rust-Plugins) | C# | The **bridge plugin** for Oxide and Carbon — the game side of the bridge. Dials the sidecar over loopback. | +| [**runicnpc-rust**](https://gitea.whitlocktech.com/RunicGateway/runicnpc-rust) | C# | **RunicNPC** — Runic Gateway's own NPC plugin for Rust: an API other plugins call and in-game admin commands, with NPCs equipped through Kits. Works on its own too. *In development.* | + ## How they fit together ```