magic-compass/template/instructions.txt

20 lines
1.3 KiB
Plaintext

This folder shall contain all the information regarding the locations linked to this world. DO NOT rename folders or the mod won't be able to read them.
locations are stored in .yml files, and every file can contain multiple locations. Locations must follow the template down below, where 'ID' is an actual number
ID:
description:
icon:
teleport_to: X, Y, Z
cooldown: (optional, default none)
requires: (optional privileges required to use the teleport: separate them with ", ", default none)
hidden_by_default: (optional, put 'true' to hide the icon to players who don't have the required privileges)
The ID indicates the position of the associated item in the grid (which scales according to the highest number declared), and empty spaces are generated automatically if the numbers of the items don't represent a full sequence.
/icons is for... icons.
/locale is for translation files, in case you want to geolocalise the name of your icons. It's highly recommended to rename the example files, so put whatever name you want, followed by the country code the file represents and .tr. For instance, a translation file for Spanish would be "mycoolgame.es.tr".
/menu is for customising the locations formspec. DO NOT rename files or they won't work, just override them with your custom image.