OpenMU Project

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.

Current project state

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.

Documentation

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 start

Licensing

This project is released under the MIT license (see LICENSE file).

Contributions

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.