Mod management

Mod support is a core feature of WukongMP, allowing you to extend the functionality of your server with custom content.

Client-side mods

WukongMP supports automatic mod sync for clients connecting to the server. When a client connects, the server checks if the client has the required mods installed. If not, the ReadyM Launcher will download and install the missing mods before they can join the game.

To add a mod to your server, simply place the mod folder in the mods/ directory.

The expected structure of a mod folder is as follows. If you use our official mod template, there's a MakeModFolder.ps1 script in there, which will package the mod appropriately.

Example mod folder layout

mods/
└──MyModFolder/         # Root directory of the mod, can be named arbitrarily
    ├── MyMod.dll       # Main assembly of the mod
    ├── manifest.json   # Mod manifest file
    └── other_files...  # Other files required by the mod (optional)

Upon connecting to the server, clients will automatically download and install any missing mods from the mods/ directory, ensuring a seamless multiplayer experience.

Security notice

The early access version of the WukongMP SDK and server does not include any sandboxing or security mechanisms for mods.

Only use mods from trusted sources, as they can execute arbitrary code on the client.

Never run a server with untrusted mods, especially if the server is publicly accessible.

.pak files

WukongMP mods can include .pak files for game assets, which will be automatically loaded by the game.

To include a .pak file in your mod, simply place it anywhere in the mod folder. As long as there is a valid manifest.json file in the mod, the server will recognize it as a mod and distribute it to clients, and the game will load the .pak file when the mod is loaded.

In particular, this allows you to create mods that only include custom assets without any code, which can be useful for simple content mods.

An example mod structure with a .pak file would look like this:

Example mod folder layout with .pak file

mods/
└──MyModFolder/           # Root directory of the mod, can be named arbitrarily
    ├── manifest.json     # Mod manifest file
    ├── custom_assets.pak # Custom asset pack
    └── other_files...    # Other files required by the mod (optional)

Server-side mods

Work in progress

This feature is under development and will be available in a future version of the SDK.