Difference between revisions of "Wanted"
From SupaHam
(Changed Configuration column width) |
(Updated Configuration) |
||
(7 intermediate revisions by the same user not shown) | |||
Line 13: | Line 13: | ||
Note: For every period in the configuration's name as listed below, that means you indent it one level below the previous. | Note: For every period in the configuration's name as listed below, that means you indent it one level below the previous. | ||
+ | |||
+ | === config.yml === | ||
+ | |||
+ | {| class="wiki-table" | ||
+ | ! width="240"| Configuration | ||
+ | ! width="100"| Value | ||
+ | ! Description | ||
+ | |- | ||
+ | | lobby-mode || Boolean || Whether the plugin should enable it's lobby features, or all game features. | ||
+ | |- | ||
+ | | test-mode || Boolean || Whether the plugin should enable in testing mode and disable updating player stats, enabling test commands, etc. | ||
+ | |- | ||
+ | | mysql.ip || String || MySQL ip address to connect to. | ||
+ | |- | ||
+ | | mysql.port || String || MySQL port. | ||
+ | |- | ||
+ | | mysql.user || String || MySQL username. | ||
+ | |- | ||
+ | | mysql.pass || String || MySQL password. | ||
+ | |- | ||
+ | | mysql.database || String || MySQL database. | ||
+ | |- | ||
+ | | mysql.tables.players || String || MySQL Players table (stores player information, such as kills). | ||
+ | |- | ||
+ | | lobby.countdown || Integer || Duration (in seconds) until the game begins. | ||
+ | |- | ||
+ | | arena.max-time || Integer || Duration (in minutes) until the game ends. | ||
+ | |- | ||
+ | | points.name || String || Name of the in-game points system. | ||
+ | |- | ||
+ | | points.kill-reward || Integer || Amount of points to reward a player for getting a kill. | ||
+ | |- | ||
+ | | points.death-reward || Integer || Amount of points to reward a player for dying. | ||
+ | |- | ||
+ | | points.win-reward || Integer || Amount of points to reward a player for winning a game. | ||
+ | |- | ||
+ | | points.loss-reward || Integer || Amount of points to reward a player for losing a game. | ||
+ | |- | ||
+ | | listeners.enabled.chat-listener || Boolean || Whether this plugin should handle chat messages. | ||
+ | |- | ||
+ | | listeners.enabled.motd-listener || Boolean || Whether this plugin should handle server MOTD messages (changes according to the game state). | ||
+ | |- | ||
+ | | listeners.enabled.misc-listener || Boolean || Whether this plugin should handle default game mechanics, such as disabling rain, crafting, picking up/dropping items, etc. | ||
+ | |- | ||
+ | | group.<name>.color || String || Display name colors to assign to players in this group | ||
+ | |- | ||
+ | | group.<name>.multiplier || Double || The number to multiply any points players in this group receive by. | ||
+ | |- | ||
+ | | miscellaneous.message-prefix || String || The prefix to be displayed in certain messages. (Can be empty) | ||
+ | |- | ||
+ | | miscellaneous.max-players || Integer || The maximum amount of regular players allowed on the server. | ||
+ | |- | ||
+ | | miscellaneous.max-reserved || Integer || The amount of reserved slots on the server. | ||
+ | |- | ||
+ | | miscellaneous.minimum-players || Integer || The amount of players required for the game to begin. | ||
+ | |- | ||
+ | | miscellaneous.idle-kick || Integer || Duration (in seconds) before a player gets kicked for being dead too long. | ||
+ | |- | ||
+ | | miscellaneous.hub-command || String || Command to execute when the game is over. (Leave empty for no command) | ||
+ | |- | ||
+ | | miscellaneous.debug-messages || Boolean || Whether this plugin should output debug messages to the log. | ||
+ | |- | ||
+ | | miscellaneous.compass-scramble || Integer || The distance between a player and their target till their compass starts scrambling. | ||
+ | |- | ||
+ | | miscellaneous.cooldown || Integer || Duration (in seconds) before players can join again after a game has ended. | ||
+ | |} | ||
+ | |||
=== arenas.yml === | === arenas.yml === | ||
{| class="wiki-table" | {| class="wiki-table" | ||
− | ! width=" | + | ! width="240"| Configuration |
! width="100"| Value | ! width="100"| Value | ||
! Description | ! Description | ||
Line 37: | Line 104: | ||
|- | |- | ||
| name.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. | ||
− | |||
− | |||
|} | |} | ||
Line 45: | Line 110: | ||
==== Default ==== | ==== Default ==== | ||
{| class="wiki-table" | {| class="wiki-table" | ||
− | ! width=" | + | ! width="240"| Configuration |
! width="100"| Value | ! width="100"| Value | ||
! Description | ! Description | ||
Line 65: | Line 130: | ||
{| class="wiki-table" | {| class="wiki-table" | ||
− | ! width=" | + | ! width="240"| Configuration |
! width="100"| Value | ! width="100"| Value | ||
+ | ! width="100"| Default | ||
! Description | ! Description | ||
|- | |- | ||
− | | arrows || Integer || Amount of arrows players get when respawning. | + | | classes.archer.arrows || Integer || 1 || Amount of arrows players get when respawning. |
|- | |- | ||
− | | power- | + | | classes.archer.power-level || Integer || 1 || Level of the damage enchantment on the bow. |
|- | |- | ||
− | | infinity || Boolean || Whether the bow should have infinity. | + | | classes.archer.infinity || Boolean || true || Whether the bow should have infinity. |
|} | |} | ||
Line 79: | Line 145: | ||
{| class="wiki-table" | {| class="wiki-table" | ||
− | ! width=" | + | ! width="240"| Configuration |
! width="100"| Value | ! width="100"| Value | ||
+ | ! width="100"| Default | ||
! Description | ! Description | ||
|- | |- | ||
− | | ticks || Integer || Amount of ticks (a second is 20 ticks) till it blows up. | + | | classes.arsonist.ticks || Integer || 0 || Amount of ticks (a second is 20 ticks) till it blows up. 0 will let set the ticks to default tnt ticks. |
|- | |- | ||
− | | tnts || Integer || Amount of tnts players get upon respawning. | + | | classes.arsonist.tnts || Integer || 20 || Amount of tnts players get upon respawning. |
|} | |} | ||
Line 91: | Line 158: | ||
{| class="wiki-table" | {| class="wiki-table" | ||
− | ! width=" | + | ! width="240"| Configuration |
! width="100"| Value | ! width="100"| Value | ||
+ | ! width="100"| Default | ||
! Description | ! Description | ||
|- | |- | ||
− | | freeze-time || Integer || Duration (in seconds) the player stays frozen. | + | | classes.froster.freeze-time || Integer || 3 || Duration (in seconds) the player stays frozen. |
|- | |- | ||
− | | snowballs || Integer || Amount of snowballs players get upon respawning. | + | | classes.froster.snowballs || Integer || 3 || Amount of snowballs players get upon respawning. |
|} | |} | ||
Line 103: | Line 171: | ||
{| class="wiki-table" | {| class="wiki-table" | ||
− | ! width=" | + | ! width="240"| Configuration |
! width="100"| Value | ! width="100"| Value | ||
+ | ! width="100"| Default | ||
! Description | ! Description | ||
|- | |- | ||
− | | item || Integer || id of the item to give the player | + | | classes.scorcher.item || Integer || 369 || id of the item to give the player |
|- | |- | ||
− | | chance || Integer || The chance of the Scorcher setting their target on fire. | + | | classes.scorcher.chance || Integer || 25 || The chance of the Scorcher setting their target on fire. |
|} | |} | ||
Line 115: | Line 184: | ||
{| class="wiki-table" | {| class="wiki-table" | ||
− | ! width=" | + | ! width="240"| Configuration |
! width="100"| Value | ! width="100"| Value | ||
+ | ! width="100"| Default | ||
! Description | ! Description | ||
|- | |- | ||
− | | potion-amplifier || Integer || Level of speed effect the player gets upon respawning | + | | classes.scout.potion-amplifier || Integer || 2 || Level of speed effect the player gets upon respawning |
|} | |} | ||
Line 125: | Line 195: | ||
{| class="wiki-table" | {| class="wiki-table" | ||
− | ! width=" | + | ! width="240"| Configuration |
! width="100"| Value | ! width="100"| Value | ||
+ | ! width="100"| Default | ||
! Description | ! Description | ||
|- | |- | ||
− | | potion- | + | | classes.toxic.potion-amplifier || Integer || 1 || Level of the poison effect. |
|- | |- | ||
− | | potion- | + | | classes.toxic.potion-duration || Integer || 10 || Duration (in seconds) the poison effect lasts. |
|- | |- | ||
− | | potions || Integer || Amount of poison potions players get upon respawning. | + | | classes.toxic.potions || Integer || 5 || Amount of poison potions players get upon respawning. |
|} | |} | ||
Line 160: | Line 231: | ||
! width="240"| Configuration | ! width="240"| Configuration | ||
! width="100"| Value | ! width="100"| Value | ||
+ | ! width="100"| Default | ||
! Description | ! Description | ||
|- | |- | ||
− | | potion- | + | | equipments.endstonehead.potion-amplifier || Integer || 1 || Level of the resistance effect. |
|- | |- | ||
− | | potion- | + | | equipments.endstonehead.potion-duration || Integer || 6000 || Duration (in seconds) the resistance effect lasts. |
|} | |} | ||
Line 172: | Line 244: | ||
! width="240"| Configuration | ! width="240"| Configuration | ||
! width="100"| Value | ! width="100"| Value | ||
+ | ! width="100"| Default | ||
! Description | ! Description | ||
|- | |- | ||
− | | potion-duration || Integer || Duration (in seconds) the night vision effect lasts. | + | | equipments.glasshead.potion-duration || Integer || 6000 || Duration (in seconds) the night vision effect lasts. |
|} | |} | ||
Line 182: | Line 255: | ||
! width="240"| Configuration | ! width="240"| Configuration | ||
! width="100"| Value | ! width="100"| Value | ||
+ | ! width="100"| Default | ||
! Description | ! Description | ||
|- | |- | ||
− | | potion-duration || Integer || Duration (in seconds) the speed effect lasts. | + | | equipments.icehead.potion-amplifier || Integer || 1 || Level of the speed effect. |
+ | |- | ||
+ | | equipments.icehead.potion-duration || Integer || 6000 || Duration (in seconds) the speed effect lasts. | ||
+ | |} | ||
+ | |||
+ | ==== Invisibility Perk ==== | ||
+ | |||
+ | {| class="wiki-table" | ||
+ | ! width="240"| Configuration | ||
+ | ! width="100"| Value | ||
+ | ! width="100"| Default | ||
+ | ! Description | ||
|- | |- | ||
− | | potion- | + | | equipments.invisibilityperk.potion-duration || Integer || 10 || Duration (in seconds) the invisibility effect lasts. |
|} | |} | ||
Line 194: | Line 279: | ||
! width="240"| Configuration | ! width="240"| Configuration | ||
! width="100"| Value | ! width="100"| Value | ||
+ | ! width="100"| Default | ||
! Description | ! Description | ||
|- | |- | ||
− | | resistance-potion- | + | | equipments.obsidianhead.resistance-potion-amplifier || Integer || 1 || Level of the resistance effect. |
|- | |- | ||
− | | resistance-potion- | + | | equipments.obsidianhead.resistance-potion-duration || Integer || 6000 || Duration (in seconds) the resistance effect lasts. |
|- | |- | ||
− | | slowness-potion- | + | | equipments.obsidianhead.slowness-potion-amplifier || Integer || 1 || Level of the slowness effect. |
|- | |- | ||
− | | slowness-potion- | + | | equipments.obsidianhead.slowness-potion-duration || Integer || 6000 || Duration (in seconds) the slowness effect lasts. |
|} | |} | ||
Line 210: | Line 296: | ||
! width="240"| Configuration | ! width="240"| Configuration | ||
! width="100"| Value | ! width="100"| Value | ||
+ | ! width="100"| Default | ||
! Description | ! Description | ||
|- | |- | ||
− | | distance || Integer || Distance when the players' target's compass starts scrambling. | + | | equipments.quartzhead.distance || Integer || 30 || Distance when the players' target's compass starts scrambling. |
|} | |} | ||
Line 220: | Line 307: | ||
! width="240"| Configuration | ! width="240"| Configuration | ||
! width="100"| Value | ! width="100"| Value | ||
+ | ! width="100"| Default | ||
! Description | ! Description | ||
|- | |- | ||
− | | potion- | + | | equipments.spongehead.potion-amplifier || Integer || 1 || Level of the absorption effect. |
|- | |- | ||
− | | potion- | + | | equipments.spongehead.potion-duration || Integer || 6000 || Duration (in seconds) the absorption effect lasts. |
|} | |} | ||
Line 232: | Line 320: | ||
! width="240"| Configuration | ! width="240"| Configuration | ||
! width="100"| Value | ! width="100"| Value | ||
+ | ! width="100"| Default | ||
! Description | ! Description | ||
|- | |- | ||
− | | heal-percentage || Integer || A percentage of the amount to heal. 0 being none, 100 being all damage. | + | | equipments.tnthead.heal-percentage || Integer || 50 || A percentage of the amount to heal. 0 being none, 100 being all damage. |
|} | |} |
Latest revision as of 00:15, 19 August 2013
Format
Copied from: http://wiki.sk89q.com/wiki/WorldEdit/Configuration/Bukkit
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.
config.yml
Configuration | Value | Description |
---|---|---|
lobby-mode | Boolean | Whether the plugin should enable it's lobby features, or all game features. |
test-mode | Boolean | Whether the plugin should enable in testing mode and disable updating player stats, enabling test commands, etc. |
mysql.ip | String | MySQL ip address to connect to. |
mysql.port | String | MySQL port. |
mysql.user | String | MySQL username. |
mysql.pass | String | MySQL password. |
mysql.database | String | MySQL database. |
mysql.tables.players | String | MySQL Players table (stores player information, such as kills). |
lobby.countdown | Integer | Duration (in seconds) until the game begins. |
arena.max-time | Integer | Duration (in minutes) until the game ends. |
points.name | String | Name of the in-game points system. |
points.kill-reward | Integer | Amount of points to reward a player for getting a kill. |
points.death-reward | Integer | Amount of points to reward a player for dying. |
points.win-reward | Integer | Amount of points to reward a player for winning a game. |
points.loss-reward | Integer | Amount of points to reward a player for losing a game. |
listeners.enabled.chat-listener | Boolean | Whether this plugin should handle chat messages. |
listeners.enabled.motd-listener | Boolean | Whether this plugin should handle server MOTD messages (changes according to the game state). |
listeners.enabled.misc-listener | Boolean | Whether this plugin should handle default game mechanics, such as disabling rain, crafting, picking up/dropping items, etc. |
group.<name>.color | String | Display name colors to assign to players in this group |
group.<name>.multiplier | Double | The number to multiply any points players in this group receive by. |
miscellaneous.message-prefix | String | The prefix to be displayed in certain messages. (Can be empty) |
miscellaneous.max-players | Integer | The maximum amount of regular players allowed on the server. |
miscellaneous.max-reserved | Integer | The amount of reserved slots on the server. |
miscellaneous.minimum-players | Integer | The amount of players required for the game to begin. |
miscellaneous.idle-kick | Integer | Duration (in seconds) before a player gets kicked for being dead too long. |
miscellaneous.hub-command | String | Command to execute when the game is over. (Leave empty for no command) |
miscellaneous.debug-messages | Boolean | Whether this plugin should output debug messages to the log. |
miscellaneous.compass-scramble | Integer | The distance between a player and their target till their compass starts scrambling. |
miscellaneous.cooldown | Integer | Duration (in seconds) before players can join again after a game has ended. |
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. |
classes.yml
Default
Configuration | Value | Description |
---|---|---|
classes.<name> | String | Changing this will break the plugin. |
classes.<name>.enabled | Boolean | Whether to enable or disable this class. By disabling the class, no players will be able to use it and will automatically unequip it when they join. |
classes.name.alias | String | Alias name of the class (The name that players will visually see). |
classes.name.description | String | Description of the class (Displayed in the shop). |
classes.name.price | Integer | The amount of points required to purchase this class. Use -1 to disable purchasing it. |
classes.name.shop-icon | Item | The item to be displayed in the shop gui. |
Archer
Configuration | Value | Default | Description |
---|---|---|---|
classes.archer.arrows | Integer | 1 | Amount of arrows players get when respawning. |
classes.archer.power-level | Integer | 1 | Level of the damage enchantment on the bow. |
classes.archer.infinity | Boolean | true | Whether the bow should have infinity. |
Arsonist
Configuration | Value | Default | Description |
---|---|---|---|
classes.arsonist.ticks | Integer | 0 | Amount of ticks (a second is 20 ticks) till it blows up. 0 will let set the ticks to default tnt ticks. |
classes.arsonist.tnts | Integer | 20 | Amount of tnts players get upon respawning. |
Froster
Configuration | Value | Default | Description |
---|---|---|---|
classes.froster.freeze-time | Integer | 3 | Duration (in seconds) the player stays frozen. |
classes.froster.snowballs | Integer | 3 | Amount of snowballs players get upon respawning. |
Scorcher
Configuration | Value | Default | Description |
---|---|---|---|
classes.scorcher.item | Integer | 369 | id of the item to give the player |
classes.scorcher.chance | Integer | 25 | The chance of the Scorcher setting their target on fire. |
Scout
Configuration | Value | Default | Description |
---|---|---|---|
classes.scout.potion-amplifier | Integer | 2 | Level of speed effect the player gets upon respawning |
Toxic
Configuration | Value | Default | Description |
---|---|---|---|
classes.toxic.potion-amplifier | Integer | 1 | Level of the poison effect. |
classes.toxic.potion-duration | Integer | 10 | Duration (in seconds) the poison effect lasts. |
classes.toxic.potions | Integer | 5 | Amount of poison potions players get upon respawning. |
equipments.yml
Default
Configuration | Value | Description |
---|---|---|
equipments.<name> | String | Changing this will break the plugin. |
equipments.<name>.enabled | Boolean | Whether to enable or disable this equipment. By disabling the equipment, no players will be able to use it and will automatically unequip it when they join. |
equipments.<name>.alias | String | Alias name of the equipment (The name that players will visually see). |
equipments.<name>.description | String | Description of the equipment (Displayed in the shop). |
equipments.<name>.price | Integer | The amount of points required to purchase this equipment. Use -1 to disable purchasing it. |
End Stone Helmet
Configuration | Value | Default | Description |
---|---|---|---|
equipments.endstonehead.potion-amplifier | Integer | 1 | Level of the resistance effect. |
equipments.endstonehead.potion-duration | Integer | 6000 | Duration (in seconds) the resistance effect lasts. |
Glass Helmet
Configuration | Value | Default | Description |
---|---|---|---|
equipments.glasshead.potion-duration | Integer | 6000 | Duration (in seconds) the night vision effect lasts. |
Ice Helmet
Configuration | Value | Default | Description |
---|---|---|---|
equipments.icehead.potion-amplifier | Integer | 1 | Level of the speed effect. |
equipments.icehead.potion-duration | Integer | 6000 | Duration (in seconds) the speed effect lasts. |
Invisibility Perk
Configuration | Value | Default | Description |
---|---|---|---|
equipments.invisibilityperk.potion-duration | Integer | 10 | Duration (in seconds) the invisibility effect lasts. |
Obsidian Helmet
Configuration | Value | Default | Description |
---|---|---|---|
equipments.obsidianhead.resistance-potion-amplifier | Integer | 1 | Level of the resistance effect. |
equipments.obsidianhead.resistance-potion-duration | Integer | 6000 | Duration (in seconds) the resistance effect lasts. |
equipments.obsidianhead.slowness-potion-amplifier | Integer | 1 | Level of the slowness effect. |
equipments.obsidianhead.slowness-potion-duration | Integer | 6000 | Duration (in seconds) the slowness effect lasts. |
Quartz Helmet
Configuration | Value | Default | Description |
---|---|---|---|
equipments.quartzhead.distance | Integer | 30 | Distance when the players' target's compass starts scrambling. |
Sponge Helmet
Configuration | Value | Default | Description |
---|---|---|---|
equipments.spongehead.potion-amplifier | Integer | 1 | Level of the absorption effect. |
equipments.spongehead.potion-duration | Integer | 6000 | Duration (in seconds) the absorption effect lasts. |
TnT Helmet
Configuration | Value | Default | Description |
---|---|---|---|
equipments.tnthead.heal-percentage | Integer | 50 | A percentage of the amount to heal. 0 being none, 100 being all damage. |