Software WickerREST Unity Framework

Unity WickerREST is a powerful framework developed for Unity developers that allows you to dynamically create commands and track game variables through a web interface. This mod uses .NET capabilities to extend Unity games with RESTful API, allowing you to interact with the game's internal components in real time from a web browser.

Features

Dynamic Command Handlers: Easily create and manage commands that can be invoked through HTTP requests.

Game Variable Monitoring: Watch game variables in real time through a web interface with dynamic updates support.

Flexible configuration: Use MelonPreferences to configure settings such as listening port and debug level.

Ease of use for developers: Designed with simplicity in mind, allowing you to quickly integrate it into your projects.

Autofill from the drop-down list: if autofill options are available, they will be serialized with the command.

An example of a visual user interface when using a plugin with Farthest Frontier.

The "Sample Command" button, the "Show Map" button and the "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 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: Make sure MelonLoader is installed for your game. Just download WickerREST.dll and put it in /Mods/.

Plugin Installation: You will also need a WickerREST plugin for your game. Once you find a compatible plugin, just place it in the /Mods/ folder. Screenshot example demonstrating correct installation

Web Interface Access: Launch the game and go to `http://localhost:6103/` in a web browser to access the command interface and the game variable monitor. The default port is 6103.