Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
89 lines (60 sloc) 2.59 KB

Environment Service

When the game starts, it should know where the actual services located, to communicate with. That’s why each game has a well-known address of the Environment Service hardcoded in it. So other services can move without side effects.

This service solves two problems:

  1. There should be one well-known location to start communication from;
  2. Production environment should be divided from development with no side effects
.. seealso::
   :anthill-service-source:`Source Code <environment>`

A Sandbox

While the game is being developed, usually it runs on special development environment to ensure the real players are not affected. And eventually, should be switched to production. However, usually the “environment switch” would require a new game build with new environment information. Yet every new build should be tested before shipping … in development environment.

That’s why the game hardcodes only these things:

  1. Environment Location (e.g. https://environment.example.com)
  2. Application Name (e.g. thegame) and Application Version (e.g. 1.0)

At the end of the day, the Environment Service points client application to the right :doc:`discovery` location (based on the environment).

Application Name

Application Name is an unique ID of the game to identify the game in question. Used practically on every service.

Application Version

Application Version is designed to separate different versions of the application across different environments:

images/environment_example.png

In the example above, certain versions of the application will be completely divided from other ones. That’s where the service kicks in: the actual environment is based on the version information, server side.

Note

Environments or Game Versions could be configured at the :doc:`admin-tool`.

API Versions

Games tend to be outdated once in a while, yet the online services may progress constantly. This service allows to bind specific version of game to a specific version of API. Once new version of the the API released, older versions of games may still use old API.

Customization

Each environment could have custom variables defined, completely game-specific.

For example an ID of some ad provider, or analytics account. Or URL of the website to open when player hits “help topics”.

REST API

.. toctree::
   :maxdepth: 1

   environment/api
You can’t perform that action at this time.