UniREST Solution

⭐ 3.x IMPORTANT NOTES ⭐

If you are already using UniREST and you are going to update to 3.x, please read carefully the "What's new" page in the online manual. The new version contains some relevant changes you should consider before upgrading.

Link to: What's new page.

--------------------------------

WHAT IS

UniREST (Unity REST) is an all-in-one Solution to connect your Unity Game with your Server. In this way, you can:

• send data to your Database, read data from your Database and perform the typical Database related operations (update, delete, etc.)

• save data into online files, read data from online files and perform other operations such as deleting files, getting a list of own files, and so on.

• upload and download files (one or more together), with full control of the process: internet speed, data traffic, completion / error / uploading statuses, etc.

HOW IT WORKS

UniREST consists of two applications: UniREST Server, a very easy to use web app developed as a WordPress plugin, you have to install in your server (web hosting, virtual server, dedicated server, etc.) and UniREST Client, a Unity asset you have to install in your game project.

Once both applications are properly installed and configured, your Game and your Server can communicate.

ALL MADE EASY

The scope of UniREST Solution is to make things as simpler as possible, and secure as well.

For this reason, the UniREST Server has been built on top of the WordPress framework. In this way, you don’t have to configure a server environment. Once you have WordPress installed in your server (many Providers allow you to install it with just one click), the UniREST Server can be installed in an instant and it doesn’t require any special server feature.

The UniREST Client is simply a C# project containing all the methods and tools you need to make your game communicate with your Server. These methods don’t require technical skills or a good knowledge of REST architecture. Everything is kept simple so that you can focus on your game development and not lose time trying to set up a server-side communication system.

SECURITY

UniREST Solution adopts two layers of security to make communications secure.

The first one is integrated into the system: data is encrypted by secret keys (they are randomly generated when you install UniREST Server). In this way, the information exchanged between your Game and your Server is not “clear text”, but encrypted.

The second is optional and can be manually managed: security Tokens.

DATABASE AND APIs

Because the UniREST Solution uses Database tables to manage your game data and the REST architecture for the communications, you have to set up the tables and the APIs you need.

Doing it manually is not so easy. It requires the knowledge of Database management software (for example, phpMyAdmin) and the skills for developing REST APIs with PHP language (you are a C# game developer and you might not want to learn or use PHP).

For this reason, UniREST Server allows you to create tables and APIs through a graphical interface. This web application has no complex or sophisticated features, and all you need can be made with just some clicks. The scope of this tool is not to offer a complex Database manager system or show tons of options for creating any sort of API. The scope is to give you simple and fast tools to connect your game with your Database through the UniREST Solution.

USERS AND AUTHORIZATIONS

Usually, an online game requires that the player is a registered user and that, before starting playing, the user logins.

UniREST Solution has user registration and login features already built into its system. So, you don’t have to do anything on the server side, and in your Game, you can immediately use the Register() and the Login() methods to manage your users' access. You can even use special methods such as AutoLogin() or ApplicationLogin() to immediately use the system (account creation and login are done automatically).

Login() and Registration() methods just require a unique username and a password. It’s up to you to decide how to get that information. This means that UniREST Solution doesn’t force you to use a specific way to create accounts. For example, you can request username and password with a form, generate them automatically when the user installs your game the first time, you can use an account created by other systems or third-party tools, and so on.

However, your users (or the Game) must perform a login into your game. This is mandatory because the login unlocks the authorization UniREST Client needs to communicate with UniREST Server.

UNIREST SOLUTION FEATURES

UniREST Server

• Its installation just requires WordPress.

• It doesn’t require complex, expensive server features.

• No coding, technical skills and knowledge are required.

• Easily create Database tables and REST APIs, through a graphical interface.

• It’s secure. As a plugin, it stays inside the WordPress administration area.

• Communications are encrypted and managed by security Tokens.

UniREST Client

• Install it in your project and it’s ready to go.

• Just a small C# project with everything you need to work with the UniREST Solution.

• All the methods are simple to use. They require the minimum effort to work and they just give you the data you need.

• Works with any version of Unity, from 2017.

• Cross-platform: works with PC, MAC, Android, iOS, WebGL and other platforms.

THE PERFECT SOLUTION IF:

• you want to save/load your Game data in/from your Server;

• you don't want to spend time developing a server-side application;

• you don't want to invest a lot of resources and money in complex Server solutions.

WHAT'S NEW IN 3.x

• The new UniRESTClient.Async class exposes the various methods as async functions, with WebGL platform support.

• The new SyncTable feature allows creating multiplayer games via REST calls.

• The new FileManager class for fully online files management.

⭐ Always do a backup copy of your Unity project before updating this asset!

ONLINE MANUAL

UniREST Solution Online Manual

* * * * DEMO * * * *

A Demo Unity Package is available in the UniREST Solution Online Manual. I invite you to try this Demo before proceeding with the purchase, so as to evaluate if this Solution meets your needs and works with your systems.

* * * * * * * * * * * *