Skip to content
Jackson Wood edited this page Jul 6, 2018 · 2 revisions

Welcome to the mod.io UNITY wiki. This wiki explains how to integrate and use mod.io UNITY into a game or modding tool.

mod.io UNITY simplifies mod.io integration by providing a native c# library built on the Unity Engine that manages downloads, wraps API calls, and provides a simple caching utility. Should the game or modding tool in development require functionality beyond what modio UNITY provides, the mod.io API Documentation provides a complete reference on how to use interact with the API directly.

Getting Started

Download Latest mod.io UNITY Release

Download the latest mod.io UNITY release from the GitHub release page and place it in "Assets/Plugins/mod.io/". Additionally, mod.io UNITY requires the following libraries to facilitate the conversion of API JSON objects into their C# representation, and the zipping and unzipping of data:

Create a Game Profile

In order to establish a connection between the game or app in development, and the mod.io API, a game profile must be created via the mod.io web interface. This game profile can be either created on the test environment at https://test.mod.io/(recommended) or on the production environment at https://mod.io/. For differences between the two, see Test Environment vs. Production Environment below.

Test Environment vs. Production Environment

mod.io offers two different environments: testing and live. Testing is located at test.mod.io and has a corresponding API accessible via api.test.mod.io. On the test environment, each game profile is hidden from public view and only accessible by accounts marked as developers of that game; it provides a sandbox to prepare and test integration before publishing to the production environment. Publishing to the production environment is recommended once the integration of mod.io has been tested in game or in app and is ready for public consumption. Please note that the Game ID and the Game API Key assigned to a game profile on the production environment will differ from the one on the test environment, as the game profiles on the test environment and the production environment are unique and not linked in any way.

Clone this wiki locally
You can’t perform that action at this time.