Settings

Misc

These options don't belong to any specific system and are defined in the base level of the config.

• skipmenu boolean
  Test option. Skips the menu and launches straight into the gamemode specified in defaultGamemode.
• defaultGamemode string
  The default gamemode used when skipping the menu.

game map

• localPlayer boolean
  If this is true there will be a player that is controlled with the keyboard from the UI.
• dummyCount number_
  If this number is above 0 and the localPlayer is enabled then there will also join this many dummy players. They behave just like players but will not move by themselves.
• forceCanvas boolean
  Enabling this will tell PIXI to use a canvas for rendering. Otherwise PIXI will decide by itself. During development we found the game to run much smoother when using the canvas so we have been keeping this option enabled.
• antialias boolean
  This options tells PIXI if it should use antialiasing. The browser support for this varies depending on if the webgl and canvas is used. During development we have had this option turned off so that the game looks the same.
• scaleUI boolean
  Enabling this option will scale the game's staticStage to keep it the same size relative to the gameStage. Essentially making it take up the same amount of screen space no matter what the screen's resolution is.
• demosystem boolean
  Enabling this option will activate the demo system when the game is running. The demo system currently lets you restart the current gamemode by pressing p on the keyboard.

communication map

• pingrate number
  How many times per second the game checks with the service to see if players are still connected.
• timeout_count number
  How many times in a row should a player be missing from a check with the service before they are assumed to be disconnected.
• service_name string
  Address where the deepstream calls are located.
• auth map
• • id string
    The id of the connection, can also be seen as the username of the deepstream connection.
• • password string
    The hashed password of the connected id.

#Example:

{
  skipmenu: false,
  defaultGamemode: 'Knock Off',
  game: {
    localPlayer: false,
    dummyCount: 9,
    forceCanvas: true,
    antialias: false,
    scaleUI: true,
    demosystem: true,
  },
  communication: {
    pingrate: 1,
    timeout_count: 5,
    service_name: 'game',
    auth: {
      id: 'game',
      password: 'password',
    },
  },
}