Gameye

The Gameye Developer Hub

Welcome to the Gameye developer hub. You'll find comprehensive guides and documentation to help you start working with Gameye as quickly as possible, as well as support if you get stuck. Let's jump right in!

To being using Gameye with your game, please go to: https://docs.gameye.com/docs/preparing-your-game-server-for-hosting

Game modes

Below is a list of the current esports titles that we host and their current supported game modes and their appropriate templateID. For custom game modes and template setups, please discuss this during your onboarding and integration phase.

When making an API call, you will use the gameKey variable to specify the game and the templateId variable to specify which template or game mode to run. Below is an example JSON call which shows both variables being used. The game in use is CSGO and we are running a template that populates the server with bots for practice.

{
   "gameKey": "csgo",
   "templateKey": "bots"
}

Below is a list of Games and their corresponding templates. You will need to make sure you are using the correct combination of gameKeys and templateIds for your calls to work.

Example:
If you use the gameKey "csgo" and the templateId "dangerzone", you will get a CSGO dangerzone match.

If you use the gameKey "csgo" and the templateId "5on5", your server will fail to start, as the gameKey is incorrect. In order to run the templateId "5on5", you will need to use the gameKey "csgo-get5"

Game

Game mode

gameKey

templateKey

Counter Strike: Global Offensive

Bots - Fill an entire match with bots for practicing

csgo

bots

2v2 Wingman - Competitive 2v2 match

csgo

2v2wingman

Dangerzone - Battle-Royal style match

csgo

dangerzone

Free for all - All out war with no specific teams

csgo

ffa

5on5 - Using the Get5 addon, a fully competitive 5vs5 match

csgo-get5

5on5

Team Fortress 2

tf2

Bots - Fill an entire match with bots for practicing

bots

tf2

Control Point - Teams fight to capture and hold specific points on the map

controlpoint

tf2

King of the Hill - Teams fight to hold one point for as long as possible

koth

tf2

Payload - On team escorts a payload to a specific point, while the other team tries their best to stop them

payload

tf2

Payload - On team escorts a payload to a specific point, while the other team tries their best to stop them, while racing against the clock to set the best time

payloadrace

gameMode and gameType

The templateKeys listed above are for specific game modes for CSGO and have a number of default variables set within the template. This gives each game session a certain feel to the player. If you wanted to run a 2v2wingman CSGO server while using the Get5 addon, you would need to make a call that included the following:

"gameMode": 0 
"gameType": 2
"get5KickWhenNoMatchLoaded": 0       //This should only be used when using the csgo-get5 gameKey

The table below shows the different gameMode and gameType combinations you can have and what type of game the CSGO server will run.

Game

gameType

gameMode

Casual (default)

0

0

Competitive / Scrimmage

0

1

Wingman

0

2

Arms Race

1

0

Demolition

1

1

Deathmatch

1

2

Custom

3

0 - 2

Guardian

4

0

Co-op Strike

4

1

Danger Zone

6

0

Updated 7 months ago


Game modes


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.