Quick Start

Get a WukongMP server running in under 5 minutes.

Before you start

The server needs the .NET 10 runtime installed on the machine. It starts CoreCLR at launch to run server-side mods, so without the runtime it exits immediately with Cannot locate a .NET installation containing host/fxr. The dotnet-runtime-10.0 package is enough, you do not need the SDK.

Skip this if you are using Docker, the image already includes it. See Requirements for per-platform details.

1. Download the server

Windows

⬇ Download for Windows (x64, v0.4.1)

Linux

⬇ Download for Linux (x64, v0.4.1)

Docker

docker pull ghcr.io/readycodeio/wukongmp-server:0.4.1

2. Extract and configure

Windows

Extract the .zip to a folder of your choice. There is no installer to run.

To change the port (default: 9050), open config.json and edit Server:Port.

The package already includes the SDK and both game modes, with co-op enabled by default. Each mode is one folder, so to play PvP instead, move WukongMp.PvP from optional_mods/ into mods/ and delete the WukongMp.Coop folder. Both modes are open source too, if you would rather build them yourself: co-op mod, PvP mod.

Linux

Extract the .zip to a folder of your choice. There is no installer to run.

To change the port (default: 9050), open config.json and edit Server:Port.

The package already includes the SDK and both game modes, with co-op enabled by default. Each mode is one folder, so to play PvP instead, move WukongMp.PvP from optional_mods/ into mods/ and delete the WukongMp.Coop folder. Both modes are open source too, if you would rather build them yourself: co-op mod, PvP mod.

Docker

Copy the config file from the image:

docker create --name wukongmp-tmp ghcr.io/readycodeio/wukongmp-server:0.4.1
docker cp wukongmp-tmp:/app/config.json ./config.json
docker rm wukongmp-tmp

Port configuration is handled by remapping the container ports, see step 3.

important

The image ships without mods. Before starting the container, put the WukongMp.Sdk folder and exactly one game mode (WukongMp.Coop or WukongMp.PvP) into your local ./mods/ folder. Each mod folder carries both its halves, so there is nothing else to place.

Either download the binary package and copy them out of it, or build them from source: co-op mod, PvP mod.

3. Start the server

Windows

Double-click server.exe, or run it from a terminal:

.\server.exe

Linux

chmod +x server && ./server

Docker

docker run \
    -p 9050:9050/udp -p 9050:9050/tcp \
    -v ./data:/app/data \
    -v ./mods:/app/mods \
    -v ./saves:/app/saves \
    -v ./config.json:/app/config.json \
    --name wukongmp-server \
    ghcr.io/readycodeio/wukongmp-server:0.4.1

Or with Docker Compose:

docker-compose.yml

services:
  server:
    image: ghcr.io/readycodeio/wukongmp-server:0.4.1
    container_name: wukongmp-server
    restart: unless-stopped
    ports:
      - "9050:9050/tcp"
      - "9050:9050/udp"
    volumes:
      - ./data:/app/data
      - ./mods:/app/mods
      - ./saves:/app/saves
      - ./config.json:/app/config.json

4. Open the admin panel

Once the server is running, open your browser and go to:

http://localhost:9050

From here you can manage players, configure mods, and monitor your server in real time.

---

🎉 You're live! Share your IP and port :9050 with players, they'll need the ReadyM Launcher installed to connect.

---

Next steps

Full Installation Guide	Advanced configuration and options
Admin Panel	Manage users, bans, and server settings
Mod Management	Install and configure mods
Server List	Register your server publicly