Studios
Map Handlerhouse-3.jpg

Installation

SoonMap HandlerStandalone
PAGE 02 OF 06  ·  OVERVIEW → INSTALLATION → CONFIGURATIONdocs.glitchstudios.dev
Browse docs

Requirements#

Server A FXServer artifact with OneSync enabled
Framework None. The resource is standalone.
Resources ox_lib
Database None. There is no SQL to import.
Optional Renewed-Weathersync, only for the weather and hour options of a world

Installation steps#

  1. Copy the glitch-mapHandler folder into your resources folder. The folder name is case-sensitive and must match the name used in exports.

  2. There are no items, SQL or images to install.

  3. Edit config/worlds.lua, or add files under config/worlds.d/, to define your worlds.

  4. Add to server.cfg, after ox_lib and before any resource that calls it:

    ensure ox_lib
    ensure glitch-mapHandler
    
  5. Start the server. There are no commands or ACE permissions to set up.

The package defines one world, north_yankton, which uses base game IPLs only. examples/racing-maps.lua.example shows how to register racing map packs. It is not loaded, and the map files it names are not included.

Updating#

Back up config/worlds.lua and any files in config/worlds.d/ first. Replace the rest of the folder, then merge new keys from the package defaults into your config. After a restart of glitch-mapHandler, the resources that use it get the glitch-mapHandler:server:ready event and should register their bucket worlds again. Avoid restarting it while a mode is running.