0 of 0
About this mod
Unity WickerREST is a powerful framework designed for Unity developers, allowing for the dynamic creation of commands and game variable monitoring through a web interface. This mod leverages the capabilities of .NET to extend Unity games with a RESTful API, making it possible to interact with the game's internals in real-time from a web browser.
- Permissions and credits
- Changelogs
- Donations
Unity WickerREST
Unity WickerREST is a powerful framework designed for Unity developers, allowing for the dynamic creation of commands and game variable monitoring through a web interface. This mod leverages the capabilities of .NET to extend Unity games with a RESTful API, making it possible to interact with the game's internals in real-time from a web browser.
Features
- Dynamic Command Handlers: Easily create and manage commands that can be called through HTTP requests.
- Game Variable Monitoring: Watch game variables in real-time through a web interface, with support for dynamic updates.
- Flexible Configuration: Use MelonPreferences to customize settings such as the listening port and debug level.
- Developer-Friendly: Designed with simplicity in mind, allowing quick integration into your projects.
- Drop-down Autocomplete: If autocomplete options are provided, they will be serialized along with the command.
Example visual of the User Interface while using a plugin with Farthest Frontier.
The Example Command button, Reveal Map button, and Game Fully Initialized variable monitor were generated from this code:
[CommandHandler("ExampleCommand")]
public static void ExampleCommandHttp(string Input1, string Input2 = "Default value")
{
WickerNetwork.Instance.LogResponse($"Returning back: {Input1} {Input2}");
}
[CommandHandler("revealMap")]
public static void RevealMapHttp()
{
Processing.RevealMap(); // WickerNetwork.Instance.LogResponse() can be used to send a response back to the user.
}
[GameVariable("GameFullyInitialized")]
public static string GetGmeFullyInitialized()
{
return GameManager.gameFullyInitialized.ToString();
}
Getting Started (Users)
To integrate WickerREST into your Unity game, follow these steps:
- Installation: Ensure you have MelonLoader installed for your game. Simply download the WickerREST.dll and drop it in the /Mods/ folder.
- Plugin Installation: You'll also need a plugin for WickerREST for your game. Once you have a compatible plugin and simply place it in the /Mods/ folder. Example screenshot showing correct installation
- Accessing the Web Interface: Start your game, and navigate to `http://localhost:6103/` in your web browser to access the command interface and game variable monitor. Default is port 6103.
Getting Started (Developers)
Main project repository is available at this link
Sample project repository is available at this link
To integrate WickerREST into your Unity project, please see the repository links above. It's as simple as referencing the WickerREST.dll and you'll be able to create methods with the attributes above that will be automatically detected when your Melon Mod is loaded.