-
Notifications
You must be signed in to change notification settings - Fork 1
Home
Genie 5 is a cross-platform client for DragonRealms, Simutronics' text MMO. It's a from-scratch rewrite of Genie 4 on .NET 8 and Avalonia, keeping Genie 4's scripting, mapping, highlighting, and triggering while running natively on Windows, macOS, and Linux.
⚠️ Alpha. Genie 5 is in active development, targeting the most-used ~80% of Genie 4. Expect rough edges. Pages here describe current behavior and flag 🚧 items that are still on the roadmap.
⬇️ Pre-built downloads are here. As of v5.0.0-alpha.3.1, native builds ship for Windows, macOS (Apple Silicon + Intel), and Linux, with an in-app updater on each. Grab the latest release — see Installation to pick the right one, and Releases & Changelog for what's new.
This wiki is organized crawl → walk → run — the further down you read, the more detail you get. New here? Start at the top and stop when you have what you need.
Everything you need for a first successful login.
| Page | What it covers |
|---|---|
| Installation | Download a pre-built build for Windows, macOS, or Linux (or build from source). |
| Quick Start | Your first 5 minutes: connect, play, save a profile, run a script. |
| Releases & Changelog | The latest build, what changed, and which download to grab. |
| Importing from Genie 4 | Bring your aliases, triggers, highlights, macros, and variables across. |
| Application Folders | Where Genie 5 keeps scripts, maps, logs, and config on each OS. |
Day-to-day playing, customizing, and automating.
| Page | What it covers |
|---|---|
| Connecting & Profiles | The three connection modes (SGE, Lich, replay), the Connect dialog, and encrypted per-character profiles. |
| The Interface | The dockable panels — game text, vitals, hands, room, stream tabs, mapper — plus the command bar, clickable links, and saved layouts. |
| Configuration & Rules | Aliases, triggers, highlights, substitutes, gags, macros, variables, and classes — set from the command bar or the Configuration dialog. |
| Scripting | Write and run .cmd scripts — a friendly tour from "hello world" up. |
| The Mapper | Room tracking, click-to-walk, Less Obvious Paths, and the attended-mode walking rules. |
| Updating Maps & Scripts | Pull the latest community zone maps and keep them merged with your own progress. |
| Lich 5 Integration | Run Genie behind a Lich 5 proxy with your Ruby scripts intact. |
The deep end: the full scripting language, the mapper's internals, plugins, and how the engine is put together.
| Page | What it covers |
|---|---|
| Scripting Reference | The complete .cmd vocabulary, %/$ variable scopes, the roundtime gate, type-ahead, and where Genie 5 diverges from Genie 4. |
| Cross-Zone Travel | The ZoneConnections.xml transit graph, the multi-zone pathfinder, and the connection editor. |
| Plugins | The plugin contract, the #plugin command, the Experience-tracker example, and the trust model. |
| Keeping Up to Date | The integrated updater — Core app, maps, and plugins. |
| AI Advisor (planned) 🚧 | The advisor-only AI design and its privacy guarantees — opt-in, never agentive. |
| Policy Compliance | How Genie 5 stays inside Simutronics' Allowed Software policy, and the five hard "nevers." |
| Architecture | The one-way pipeline, the Genie.Core / Genie.App split, and the embedding story. |
| Building from Source | Project layout, the dev test harness, and the developer docs index. |
| Troubleshooting & FAQ | Common problems and how to fix them. |
Genie 5 reaches DragonRealms three ways — all chosen from File → Connect…:
- Simutronics SGE login — the standard "log in with your DragonRealms account" flow. Genie 5 authenticates and finds the right game server itself.
-
Lich proxy — point Genie at a running Lich 5 on
127.0.0.1:8000; your Ruby scripts keep working. - Dev replay — replay a recorded session through the engine (development and testing).
See Connecting & Profiles for the walkthrough.
- Discord — discord.gg/MtmzE2w — the long-running Genie community server (shared with Genie 4). Alpha-tester chat, scripting help, mapper questions.
- Issues — report a bug or request a feature.
- Releases — download builds as they ship.
- Contributing — CONTRIBUTING.md. PRs welcome.
-
Developer docs — the
docs/folder covers the parser, scripting engine, and mapper internals.
Genie 5 is third-party software for DragonRealms and is designed to live within Simutronics' Allowed Software policy. See Policy Compliance for what that means in practice.
Genie 5 — a cross-platform DragonRealms client · Repository · Discord · GPL-3.0
Alpha software. Pages describe current behavior; 🚧 marks roadmap items that aren't shipped yet.
🐤 Start here
🚶 Everyday use
- Connecting & Profiles
- The Interface
- Configuration & Rules
- Scripting
- The Mapper
- Updating Maps & Scripts
- Lich 5 Integration
🏃 Going deeper
- Scripting Reference
- Cross-Zone Travel
- Plugins
- Keeping Up to Date
- AI Advisor (planned)
- Policy Compliance
- Architecture
- Building from Source
- Troubleshooting & FAQ