{"id":21989000,"url":"https://github.com/duysqubix/muoxi","last_synced_at":"2026-05-16T03:26:35.594Z","repository":{"id":36328613,"uuid":"223029857","full_name":"duysqubix/MuOxi","owner":"duysqubix","description":"MuOxi, a modern mud game engine written in Rust.","archived":false,"fork":false,"pushed_at":"2023-06-22T05:07:09.000Z","size":8432,"stargazers_count":91,"open_issues_count":10,"forks_count":12,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-06-21T21:03:08.010Z","etag":null,"topics":["mud","rust"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/duysqubix.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-11-20T21:21:31.000Z","updated_at":"2025-05-09T21:54:05.000Z","dependencies_parsed_at":"2025-04-30T12:07:26.433Z","dependency_job_id":null,"html_url":"https://github.com/duysqubix/MuOxi","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/duysqubix/MuOxi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/duysqubix%2FMuOxi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/duysqubix%2FMuOxi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/duysqubix%2FMuOxi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/duysqubix%2FMuOxi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/duysqubix","download_url":"https://codeload.github.com/duysqubix/MuOxi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/duysqubix%2FMuOxi/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263991428,"owners_count":23540663,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mud","rust"],"created_at":"2024-11-29T19:27:13.081Z","updated_at":"2026-05-16T03:26:35.588Z","avatar_url":"https://github.com/duysqubix.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ![muoxi_logo][logo]\n\n# MuOxi — a MUD framework in Rust\n\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n[![Rust](https://img.shields.io/badge/rust-1.85%2B-orange.svg?logo=rust)](https://www.rust-lang.org)\n[![Built with Tokio](https://img.shields.io/badge/built%20with-tokio-blue.svg)](https://tokio.rs)\n[![GitHub Stars](https://img.shields.io/github/stars/duysqubix/MuOxi?logo=github)](https://github.com/duysqubix/MuOxi/stargazers)\n[![Last Commit](https://img.shields.io/github/last-commit/duysqubix/MuOxi?logo=github)](https://github.com/duysqubix/MuOxi/commits)\n[![Open Issues](https://img.shields.io/github/issues/duysqubix/MuOxi?logo=github)](https://github.com/duysqubix/MuOxi/issues)\n[![Discord](https://img.shields.io/badge/discord-join%20chat-5865F2.svg?logo=discord\u0026logoColor=white)][discord]\n\nMuOxi is a framework for building [online multiplayer text games][wikimudpage]\n— MUDs, MUSHes, MUCKs, and their relatives. It handles the parts every\nMUD needs (sockets, login, persistence, command dispatch, world state)\nand leaves the parts that are *your* MUD to you: combat, magic, plot,\ncontent, feel.\n\nThe design owes a lot to [Evennia][evennia], reimagined in Rust.\n\n```\n                                          ┌────────────┐\n   tt++ / telnet      ─tcp→  ┌───────────┐│   redis    │\n   browser / WS       ─http→ │muoxi_server│└────┬───────┘\n   muoxi_web bridge   ─ws──→ └─────┬─────┘     │\n                                   │           ▼\n                                   ▼     ┌────────────┐\n                            ┌──────────┐ │  Diesel    │\n                            │ Registry │ │  SQLite    │\n                            └──────────┘ │  (default) │\n                              types,     │   or       │\n                              cmds,      │  Postgres  │\n                              hooks      └────────────┘\n```\n\n## Quick start\n\n```bash\ngit clone https://github.com/duysqubix/MuOxi.git\ncd MuOxi\ndocker compose up\n```\n\nThen connect:\n\n| Surface | URL |\n| --- | --- |\n| Browser | \u003chttp://localhost:8080\u003e |\n| Telnet  | `telnet 127.0.0.1 8000` |\n| WS CLI  | `wscat -c ws://localhost:8080` |\n\nCreate an account, create a character, walk into Limbo. Reconnect later\nand your character is still there. The full walkthrough lives in\n[docs/getting-started.md](docs/getting-started.md).\n\nIf host ports 8000 or 8080 are taken:\n\n```bash\nMUOXI_SERVER_PORT=18000 MUOXI_WEB_PORT=18080 docker compose up\n```\n\nFor fast iteration without typing credentials each restart:\n\n```bash\nDEV_AUTOLOGIN=1 docker compose up\n```\n\n## Documentation\n\n| If you want to… | Read |\n| --- | --- |\n| Build a MUD on top of MuOxi | [docs/getting-started.md](docs/getting-started.md) |\n| Understand the design | [docs/architecture.md](docs/architecture.md) |\n| Know which extension points exist | [docs/extension-guide.md](docs/extension-guide.md) |\n| Build out your world | [docs/world-building.md](docs/world-building.md) |\n| Deploy MuOxi | [docs/deployment.md](docs/deployment.md) |\n| Hack on the framework itself | [docs/development.md](docs/development.md) |\n| See where the project is headed | [docs/roadmap.md](docs/roadmap.md) |\n| Look up a term | [docs/glossary.md](docs/glossary.md) |\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md). Reach out on [discord][discord]\nfor design conversations.\n\n## License\n\nGPL-3.0 — see [LICENSE](LICENSE).\n\n## Star History\n\n[![Star History Chart](https://api.star-history.com/svg?repos=duysqubix/MuOxi\u0026type=Date)](https://star-history.com/#duysqubix/MuOxi\u0026Date)\n\n[logo]:        .media/cog.png\n[wikimudpage]: https://en.wikipedia.org/wiki/Multi-user_dungeon\n[evennia]:     https://www.evennia.com/\n[discord]:     https://discord.gg/H6Sh3CJ\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fduysqubix%2Fmuoxi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fduysqubix%2Fmuoxi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fduysqubix%2Fmuoxi/lists"}