Skip to content

Configuration

Tyler Bucher edited this page Sep 7, 2018 · 1 revision

Configuring the WebGL Map (GLM) client

Note: When adding or change configuration values please use the custom.js file, as it will not be overwritten by updating the client. Below is an example custom.js file.

window.DEFAULT_PLUGIN_CONFIG.autoLogin = true;
window.DEFAULT_PLUGIN_CONFIG.autoLoginAddress = '127.0.0.1';
window.DEFAULT_PLUGIN_CONFIG.autoLoginPort = '443';

window.GLM_CONFIG.wsProtocol = 'wss';
window.GLM_CONFIG.debug = true;

glm-base-client configuration options

debug

  • Description: States if the client should enable and use debug functions. This usually results in json being outputted to the console.
  • Values: true, false.

debugWebSocketRaw

  • Description: States if the client should should log WebSocket messages in plain text. debug must be enabled for this field to work.
  • Values: true, false.

wsProtocol

  • Description: Specifies the type of WebSocket protocol to use for the web page.
  • Values: 'ws', 'wss'.

uuid

  • Description: Specifies the maps uuid in string form.
  • Notes: this option should be a version 4 UUID filled by the base map plugin or another plugin.
  • Default Value: '8a5ad958-655e-4fbf-b662-fcca5fd92a61'

glm-client configuration options

uuid

  • Description: Specifies the maps uuid in string form.
  • Notes: this option should be a version 4 UUID filled by the base map plugin or another plugin.
  • Default Value: '8a5ad958-655e-4fbf-b662-fcca5fd92a61'

autoLogin

  • Description: States if this client should auto login to a server.
  • Values: true, false.

autoLoginAddress

  • Description: The ip or host name of the server to connect to.
  • Values: any valid ipv4 or host name address in string form.
  • Example: '127.0.0.1', 'https://example.com', 'map.example.com'.

autoLoginPort

  • Description: The port of the server to connect to.
  • Values: any valid port in string form.
  • Example: '80', '443', '25568'.
Clone this wiki locally