Getting started
The easiest way to get started with developing your own mods on top of the WukongMP SDK is to use the official WukongMP mod template.
Clone the repository and follow instructions provided in the README file. The template references the SDK through NuGet, so there is nothing to download or copy by hand, and its MakeModFolder.ps1 script packages the finished mod into the layout the server expects.
A mod is one folder holding up to two halves, a client/ and a server/. The pages under Development cover the client half; server-side development covers the other one. Small mods only ever need the client half.
Feature status
Right now you can develop mods that have access to game events, entity data (players, enemies), and can define custom commands and game logic systems.
Mods can also run logic on the server itself: see server-side development.
Visit the examples page for some inspiration, or browse the source code of the co-op and PvP mods.
| Feature | Status |
|---|---|
| Patching game code | ✅ done |
| Game event API | ✅ done |
| Console command API | ✅ done |
| Custom RPC | ✅ done |
| Save file API | 🚧 partial |
| Custom data sync | ✅ done |
| Mod config files | ✅ done |
| Server-side mods | ✅ done |