| Platform | Build Status |
|---|---|
| Linux |  |
| Linux (Docker) |  |
| NuGet Packages | |
|---|---|
| MUnique.OpenMU.Network |  |
| MUnique.OpenMU.Network.Packets |  |
This project aims to create an easy to use, extendable and customizable server for a MMORPG called "MU Online". The server supports multiple versions of the game, but the main focus is version of Season 6 Episode 3 using the ENG (english) protocol. Additionally, the long-term focus is on the open source client which supports a slightly extended network protocol. However, parts of the software can also be suitable for the development of other games, even for other kind of games.
The code is a complete rewrite from scratch - it's not based on pre-existing projects, and it's also explicitly not based on decompiled server sources or their countless derivates.
There also exists a blog which may contain some valuable information about this development.
This project is currently under development without any release. You can try the current state by using the available docker image, see Run with Docker.
The documentation lives in the docs-website folder and is built as a website with Docusaurus. The links below point to its sources, so they work on GitHub as well.
| Getting started | Requirements, ports, running with Docker or from source, connecting a game client, test accounts |
| Deployment | The deployment variants, HTTPS, start parameters and environment variables |
| Admin panel | One page per screen of the server's user interface, plus task-oriented how-tos |
| Server features | Features with their own configuration, e.g. the server-side AI bots |
| Development | Architecture, solution structure, the plugin system, contributing |
| Reference | Ports and the generated packet documentation |
The code-bound technical documentation stays next to the code: see docs
for the packet descriptions and the game mechanics, and the Readme.md of the
individual projects under src.
To run the website locally:
cd docs-website
npm install
npm startOpenMU is an open-source project and is not affiliated with, operated by, or responsible for any publicly hosted MU Online private servers.
While anyone is welcome to use OpenMU in accordance with its license, we strongly discourage using the name OpenMU for private servers or their branding, as this may falsely imply an official affiliation with the project.
If you operate a server based on OpenMU, please choose a distinct name and make it clear that your server is independently operated.
Attribution such as "Powered by OpenMU", preferably with a link to this repository, is appreciated but not required.
The OpenMU project and its maintainers do not endorse or assume responsibility for third-party servers or their operations.
This project is released under the MIT license (see LICENSE file).
Contributions are welcome — from developers and non-developers alike. Please read CONTRIBUTING.md before you start, and don't hesitate to ask in our discord channel or by submitting an issue.