Skip to content

Configuration

Jump to bottom
Tyler Bucher edited this page Sep 6, 2018 · 3 revisions

glm.conf configuration file

Table of Contents

serverName

  • Description: The name of the server to send to the web map. This helps to identify the server from the client server list.
  • Examples: Jacks cool server, Survival, Minigames Server

serverList

  • Description: The list of server to network together.
  • Examples: 
    serverList=[
    "127.0.0.1:25565",
    "example.com:25565",
    "map.example.com:25565"
]
    Or empty for no extra linked servers. 
    serverList=[
]
  • Notes: The primary server / plguin should specify any child servers which also run this plugin if you want them to be linked. If a child server is specified the client will NOT fetch the serverList configuration option recursively. In simpler terms, the serverList configuration option will not be called for the child servers if it is present in the master server serverList configuration option.

address

  • Description: The address to start the WebSocket server on.
  • Examples: localhost, 127.0.0.1, 173.233.265.1

port

  • Description: The port to start the WebSocket server on.
  • Examples: 80, 443, 25568
  • Notes: Some browsers do not like using certain ports on certain connection types. I will list the conflicts below.
    • Chrome: Does not like accepting Secure WebSocket connections that are not using port 443 while the page is being loaded over HTTPS.
    • Cloudflare: Allowed ports

useSsl

  • Should the web socket server use ssl.
  • Examples: false, true.

url

  • The url of the map the plugin gives the players.
  • Examples: https://example.com/map/, http://map.example.com.

chunkCacheLifetime

  • The amount of time in milliseconds which a chunk can live in the cache. (1 second = 1000 milliseconds)
  • Examples: 60000, 1000.

playerRequestTime

  • The amount of time in between calls for player information. Use -1 for real time. (1 second = 1000 milliseconds)
  • Examples: 2000, -1.

generalCommandInterval

  • The amount of time in between calls for general commands like 'init'. (1 second = 1000 milliseconds)
  • Examples: 30000, 1000.

totalTickPercentage

  • The percent of a tick to consume processing chunks. Values range from 0.1 to 1.0.
  • Examples: 0.8, 0.2.

tickInterval

  • The amount of ticks to wait until the next iteration of chunk processing.
  • Examples: 4, 0, 19.

defaultWorld

  • The name of the default world to display first.
  • Examples: world, DIM1, DIM-1.
  • Notes: The client will try to render this world first.

worldList

  • The list of worlds to allow to be queried.
  • Examples: 
    worldList=[
    "world",
    "DIM-1"
]
  • Notes: You must include the defaultWorld option in this list.

loadWorld

  • Allow the web map to load terrain (chunks) for the initial caching process.
  • Examples: true, false.

generateWorld

  • Allow the web map to generate terrain. Only effects plugin if loadWorld is enabled.
  • Examples: true, false.
  • Note: This option currently sometimes generates phase tracker errors for an unknown reason. Please try to refrain from using it until fixed.

respectWorldBorder

  • Make the plugin respect the world border when generation or loadWorld is enabled.
  • Examples: true, false.

limitCache

  • Limit the size of the cache. If you are worried about the amount of ram consumed enable this option.
  • Examples: true, false.

maximumChunksInCache

  • Maximum number of chunks (per world) allowed in the cache at one time. The following number represents 318 x 318 chunks or roughly 80 megabytes.
  • Examples: 1000, 256.

jdbcDatabaseUrl

  • Jdbc database url for chunk storage.
  • Examples: jdbc:mysql://<host>:<port>/<database>?user=<username>&password=<password>.

databaseTablePrefix

  • The prefix for database tables.
  • Examples: main_, glm-, storage.

certifiedUuids

  • Should the plugin only allow certified map uuid's to connect.
  • Examples: true, false.
  • Notes: These ids help to filter people from trying to use the map as a ddos tool.

certifiedUuids

  • A certified list of uuid's for client maps. There must be at least one value in this list.
  • Notes: This uuid 8a5ad958-655e-4fbf-b662-fcca5fd92a61 is the default id of the client created by the GLM development team.
Clone this wiki locally