Disclaimer: This is a living document and requirements may change in the future, we will aim to keep this document up to date with changes to our integration process.

Last updated:01/14/2022

Background

At present, Leaderboards are populated and shown for Tournament-enabled games. To prevent player cheating, we must ensure that critical gameplay and score submission and computation is done on a remote server and not on player devices.

Before - everything is running on player device

After - Game Logic is done on a remote server and not on player device

To this end, Colyseus game server technology was selected as a mature, stable, documented, and open source platform.

Requirements

1. Colyseus version 0.14 is used.

   colyseus-sandbox-template.zip

2. Games ideally should be able to run on 2 modes.

   • Tournament — game logic is done on Colyseus server

     • The OPArcade system sends the following parameters when launching in Tournament Mode. Parameters in RED are required to be passed to Colyseus upon client creation.

       • playerId
       • otp
       • tourneyId
       • displayname — current name of the logged in user. Name will be urlencoded so will need some additional processing to remove escape characters if any. (https://docs.unity3d.com/ScriptReference/Networking.UnityWebRequest.UnEscapeURL.html)
       • image_url — avatar image url of the logged in user
       • wallet_address — wallet address of currently logged in user. If this is passed to Colyseus in addition to the 3 required parameters, our servers will verify if the wallet_address belongs to the currently logged in player.

     • In production, the OPArcade system passes these parameters on launch by sending a GET request to your hosted game. (https:xyz.com/?playerId=&token=&tourneyId=******). Your game then passes it to Colyseus when calling joinOrCreate.

     

     

     Sample parsing inside Unity Code — using Application.absoluteURL

     • For the sake of development, these can be any value for now and will be manually adjusted by the OPArcade team prior to release.
     • These three parameters must be made available when connecting to Colyseus as they will be used in checking authorised gameplay on our servers.
     • Passing walletAddress to Colyseus will verify if the wallet address belongs to the player so is optional. Use case for this is when the game needs to verify NFT’s in a passed wallet belong to the logged in player. The walletAddress will need to be passed in the onAuth function in Colyseus (see below)
     • Example below:

     join():Promise<void> {
             return new Promise((resolve, reject) => {
                 this.client
                     .joinOrCreate<ITriskaState>('triska_room', {
                         playerId: this.playerId,
                         token: this.otp,
                         tourneyId: this.tourneyId,
     										sessionId: this.sessionId,
                         walletAddress: this.wallet_address //optional - useful if game will be using player NFT's
     
                     })
                     .then((room) => {
                         this.room = room;
                         this.processRoomMessages(this.room);
     
                         resolve();
                     })
                     .catch(reject);
             });
         }
     

   • For Fun — game logic is done on player device.

     • No additional parameters need to be passed to the game. The game does not connect to Colyseus.
     • The following parameters are sent in case the game would require any of them:
       • displayname — current name of the logged in user. Name will be urlencoded so will need some additional processing to remove escape characters if any. (https://docs.unity3d.com/ScriptReference/Networking.UnityWebRequest.UnEscapeURL.html)
       • image_url — avatar image url of the logged in user
       • wallet_address — wallet address of currently logged in user

3. Games should send a postMessage upon end of gameplay.