Worlds.yml

Used to register the worlds that will be used within their respective game instances.

This is an example of structure that the file should follow:

worlds:
├── minigameName:
│   └── mapKey: (unused)
│       ├── name: "World folder name"
│       └── pois:
│           ├── "poi1":
│           │   ├── -x
│           │   ├── -y
│           │   ├── -z
│           │   ├── -pitch
│           │   └── -yaw
│           └── "poi2":
│               ├── -x
│               ├── -y
│               └── -z
└── minigameName2:
    └── mapKey: (unused)
        └── name: "World folder name"

When the file is created for the first time, it will have this content:

worlds:

For each mini-game we will have to place its name as a key.

worlds:
 myminigame:
  

Within this key we will have to place all the worlds that will be admitted within the mini-game.

How we name these world keys does not matter, inside the code they are not used anywhere, they are only for structuring purposes.

worlds:
 myminigame:
  template1:
  
  template2:
  

Within each key of a world comes what is important. These are the parameters:

Key	Required	Arg	Description
name	True	String	The name of the world folder inside the templates folder. Serves as an id.
pois	False	List	It is a list of keys containing the coordinates of a point of interest on the map.

An example:

Points of Interest (pois) can contain 3 values (x, y, z), or they can contain 5 (x, y, z, pitch, yaw).

worlds:
 myminigame:
  template1:
   name: "minigameWorld1"
   pois:
    spawnpoint:
     - 8.5
     - 64.0
     - 8.5
  template2:
   name: "minigameWorld2"
   pois:
    spawnpoint:
     - 32.5
     - 64.0
     - 32.5

The point of the pois is that for a certain minigame you always have the same pois, but maybe with different values, since these pois can then be obtained by you within the instance of your minigame as a Location and used, for example, to teleport a player to that location.