ellymud
Health Warn
- License — License: AGPL-3.0
- Description — Repository has a description
- Active repo — Last push 0 days ago
- Low visibility — Only 5 GitHub stars
Code Pass
- Code scan — Scanned 12 files during light audit, no dangerous patterns found
Permissions Pass
- Permissions — No dangerous permissions requested
This project is a modern Multi-User Dungeon (MUD) game engine and application. It includes a Model Context Protocol (MCP) server on port 3100 that allows AI agents to connect, drive virtual game sessions, and query game state.
Security Assessment
Overall Risk: Low. The tool accepts inbound network connections via Telnet, WebSocket, and its MCP server, but the code scan found no dangerous outbound network requests, hardcoded secrets, or dangerous permissions. Authentication is handled securely using bcrypt for passwords, JWT for the admin panel, and API keys for MCP access. It is designed to execute code in a gaming context, but no risky shell execution patterns were detected during the scan.
Quality Assessment
The project appears to be actively developed and well-maintained, with recent repository activity. It is legally covered under the AGPL-3.0 license. The codebase demonstrates strong engineering practices, utilizing TypeScript, offering pluggable storage backends (JSON, SQLite, PostgreSQL), and boasting a robust test suite of over 3,500 tests. However, community visibility and trust are currently minimal, as indicated by a low star count. As a newer project with a small user base, it has not yet been widely vetted by the open-source community.
Verdict
Safe to use, though developers should be aware of its early-stage, low-community-vetted status.
Modern Multi-User Dungeon in TypeScript. Telnet, WebSocket, React admin with drag-and-drop world builder, MCP server, JSON/SQLite/PostgreSQL storage.
EllyMUD
A modern Multi-User Dungeon written in Node.js and TypeScript. Connect over Telnet, WebSocket, or the bundled web client. Inspired by classic MUDs like MajorMUD, rebuilt on a contemporary stack.
Quick start
git clone https://github.com/ellyseum/ellymud.git
cd ellymud
npm run bootstrap
npm start
Then connect:
- Web: http://localhost:8080
- Telnet:
telnet localhost 8023
First boot prompts for an admin password.
Game
- Real-time, turn-based combat with NPCs and PvP
- Abilities and spellcasting with mana, cooldowns, and resource management
- Room-based world with safe zones, shops, banks, and combat areas
- 12-slot equipment system, inventory, vendor economy, banking
- Character progression: levels, stat training, experience
- Status effects: poisons, stuns, roots, buffs, debuffs, heals
- Rest and meditate to recover
- Multi-user chat (
say,yell, social emotes) - Snake mini-game (type
snakeand you'll see)
See docs/commands.md for the full command reference.
Stack
- Connections: Telnet (8023), WebSocket (8080), bundled xterm.js web client
- Admin API: REST + React dashboard with a drag-and-drop World Builder (port 3000)
- MCP server: Model Context Protocol on port 3100 for AI integration and headless testing
- Storage: pluggable JSON / SQLite / PostgreSQL via a repository factory — switch with one env var
- Auth: bcrypt password hashing, RBAC, JWT for the admin panel, API keys for MCP
- Logging: per-user, per-session, daily-rotated, with separate system/error/MCP streams
- Tests: Jest unit + integration + E2E (3,500+ tests)
Storage backends
Set STORAGE_BACKEND to switch. Migrate data with npm run data:export / data:import.
| Backend | Use case | Setup |
|---|---|---|
json |
Dev, fast iteration | None — default |
sqlite |
Single-server prod | STORAGE_BACKEND=sqlite |
postgres |
Cluster / HA | STORAGE_BACKEND=postgres + DATABASE_URL |
Details in docs/storage-backends.md.
MCP server
EllyMUD exposes a Model Context Protocol server on port 3100 with API-key auth, suitable for AI agents to connect, control test mode, drive virtual game sessions, or query game state. See docs/api-reference.md.
Documentation
| Topic | Path |
|---|---|
| Getting started | docs/getting-started.md |
| Configuration | docs/configuration.md |
| Docker | docs/docker.md |
| Deployment | docs/deployment.md |
| Commands | docs/commands.md |
| Admin guide | docs/admin-guide.md |
| API reference | docs/api-reference.md |
| Architecture | docs/architecture.md |
| Storage backends | docs/storage-backends.md |
| Performance | docs/performance.md |
| Development | docs/development.md |
| Troubleshooting | docs/troubleshooting.md |
For contributor conventions, build commands, and architecture in detail, read AGENTS.md.
Development
npm run dev # hot-reload server
npm test # full test suite
npm run build # tsc + vite build
npm run # list all scripts
License
AGPL-3.0-or-later — see LICENSE.
Commercial licensing available on request via https://github.com/ellyseum.
Issues & discussion
Reviews (0)
Sign in to leave a review.
Leave a reviewNo results found