Integration - step 3

Choosing and integrating plugin.

escs is plugin based. We are providing plugins for different game engines and all you have to do is to integrate our plugin instead of working with our API directly.

Connect plugin to the project.

Locate plugin for your game engine in the menu on the left and follow instructions there, how to download, and connect it to your project.

If you do not see a plugin for your game engine, please write us a message. We are constantly developing new plugins and are happy to help you.

Set up the plugin.

For the escs to work properly with your game you need to do 3 simple things:

  • initialize the system at the start of your game

  • let the system know when the user starts an actual game

  • let the system know when the user ends the game and sends the user's score to the system.

At the start of your game, as early as possible, call the method invokeManaged() of the plugin. Invoke takes public key from step 1 as a parameter, which you must submit (this is example for JS/ReactNative plugin, please refer to appropriate plugin section for config parameters):

service.invokeManaged({
public_key: '3dd48bec-2e82-4826-8757-fc14d872882d',
base_url: 'https://api.escs.io',
player_base_url: 'https://player.escs.io',
analyticsEnv: 'prod'
})

When a user starts an actual game, just before the game starts, call method startGame().

service.startGame()

When the game ends, call the method endGame(points) - instead of points send an actual score that the user got in the game.

service.endGame(1378)

You can define units for the score and more in the client.escs.io. Look for the advanced options.

This completes the basic integration. Now when you start your game, you'll find an escs symbol inside it and all the services that escs has to offer.