Installation & Setup

Dependencies

The mod.io Unity Plugin requires the functionality of two other Unity plugins to run.

• Newtonsoft.Json which can be installed via the Package Manager. (See Below)
• SharpZipLib to zip and unzip transmitted files. (GitHub Repo)

Installation

warning

If you have a previous version of the plugin installed, it is highly recommended to delete it before updating to a later version.

1. Install the Newtonsoft Json plugin using the Package Manager.
   • If your Unity Package Manager does not contain Newtonsoft Json, follow the instructions here to find the installation method for your Unity version.
2. Download and install the plugin using one of the following methods:
   • Using the Unity Asset Store and Package Manager.
   • Download the .unitypackage directly from the Releases page.
   • Download an archive of the code using GitHub's download feature, and unpack it in your project's Assets/Plugins directory.
3. Restart Unity, to ensure it recognises the new assembly definitions.

Setup

The first thing you'll need to do is create a game profile on mod.io (or our private test environment).

important

You'll need your Game Id, API key and API Path for the following steps.

1. Ensure you have installed the plugin using the installation instructions above.
2. In Unity, select the mod.io config file by navigating to Tools -> mod.io -> Edit Settings.
3. In the Inspector, enter your Game Id, API key and API Path into Server URL.

Your setup is now complete. The following sections will guide you through getting your mod.io integration up and running quickly.

If you have any questions or need some help join our Discord server.

Your setup is now complete. The Getting Started guide will guide you through getting your mod.io integration up and running quickly. If you have any questions or need some help join our Discord server.