1. Home
  2. Docs
  3. UniREST Solution 3.5
  4. Getting Started
  5. What is

What is

UniREST (Unity REST) is an all-in-one solution to connect your Unity game to your Server so as to:

  • save and load data in/from your Database;
  • save and load data in/from files stored in your Server;
  • upload and download files in/from your webspace.

It consists of 2 applications: UniREST Client and UniREST Server.


UniREST Client

The UniREST Client is a Unity asset you have to install in your Unity game project from the Unity Asset Store. It doesn’t require any extra dependency (possible third-party code is included under the TigerForge namespace) and the whole core is inside a couple of C# Script. The main class (UniRESTClient) contains methods and features that makes the communication between your game and your Server pretty easy.

Once installed, the UniREST Client needs just to be configured so as to know where your Server is (which HTTP(s) URL it has to call) and what it can do (which API can call, which Database’s table can use, etc.). The configuration is inside a dedicated C# Script file (UniRESTClientConfig.cs). In order to make this configuration easier, the UniREST Server has a specific tool that generates the C# code you must copy/paste in that file.


UniREST Server

The UniREST Server is a web application you have to install in your Server (web hosting, dedicated server, etc.). It has a graphical interface for setting up the UniREST environment in a very easy and practical way. This means you don’t have to code a Server-side application or to have strong knowledge about Databases, REST services and so on.

It’s a perfect solution if:

  • you need to develop an online game able to send data to a Database and receive data from a Database, with a high level of security;
  • you need an easy, fast and secure way to save data in files stored in your webspace and load data from those files;
  • you need an easy and complete system to download and upload files;
  • you don’t need real-time communication;
  • you don’t want to develop a server-side application;
  • you don’t want to invest a lot of money in a server solution.

Because an application like this requires some features as Database management, REST technology and a secure environment, it has been developed on top of the WordPress framework: the UniREST Server application is a WordPress plugin!

Why WordPress?

WordPress is a CMS (Content Management System) well known in the website creation field and supported by a lot of hosting and server providers. It comes with a robust, secure and efficient framework that allows a web developer to create new functionalities.

The UniREST Server application has been developed as a WordPress plugin. Once installed the UniREST Server development environment is available in the WordPress administration menu.

Advantages of using WordPress:

  • it’s a well-known environment;
  • it has a robust, secure and efficient lightweight framework;
  • its development framework already has all the tools and technologies requested by the UniREST solution;
  • it’s supported by a lot of hosting and server providers and doesn’t require expensive server-side solutions;
  • many providers have tools for installing WordPress with just one click (anyway, WordPress is very easy to install manually);
  • once WordPress is installed, you can install the UniREST Server plugin with just one click and it’s ready to be used;
  • being a plugin, the UniREST Server resides under the WordPress Administration Area, which is protected and accessible only by the WordPress owner.

For detailed informations about the installation procedure of the UniREST Server application and the UniREST Client asset see the Installation paragraph of the UniREST Server and Client chapters.