Configfile

Configuration File

The configuration is stored in plugins/ChessCraft/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 /chess setcfg <item> <value> to make changes. If you do edit it directly, use /chess reload immediately to reload your changes.

To view settings, use /chess getcfg to see all settings, or /chess getcfg <item> to view a specific item.

The settings are:

auto_delete_finished

Default: 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_teleport_on_join

Default: true. When you join a game (accept an invitation), you will be automatically teleported to the chessboard.

autosave

Default: true. If true, ChessCraft state will be saved to disk whenever necessary, i.e. when a board is created or destroyed, a game is created or ends, game state changes (move made, etc.). If false, state is only saved when the server shuts down or reloads, or someone does a /chess save. It is recommended to leave this as true to avoid loss of data.

broadcast_results

If true (the default), then the results of all games will be broadcast to the entire server. If false, then only the game's players will be notified.

forfeit_timeout

Default: 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 /chess win. If the player logs back in before the timeout expires, the timeout is reset. If forfeit_timeout is set to 0, then /chess win cannot be used.

no_building

Default: true. Prevents any part of the boards from being broken or built upon.

no_burning

Default: true. Prevent any part of the board from being burnt.

no_creatures

Default: true. Prevent any creatures from spawning on the boards.

no_explosions

Default: true. Prevents explosions (creepers & TNT) from damaging any part of the boards. Players will still be injured by explosions, however.

tick_interval

Default: 1 second. ChessCraft will carry out some general tasks this often - periodically checking the light level of all boards and turn some squares into glowstone if necessary to ensure the board is bright enough, and also updating chess clocks for games in progress.

wand_item

Default: air. You must be holding this item in your hand to move chess pieces by waving at them ("air" means empty-handed).