bentobox/src/main/resources/config.yml

106 lines
5.1 KiB
YAML
Raw Normal View History

2019-06-21 18:46:17 +02:00
# BentoBox Configuration 1.5.3
2019-02-22 11:25:39 +01:00
# This config file is dynamic and is updated right after BentoBox loaded its settings from it.
# You can edit it while the server is online and you can do '/bbox reload' to take the changes into account.
# However, it is a better practice to edit this file while the server is offline.
general:
# Default language for new players.
# This is the filename in the locale folder without .yml.
# If this does not exist, the default en-US will be used.
default-language: en-US
# Use economy or not. If true, an economy plugin is required. If false, no money is used or give.
# If there is no economy plugin present anyway, money will be automatically disabled.
use-economy: true
database:
# JSON, MYSQL, MARIADB (10.2.3+), MONGODB, SQLITE and YAML(deprecated).
Database transition (#662) - JSON is now the default database type - JSON database files are now pretty-printed - It is now possible to migrate from a database type to another through the use of a command and specific transition database types - It is recommended to move from YAML to JSON. = Commits breakdown = * Proposal to make JSON the default database and retire YAML. * Make JSON file format easier to read. * Fix tests. * Adds a hybrid Yaml2Json database type. This database always tries to use JSON if it is available. If a YAML file is found, it will be loaded and replaced with a JSON file. * Move to generic database transition code * Better comments * Adds transitional database options so admins can choose. Adds Yaml2MySQL option and changes config.yml to add instructions. * Enables full database migration between databases. Adds /bbox migrate command. Adds a number of transition databases. DB starts transition when the server boots up and will migrate organically. The admin can force an immediate update using the bbox migrate command. This operation requires an API breaking change: Addons that use the Config API must now implement ConfigObject in their config class instead of DataObject. This is to differentiate YAML config classes from YAML database classes. If a class is already implements WorldSettings (GameModeAddons), then no change is required because WorldSettings implements ConfigObject now. If an old addon is used that does not implement ConfigObject, BentoBox will not load. * Added null check to YAML deletion * Removed the 2YAML transition dbs because YAML is deprecated. YAML does not support some data structures so conversion could corrupt data. * Fixed some javadoc and added missing DatabaseType#JSON2MARIADB * Renamed package database/transitiondb to database/transition
2019-05-08 21:15:22 +02:00
# Transition database options are:
# YAML2JSON, YAML2MARIADB, YAML2MYSQL, YAML2MONGODB, YAML2SQLITE
# JSON2MARIADB, JSON2MYSQL, JSON2MONGODB, JSON2SQLITE
# MYSQL2JSON, MARIADB2JSON, MONGODB2JSON, SQLITE2JSON
2019-06-09 09:37:46 +02:00
# If you need others, please make a feature request.
Database transition (#662) - JSON is now the default database type - JSON database files are now pretty-printed - It is now possible to migrate from a database type to another through the use of a command and specific transition database types - It is recommended to move from YAML to JSON. = Commits breakdown = * Proposal to make JSON the default database and retire YAML. * Make JSON file format easier to read. * Fix tests. * Adds a hybrid Yaml2Json database type. This database always tries to use JSON if it is available. If a YAML file is found, it will be loaded and replaced with a JSON file. * Move to generic database transition code * Better comments * Adds transitional database options so admins can choose. Adds Yaml2MySQL option and changes config.yml to add instructions. * Enables full database migration between databases. Adds /bbox migrate command. Adds a number of transition databases. DB starts transition when the server boots up and will migrate organically. The admin can force an immediate update using the bbox migrate command. This operation requires an API breaking change: Addons that use the Config API must now implement ConfigObject in their config class instead of DataObject. This is to differentiate YAML config classes from YAML database classes. If a class is already implements WorldSettings (GameModeAddons), then no change is required because WorldSettings implements ConfigObject now. If an old addon is used that does not implement ConfigObject, BentoBox will not load. * Added null check to YAML deletion * Removed the 2YAML transition dbs because YAML is deprecated. YAML does not support some data structures so conversion could corrupt data. * Fixed some javadoc and added missing DatabaseType#JSON2MARIADB * Renamed package database/transitiondb to database/transition
2019-05-08 21:15:22 +02:00
# Transition options enable migration from one database type to another. Use /bbox migrate.
2019-06-09 09:37:46 +02:00
# YAML and JSON are file-based databases.
2019-01-20 10:10:29 +01:00
# MYSQL might not work with all implementations: if available, use a dedicated database type (e.g. MARIADB).
2019-01-01 21:00:21 +01:00
# If you use MONGODB, you must also run the BSBMongo plugin (not addon).
2018-10-30 17:59:11 +01:00
# See https://github.com/tastybento/bsbMongo/releases/.
2019-06-21 18:46:17 +02:00
# You can find more details in this video: https://youtu.be/FFzCk5-y7-g
Database transition (#662) - JSON is now the default database type - JSON database files are now pretty-printed - It is now possible to migrate from a database type to another through the use of a command and specific transition database types - It is recommended to move from YAML to JSON. = Commits breakdown = * Proposal to make JSON the default database and retire YAML. * Make JSON file format easier to read. * Fix tests. * Adds a hybrid Yaml2Json database type. This database always tries to use JSON if it is available. If a YAML file is found, it will be loaded and replaced with a JSON file. * Move to generic database transition code * Better comments * Adds transitional database options so admins can choose. Adds Yaml2MySQL option and changes config.yml to add instructions. * Enables full database migration between databases. Adds /bbox migrate command. Adds a number of transition databases. DB starts transition when the server boots up and will migrate organically. The admin can force an immediate update using the bbox migrate command. This operation requires an API breaking change: Addons that use the Config API must now implement ConfigObject in their config class instead of DataObject. This is to differentiate YAML config classes from YAML database classes. If a class is already implements WorldSettings (GameModeAddons), then no change is required because WorldSettings implements ConfigObject now. If an old addon is used that does not implement ConfigObject, BentoBox will not load. * Added null check to YAML deletion * Removed the 2YAML transition dbs because YAML is deprecated. YAML does not support some data structures so conversion could corrupt data. * Fixed some javadoc and added missing DatabaseType#JSON2MARIADB * Renamed package database/transitiondb to database/transition
2019-05-08 21:15:22 +02:00
type: JSON
host: localhost
# Port 3306 is MySQL's default. Port 27017 is MongoDB's default.
2017-07-08 02:12:14 +02:00
port: 3306
name: bentobox
2017-07-08 02:12:14 +02:00
username: username
password: password
# How often the data will be saved to file in mins. Default is 5 minutes.
# This helps prevent issues if the server crashes.
# Data is also saved at important points in the game.
backup-period: 5
# Allow FTB Autonomous Activator to work (will allow a pseudo player [CoFH] to place and break blocks and hang items)
# Add other fake player names here if required
2018-10-30 17:59:11 +01:00
# /!\ This feature is experimental and might not work as expected or might not work at all.
fakeplayers:
- '[CoFH]'
2018-07-29 22:21:46 +02:00
panel:
close-on-click-outside: true
2019-01-27 10:24:01 +01:00
logs:
# Toggle whether superflat chunks regeneration should be logged in the server logs or not.
# It can be spammy if there are a lot of superflat chunks to regenerate.
# However, as superflat chunks regeneration can be performance-intensive, it is recommended to keep
# this setting set to true, as it will help you know if there are regenerations taking place.
2019-02-22 11:25:39 +01:00
# Added since 1.2.0.
2019-01-27 10:24:01 +01:00
clean-super-flat-chunks: true
2019-06-09 09:37:46 +02:00
# Toggle whether downloading data from GitHub should be logged in the server logs or not.
# Added since 1.5.0.
github-download-data: true
island:
2018-10-25 10:30:27 +02:00
cooldown:
2019-01-27 10:24:01 +01:00
time:
# How long a player must wait until they can rejoin a team island after being kicked in minutes.
# This slows the effectiveness of players repeating challenges
# by repetitively being invited to a team island.
invite: 60
# How long a player must wait until they can coop a player in minutes.
coop: 5
# How long a player must wait until they can trust a player in minutes.
trust: 5
# How long a player must wait until they can ban a player after unbanning them. In minutes.
ban: 10
# How long a player must wait before they can reset their island again in seconds.
reset: 300
options:
# Whether the reset cooldown should be applied when the player creates an island for the first time or not.
2019-02-22 11:25:39 +01:00
# Added since 1.2.0.
2019-01-27 10:24:01 +01:00
set-reset-cooldown-on-create: true
2018-10-25 10:30:27 +02:00
confirmation:
2019-01-27 10:24:01 +01:00
# Time in seconds that players have to confirm sensitive commands, e.g. island reset.
2018-10-25 10:30:27 +02:00
time: 10
commands:
# Ask the player to confirm the command he is using by typing it again.
kick: true
leave: true
reset: true
2018-07-29 22:21:46 +02:00
name:
# These set the minimum and maximum size of a name.
min-length: 4
max-length: 20
Implemeted Blueprint bundles and blueprints (#672) * A prototype for Blueprint bundles and blueprints This stores blueprints inside bundles. Each bundle can have up to 3 blueprints defines by the World.Environment. This is not a finished manager. It just handles all the saving and loading side of things. I thought this would help you so you can then concentrate on the UI. * WIP: Copy blocks to Blueprint done. * WIP Pasting done. * WIP: Added BlueprintsManager to ultimately replace SchemsManager. * Moved blueprint suffix and changed to .blu * Fixed unit test. * Now tested and working. Integrated with new island and resetting island. If there are no blueprint bundles or blueprints then a default bedrock set will be made and put in the game mode addon's blueprints folder. Still to do: enable schems to be loaded and pasted for legacy support. Add blueprints and a bundle to GameModeAddons like BSkyBlock. * Renamed most of the classes * Cleaned up clipboard and paster. * Further cleanup on blueprint clipboard and paster. * Merged blueprint classes into one package. * Put Blueprint data objects in their own package. Isolated schems classes for later removal. * Renamed admin command classes and changed locale files. * More clean up to remove schems * Schem to blueprints converter done. Converts schems to blueprint bundles and sets up a default set. Tested the happy-path. Need to do more testing on edge cases. * Added basic UI for development. Fixed bug with schem conversion. * Adds permissions into the blueprints. Fixes tests, cleans up some naming * Added IslandCreationPanel and created BlueprintManagementPanel * Fixed JSONDatabaseHandler's constructor being public * Made the Blueprints button in ManagementPanel open the Blueprint management panel * Fixed tests and ignored one (NPE)
2019-05-15 20:16:41 +02:00
# Number of blocks to paste per tick when pasting blueprints
# Smaller values will help reduce noticeable lag but will make pasting take longer
paste-speed: 1000
2019-02-22 11:25:39 +01:00
web:
# BentoBox uses bStats.org to get global data about the plugin to help improving it.
# bStats has nearly no effect on your server's performance and the sent data is completely
# anonymous so please consider twice if you really want to disable it.
metrics: true
github:
# Toggle whether BentoBox can connect to GitHub to get data about updates and addons.
# Disabling this will result in the deactivation of the update checker and of some other
# features that rely on the data downloaded from the GitHub API.
# It does not send any data.
# Added since 1.5.0.
download-data: true
# Time in minutes between each connection to the GitHub API.
# This allows for up-to-the-minute information gathering.
2019-06-09 09:37:46 +02:00
# However, as the GitHub API data does not get updated instantly, this value cannot be set less than 15 minutes.
# Setting this to 0 will make BentoBox download data only at startup.
# Added since 1.5.0.
2019-06-16 11:24:27 +02:00
connection-interval: 60