Difference between revisions of "Wanted"
From SupaHam
(Added arenas.yml documentation) |
(Updated name.* row) |
||
| Line 20: | Line 20: | ||
| load || String || The name of the arena that the server should load up. | | load || String || The name of the arena that the server should load up. | ||
|- | |- | ||
| − | | name.* || String || The name of the arena (Must not change once set). If players bought the map prior to the name changing, the plugin will fail to register the players as an owner of this arena. | + | | name.* || String || The name of the arena (Must not change once set). It is recommended to keep all characters lowercase and use "_" instead of white spaces. If players bought the map prior to the name changing, the plugin will fail to register the players as an owner of this arena. |
|- | |- | ||
| − | | alias || String || Alias name of the arena (The name that players will visually see. | + | | name.alias || String || Alias name of the arena (The name that players will visually see. |
|- | |- | ||
| − | | description || String || Description of the arena (Displayed when the game starts or in the shop) | + | | name.description || String || Description of the arena (Displayed when the game starts or in the shop) |
|- | |- | ||
| − | | point1 || Location || First cuboid point location of the arena | + | | name.point1 || Location || First cuboid point location of the arena |
|- | |- | ||
| − | | point2 || Location || Second cuboid point location of the arena | + | | name.point2 || Location || Second cuboid point location of the arena |
|- | |- | ||
| − | | spawns || List(Location) || Locations where a player can spawn in the arena. | + | | name.spawns || List(Location) || Locations where a player can spawn in the arena. |
|- | |- | ||
| − | | price || Integer || The amount of points required to purchase this item, if price is bigger than 0 then players that do not own it will not be able to join the game. Use -1 to disable purchasing it. | + | | name.price || Integer || The amount of points required to purchase this item, if price is bigger than 0 then players that do not own it will not be able to join the game. Use -1 to disable purchasing it. |
|- | |- | ||
| − | | must-own || Boolean || Whether players must own this arena to join the server. | + | | name.must-own || Boolean || Whether players must own this arena to join the server. |
|- | |- | ||
| | | | ||
Revision as of 12:31, 18 August 2013
Format
The file is written in the YAML format and you must follow these guidelines:
- Do not use tabs. You MUST use spaces or Bukkit will complain. If you use an editor like Notepad++ (recommended for Windows users), you must configure it to "replace tabs with spaces." In Notepad++, this can be changed in Settings > Preferences > Language Menu.
- Don't get rid of the indents. They are indented so some entries are in categories (like "max-blocks-changed" is in the "limits" category.
- If you want to check the format of this file before putting it into WorldEdit, paste it into http://yaml-online-parser.appspot.com/ and see if it gives "ERROR:".
- Lines starting with # are comments and so they are ignored.
Configuration
Note: For every period in the configuration's name as listed below, that means you indent it one level below the previous.
arenas.yml
| Configuration | Value | Description |
|---|---|---|
| load | String | The name of the arena that the server should load up. |
| name.* | String | The name of the arena (Must not change once set). It is recommended to keep all characters lowercase and use "_" instead of white spaces. If players bought the map prior to the name changing, the plugin will fail to register the players as an owner of this arena. |
| name.alias | String | Alias name of the arena (The name that players will visually see. |
| name.description | String | Description of the arena (Displayed when the game starts or in the shop) |
| name.point1 | Location | First cuboid point location of the arena |
| name.point2 | Location | Second cuboid point location of the arena |
| name.spawns | List(Location) | Locations where a player can spawn in the arena. |
| name.price | Integer | The amount of points required to purchase this item, if price is bigger than 0 then players that do not own it will not be able to join the game. Use -1 to disable purchasing it. |
| name.must-own | Boolean | Whether players must own this arena to join the server. |
