Skip to content

Regions

Regions are currently used for wayshells, they travel region <-> region. Each region has a main_port where you'll always arrive at when traveling there, and they can have any number of ports that you can depart from using wayshells for that region.

Example region
regions:
  - id: "saltedslabs"
    display_name: "Salted Slabs"
    description: "these slabs sure are salted"
    main_port: "saltedslabsport" # the port they will arrive at when they travel to this region via a wayshell
    color_theme: "saltedslabs" # optional. is overrode by the ones set in the area
    music: ["/audio/meow.ogg", "/audio/meow.mp3"] # optional. is overrode by the ones set in the area. the list is a list of fallbacks that will be tried in order if the browser can't play the first one.
    ambient_audio: ["/audio/waves.ogg", /audio/waves.mp3"] # optional. same deal as music

How to make an area a port

An area must have a region set to be considered a port. Then any wayshell for that region will work from that area.

areas:
- id: "saltedslabsport"
  display_name: "Salted Slabs Port"
  description: "meow"
  port_in_region: "saltedslabs" # this is a port in the "saltedslabs" region.
  actions: # etc...

Special case: vessel region at sea

While at sea, the inside a vessel region will be replaced by the inside a vessel at sea region (the ids for this are set in config.exs).