Moongate.Plugins 0.1.0-develop.5

Moongate

Overview

Moongate Next is a .NET server framework for Ultima Online shard experiments. It combines UO networking, YAML-backed data assets, Lua scripting, explicit plugin extension points, persistence, metrics, and DocFX documentation in a single modern runtime.

Build

dotnet build Moongate.slnx

Test

dotnet test Moongate.slnx

Documentation

Moongate uses DocFX for documentation and API reference generation.

dotnet tool restore
dotnet build Moongate.slnx --configuration Release
dotnet tool run docfx docs/docfx/docfx.json

The generated site is written to docs/docfx/_site. GitHub Pages deployment is handled by the Docs workflow.

Web UI

The web UI lives under ui/ and is built with Vite.

cd ui
npm install
npm run build

During local development, run the server separately and start Vite:

cd ui
npm run dev

The Vite dev proxy targets http://127.0.0.1:5265 by default. Override it with VITE_API_TARGET when the backend runs on a different URL.

The server Dockerfile builds the UI and copies ui/dist into the published server wwwroot directory.

The admin portal dashboard reads the existing server endpoints:

• GET /api/version for server version and codename.
• GET /api/auth/me for the current authenticated admin identity.
• GET /metrics for runtime, network, event bus, timer, and persistence metrics.
• GET /api/docs for Scalar API documentation.

The admin Metrics view renders client-side time-series panels from /metrics and refreshes while the view is open.

The first admin dashboard phase intentionally does not manage map or item image generation.

Configuration

Moongate uses YAML for runtime configuration. The main server config is moongate.yaml in the runtime config directory. Trusted plugins use plugin.yaml in their plugin directory.

The UO starting location uses a named map facet and compact world coordinates:

uo:
  client_files_directory: ~/uo
  starting_map: Trammel
  starting: 1496,1628,10
  starting_city: Britain

Commands

Moongate exposes one command registry for built-in server commands and trusted plugins. Commands can be executed from the interactive server console or from in-game speech with the . prefix, for example .help.

Plugins register commands during Configure through PluginContext.RegisterCommand. No source generator is required; command registration is explicit and can choose console-only, in-game-only, or shared sources.

Lua scripts can register commands through the commands module:

commands.register("hello", "all", "Greets the caller.", function(ctx)
    return "hello " .. ctx.args[1]
end)

Bundled Data Assets

Moongate ships editable YAML reference data under src/Moongate.Server/Assets.

• Assets/data/uo_files/ contains static UO reference data used by the UO data stores.
• Assets/data/ contains server world data such as locations, regions, teleporters, weather, containers, decorations, signs, doors, and spawns.

At startup, missing bundled YAML files are copied from embedded resources into the runtime data directory. Existing runtime files are never overwritten, so operators can customize shard data after first boot.

After the data seed runs, Moongate registers lazy world data services for doors, spawns, teleporters, regions, weather, containers, locations, names, professions, signs, decorations, and mount conversion data. Each service loads its YAML data on first query and can be reloaded through the common data service contract.

License

Apache-2.0 - see LICENSE. Some source files carry separate license notices that apply to those files.