The WukongMP SDK is now open source
The WukongMP SDK is now on GitHub, across three repositories:
- WukongMP SDK: the SDK mods are built on.
- ReadyM Core SDK: the runtime underneath it, not specific to Wukong.
- Wukong mod loader: what gets mods into the game.
The README in each covers what it does and how to build it.
You do not need the SDK source to write a mod
The SDK ships as NuGet packages, one for each project in a mod:
| package | your project |
|---|---|
| ReadyM.SDK.Wukong.Common | shared code |
| ReadyM.SDK.Wukong.Client | the mod the game loads |
| ReadyM.SDK.Wukong.Server | the mod the relay server loads |
Reference them and restore. There is nothing to copy by hand and no SDK build step in the way.
The mod template, the co-op mod and the PvP mod already use them.
What to clone
Writing a new mod? Clone the mod template and build. It references the SDK through NuGet, so that is the whole setup.
Fixing something in co-op or PvP? Open a PR against the co-op or PvP repository. Both build against the published packages, so you do not need the SDK checked out.
Changing the SDK itself? Clone wukongmp-sdk with --recursive. The core SDK comes in as a submodule, so one clone gets you the whole stack.
Issues and PRs welcome on all of them. If you are planning something bigger and want to talk it through first, start a thread on the ReadyM Forum or hop in the ReadyM Discord.