Quick Start Guide

To keep it simple, we've created a guide and an example integration that you can check out.

  1. Clone this repo and follow the README.md to run an example game locally on your machine.

  2. At this point you should see 4 buttons rendered in an iFrame. Open up the your browser's dev console and then click the buttons and notice the logs.

If you do not see the buttons rendered, check out the url query params and ensure that the src param in step 2 matches where the demo game is being served.

  1. Take a look at the game.ts file in the example game repo and get a feel for what is happening.

  2. Integrate the needed methods into your game using the SDK, ensure your game is running locally, then update the src param found in the url of step 2 to wherever your game is being locally served.

While in this test environment, use f8c22e6c-1086-4529-8800-2c72f98b9915 as your gameId when creating a new instance of the GameService. In production you will use the gameId that is generated when you register your game.

🍾 👏 Congrats if you see your game rendered in the iFrame. You've successfully integrated your game.

Note that no database records are created and the messages the demo arcade returns are static (mock data). Just ensure that your game is properly handling and responding to the data it receives.

  1. Once you've successfully integrated your game into the demo app, you can create and API key, and register your game.

Make sure to update your production domain and let us know when you are ready to publish 🚀

Last updated