1. Home
  2. Docs
  3. UniREST Solution 3.5
  4. UniREST Client
  5. Installation

Installation

The more practical way to install the UniREST Client is through the Unity Asset Store. Follow the official Unity guide to know how to install assets in your game projects.

Once the UniREST Client asset has been installed and correctly configured, you can start using it in your Unity game project. The UniREST Client is set of classes containing all you need to work with your UniREST Server application. Everything is performed by C# coding and there’s no need of creating objects in your Unity Scene or use UI components.

Asset Structure

The whole asset project is under the TigerForge > UniRESTClient folder. You can place the TigerForge folder where you prefer inside your Unity Project.

UniRESTClient.cs

This C# script contains all the methods and tools of the UniREST Client core system.

UniRESTClientConfig.cs

This C# script must contain the configuration of the UniREST system. The C# code must be generated by the UniREST Server application (see the ‘UniREST Client Config’ chapter) and then pasted here. It basically contains the secret keys needed for encrypted communications and a set of classes to use in conjunction with the UniREST Client methods.

UniRESTBinary.cs

This C# script contains the UniRESTBinary class for managing binary data.

TigerForge.OdinSerializer

This folder contains a distribution of the Sirenix Odin Serializer, a powerful data serializer able to serialize practically any kind of data.