The accompanying launcher update (version 0.25.1) now shows the option to connect to self-hosted servers for everyone.

This update is compatible with SDK version 0.2.0, so you can update your server without needing to update your mods immediately. However, we still recommend updating your mods to take advantage of the latest improvements and fixes.

Quality of life updates​

• The PvP mod is now the default in the server package. The co-op mod is still included in the optional_mods folder. You can swap them by moving the desired mod to the main mods folder and removing the other one. Having both enabled will crash the game, so make sure to only have one of them enabled at a time.
• Banning someone in the admin panel now immediately kicks them out of the server.
• Added an option to kick a player from the server without banning them, in the admin panel.
• Both the Launcher and the mod now display appropriate messages when trying to connect to a server where the player is banned or not whitelisted.

Bug fixes​

• [co-op] Fixed an issue where getting far enough away from enemies would cause them to idle for other players.
• [co-op] Fixed an issue where bosses would become idle after teleporting away a significant distance and returning to the boss area.
• [co-op] Fixed synchronization issues around spider enemies in Chapter 4.
• [PvP] Choosing to "Start a new cycle" on an endgame character is no longer possible, as it causes spawning in a different area and falling under the map.

Though the SDK is still in early access, we are excited to share it with the community and see what mods you will create with it!

This version also includes a complete redesign of the admin panel, with addition of many requested features.

Read on for the full list of changes and the Migration Guide for updating your mods to SDK version 0.2.0.

Breaking changes​

• Launcher version 0.24.0 is required to connect to servers running SDK version 0.2.0.
• Mods built on SDK version 0.2.0 require updating the server binaries to version 0.2.0 as well, and older versions of the server will not be able to load mods built on SDK version 0.2.0.

SDK updates​

• The PvP mod is now included in the server package, alongside the co-op mod, both built on top of SDK version 0.2.0.
• RPC event handlers built on top of RpcClassBase now have access to the RunOnMainThread method, which allows you to schedule callbacks to run on the main thread in a safe way. This is particularly useful for RPC handlers that need to interact with the game world, as doing so from the network thread can cause crashes.
• In-game chat has been re-enabled.
• API methods related to the built-in chat have been moved from the Local API to the new Chat API for better organization and separation of concerns.
• Two new (temporary) APIs - PvP API and Cheats API were used to implement the self-hosted version of the PvP mod before server-side scripting is ready. Once server-side scripting is implemented, these APIs will be removed and their functionality will be implemented using regular server-side mods instead.
• Other APIs have received new methods and improvements. Check out the API reference for more details on the changes.

Admin panel updates​

• Full panel redesign with a cleaner layout and modern typography.
• Export button in the terminal saves server logs to a .txt file.
• Terminal now supports log filtering.
• New Players tab listing all players who have connected to the server - shows last visit date and total connection count.
• Player whitelist manageable from the panel - toggle it on/off with a single switch, defines which players can join.
• Ban system - banned players cannot connect to the server.
• New Mods tab listing all currently installed mods on the server.
• "Make admin" button on a player grants them access to the admin panel.
• "Add admin" button lets you manually add an administrator by their ReadyM ID.
• Remove administrator button on the admins list.
• New granular permissions: Manage Admins, Manage Settings (currently covers whitelist management).
• The first user to authorise with a PIN in the panel is assigned superuser status - they always have full permissions and can only be removed by another superuser. Superuser status can also be granted or revoked manually via a dedicated button.
• Cookie fix - Secure flag is now set automatically based on whether the request came over HTTPS or HTTP.

What's next?​

We're continuing to work on server-side mod support, as well as revisiting some known bugs in co-op mode. Once server-side mod support is ready, we'll be removing the temporary PvP and Cheats APIs and implementing their functionality inside the PvP mod itself.

Next steps for WukongMP SDK will include open-sourcing the co-op and PvP mods, to allow the community to learn from them and contribute to their development.

Migration guide​

Here's a quick migration guide for updating your mods to SDK version 0.2.0:

• Update your server binaries to version 0.2.0 - older versions of the server will not be able to load mods built on SDK version 0.2.0.
• Rebuild your mod against the new SDK version 0.2.0. You can download the latest mod template and copy your mod files there. Make sure to update the manifest.json file in your mod folder to specify the new minimum SDK version in the dependencies section.
• If your mod interacts with the in-game chat, make sure to update your code to use the new Chat API instead of the Local API.
• If your mod uses RPC handlers, consider using the new RunOnMainThread method to schedule callbacks that interact with the game world, to avoid potential crashes.

This version brings updates to how mods are stored on the server, and how developers can define dependencies between mods.

Connecting to the server built on SDK version 0.1.0 requires version 0.23.1 of the ReadyM Launcher.

New features​

Mod versioning​

Starting with version 0.1.0, all releases of the WukongMP SDK will be versioned according to the MAJOR.MINOR.PATCH format. The current version is 0.1.0.

Updates to the SDK will be released as new versions, with their own documentation pages. This allows mod developers to target specific versions of the SDK in their mods' dependency lists, and to maintain compatibility with older versions of the SDK if they choose to.

Each version's download page will contain a server binary package compatible with that version. When upgrading the SDK, make sure to also update the server binaries on your server to the version corresponding to the SDK version you are using.

Mod manifests​

Support for manifest.json mod manifest files has been added. You can now define mod metadata, which will be displayed in the server admin portal and in the Launcher, when someone connects to a server that uses your mod.

You can also specify required versions of other mods that are required by your mod to function.

Refer to the documentation for mod manifests for more details.

Breaking changes​

• The manifest.json file is now required for all mods. Mods without a manifest will not be loaded by the server.
• Launcher versions prior to 0.23.1 will not be able to connect to servers running SDK version 0.1.0 or later.

What's next?​

We're currently working on bringing the PvP mode to self-hosted servers, as well as adding server-side mod support. Stay tuned for more updates in the coming weeks!