Configuration
The configuration is stored in plugins/Checkers/config.yml under your Bukkit folder. It is a YAML file with simple key/value pairs.
You can edit this file directly if you wish, but it is recommended to use /checkers setcfg <key> <value> to make changes. If you do edit it directly, use /checkers reload config immediately to reload your changes, to avoid them being overwritten.
To view settings, use /checkers getcfg to see all settings, or /checkers getcfg <key> to view a specific item.
For descriptions of those settings of type "effect" and "duration", see the Effects and Duration Specifiers sections at the end of this page.
Settings
The settings are:
| Setting | Type | Default | Description |
|---|---|---|---|
| ai.min_move_wait | duration spec. | 3 seconds | The AI will not move more quickly than this. You can set this to 0, but (particularly on easier settings), the AI may appear to move disconcertingly quickly. |
| ai.max_ai_games | integer | 3 | This is the maximum number of concurrent AI games that can be created. You may wish to raise or lower this, depending on the power of your server CPU, and the typical number of players on your server. |
| ai.name_format | string | "[AI]<NAME>" | For display purposes, all AI pseudo-players will have their name formatted with this string. <NAME> will be replaced with the AI's internal name. |
| auto_delete.finished | duration spec. | 30 seconds | This is time from the end of a game to when it will be automatically deleted, freeing up its board for a new game. This gives players time to write a PGN archive of the game if they wish. |
| auto_delete.not_started | duration spec. | 180 seconds | If a game is created, but not started within this time, it will be automatically deleted. This prevents the problem of people creating games and going away or logging off, leaving the board unusable for anyone else. |
| auto_delete.running | duration spec. | 1 week | If a running game has had no moves made within this time, it will be automatically deleted. This can be disabled by setting to 0. |
| auto_teleport_on_join | boolean | true | When you create a game or join a game (accept an invitation), you will be automatically teleported to the board (if not already there). |
| auto_teleport_on_start | boolean | true | When a game is started, both players will be auto-teleported to the board (if they're not already there). |
| autostart | boolean | true | When set to true, games are automatically started as soon as two players have joined. When false, you will need to type /checkers start or use the Start Game button on the control panel to start. |
| broadcast_results | boolean | true | If true, then the results of all games will be broadcast to the entire server. If false, then only the game's players will be notified. |
| coloured_console | boolean | true | If true, all command output to the console will be coloured, same as output to players. You may wish to set this to false if your console does not have good ANSI colour support, or if you simply prefer less colour in your console! |
| default_rules.8 | String | EnglishDraughts | The default rule set for 8x8 boards |
| default_rules.10 | String | InternationalDraughts | The default rule set for 10x10 boards |
| default_rules.12 | String | CanadianCheckers | The default rule set for 12x12 boards |
| dynmap.enabled | boolean | true | If false, then no dynmap layer markers will be added at all |
| dynmap.hide_by_default | boolean | false | If true, then the "Checkers Boards" layer will be hidden on startup |
| dynmap.layer_priority | integer | 0 | Layer ordering priority for the "Checkers Boards" layer - lower comes first |
| dynmap.min_zoom | integer, 0..6 | 0 | If non-zero, then checkers board markers will only be displayed when the map zoom to at least the given level |
| effects.game_lost | effect | sound,name=enderman_death | The effect to play when a player loses a game |
| effects.game_won | effect | sound,name=level_up | The effect to play when a player wins a game |
| effects.piece_selected | effect | sound,name=note_sticks | The effect to play when a piece is selected by a player |
| effects.piece_unselected | effect | sound,name=note_bass | The effect to play when a piece is unselected by a player |
| effects.piece_captured | effect | explosion | The effect to play when a piece is captured |
| effects.piece_moved | effect | sound,name=item_pickup | The effect to play when a piece is captured |
| effects.piece_riding | boolean | true | If true, any players standing on a piece that is moved will be moved with the piece |
| effects.teleport_out | effect | effect,name=smoke,data=4 | The effect to play where a player leaves when teleporting around a board |
| effects.teleport_in | effect | effect,name=ender_signal | The effect to play where a player arrives when teleporting around a board |
| effects.volume | float | 1.0 | The master volume for all sound effects |
| flying.allowed | boolean | true | Globally enables or disables board flight for all players. |
| flying.captive | boolean | true | If true, flying players will not be allowed to move too far from boards (they will need to switch off flying first). If false, players can move away but flight will be auto-disabled when they move too far from a board (players won't take fall damage). This only applies to boards with an open style. |
| flying.auto | boolean | false | If true, then players will be immediately set to flying when they get close enough to a board. If false, players need to double-tap Space to start flying. |
| flying.upper_limit | integer | 50 | The maximum vertical distance above a board (as a percentage of the board's height, but not less than 5 blocks) that flight is permitted. This only applies to boards with an open style. |
| flying.outer_limit | integer | 25 | The maximum horizontal distance outside a board (as a percentage of the board's width, but not less than 5 blocks) that flight is permitted. This only applies to boards with an open style. |
| flying.fly_speed | float | 0.2 | Flight speed while flying around a board. This overrides the player's default flight speed, which will be restored when the player is not on/near a board. Valid values are from 0.0 to 1.0 |
| flying.walk_speed | float | 0.2 | Walking speed while walking around a board. This overrides the player's default walkiong speed, which will be restored when the player is not on/near a board. Valid values are from 0.0 to 1.0. (While this is not really flying-related, it's closely related and handled by the same code, so it's in the flying category). |
| forced_jump | boolean | true | Define a global default for the forced-jump rule (if you can make a jump, you must) for newly created games. This may be overridden on a per-game basis with the /chc forcejump command |
| forfeit_timeout | duration spec. | 60 seconds | If a player logs out while in a game (or games), their opponent(s) may claim victory after this many seconds by typing /checkers win. If the player logs back in before the timeout expires, the timeout is reset. If timeout_forfeit is set to 0, then /checkers win cannot be used. |
| open_invite_cooldown | duration spec. | 1 min 30 sec | Players must wait this long before re-sending an open invitation to their game (which broadcasts to the server). The default for this is the same as for auto_delete.not_started, meaning only one open invitation may be created per game by default. |
| pager.lines | int | 0 | The number of lines to page for large blocks of text output (e.g. the output of /checkers list ... commands). The default of 0 disables paging. It is easy to scrollback with the mouse wheel when the chat window is open, so you may wish to leave this as 0. |
| protection.no_building | boolean | true | Prevents any part of the boards from being broken or built upon. This also prevents board blocks being insta-broken if you left-click them while in creative mode (Minecraft 1.8+) |
| protection.no_burning | boolean | true | Prevent any part of the board from being burnt. |
| protection.no_creatures | boolean | true | Prevent any creatures from spawning on the boards. |
| protection.no_explosions | boolean | true | Prevents explosions (creepers & TNT) from damaging any part of the boards. Players will still be injured by explosions, however. |
| protection.no_misc_damage | boolean | true | Prevents all miscellaneous damage (falling, cactus...) while standing on a board. |
| protection.no_monster_attacks | boolean | true | Prevents any monster attacks while standing on a board (any monster which targets you will be removed - no loot drop). |
| protection.no_pvp | boolean | true | Prevents all player vs. player combat if either player is standing on a board. |
| stake.default | float | 0.00 | This is default stake that all new games will have (Economy support only). |
| stake.max | float | -1.00 | The maximum stake that players are allowed to bet on a game. A negative value means 'no maximum'. May be useful to limit the profits a strong checkers player can make by playing the AI with a huge stake. (Economy support only). |
| stake.large_increment | float | 10.00 | When using the control panel to adjust the stake for a game (Economy support only), this is the default increment to add/subtract to the stake, when the player is not sneaking (holding Shift). |
| stake.small_increment | float | 1.00 | When using the control panel to adjust the stake for a game (Economy support only), this is the default increment to add/subtract to the stake, when the player is sneaking (holding Shift). |
| teleporting | boolean | true | If false, any teleporting between boards (using the "Teleport Out" button or /checkers tp command) will be disabled. Teleporting around a board is not affected by this. |
| time_control.default | string | none | This is the default time control that will be used for all games that are created. |
| time_control.warn_seconds | integer | 30 seconds | Players will be warned periodically if they have less than this amount of time to make a move. The warning timer halves each time the player is warned, so with a warning timer of 30, players get warned 30 -> 15 -> 7 -> 3 -> 1 seconds before their timer expires and they forfeit the game. |
| wand_item | material spec. | * | You must be holding this item in your hand to move pieces by waving at them ("air" means empty-handed). You can also use "*" to allow any item to be held. |
Duration Specifiers
Valid duration specifications in the table below are:
| unit | examples |
|---|---|
| ms, milliseconds | 100 ms |
| s, seconds | 3 s, 3 seconds |
| m, minutes | 2 m, 2 minutes |
| h, hours | 1 h 30 m, 1 hour 30 minutes |
| d, days | 2 d, 2 days |
| w, weeks | 4 w 2 d 3 h, 4 weeks 2 days 3 hours |
Effects
As of v2.0.0, several settings allow you to define special effects, either sounds or visual, which are played when a particular event occurs. See the entries in Settings under effects for a list of those settings and their defaults. The format for specifying an effect is:
<effect-type>,<key>=<value>[,<key>=<value>...]
All effects start with effect type, followed by a command, followed by one or more key/value pairs. The valid effect types are:
- sound: Play a sound that the client knows about.
- effect: Play an effect which may be visual, audible, or both. E.g. puff of smoke, portal particles...
- explosion: Play an explosion effect (or even a real explosion!)
- lightning: Play a lightning effect (or even a real lightning strike!)
The valid parameters are:
| Parameter name | Type | Use with | Description |
|---|---|---|---|
| volume | float | sound | Specifies the volume of the sound, default 1.0 |
| pitch | float | sound | Specifies the pitch of the sound, default 1.0 (valid range appears to be 0..3) |
| name | string | sound, effect | Specifies the Bukkit sound or effect name to play. See http://jd.bukkit.org/apidocs/org/bukkit/Sound.html for a list of valid sounds, and http://jd.bukkit.org/apidocs/org/bukkit/Effect.html for a list of valid effects (you may use upper or lower case). |
| data | int | effect | Effect-specific data. Not all effects needs this. For SMOKE, it gives the smoke direction (4 is straight up) |
| radius | int | effect | The radius of the effect. Players must be within this radius to see/hear the effect. Default: 64 |
| power | float | explosion, lightning | The power of an explosion or lightning strike. Any value above 0 means a real explosion or strike (for lightning, all non-zero values are equivalent). Default: 0 |
| fire | boolean | explosion | If true, explosions will also cause fires. Default: false |
Comments