что такое bukkit yml
BukkitWiki
This Wiki is home to Bukkit’s documentation and regulations surrounding the Bukkit Project and it’s services. Want to help out? We would love to have you! Signup to get started!
Bukkit.yml/ru
Contents
Разделы YAML
Заголовки, перечисленные ниже, являются ключами верхнего уровня в файле YAML.
settings
Общие параметры сервера CraftBukkit
allow-end
Включен Эндер-Мир. (boolean)
warn-on-overload
Показывает ли сервер «[ПРЕДУПРЕЖДЕНИЕ] Не успевает! Системное время изменилось или сервер перегружен?» Сообщения. (boolean)
permissions-file
Имя файла пользовательских разрешений. (string, filename)
По умолчанию: permissions.yml
update-folder
Имя папки для размещения обновленных плагинов, которая будет перемещена при перезагрузке. (строка, имя папки) ПРИМЕЧАНИЕ: Папка ДОЛЖНА находиться в папке подключаемых модулей. Абсолютные пути НЕ работают.
По умолчанию: update.
ping-packet-limit
В настоящее время нетрудоспособен. Ранее: Максимальное количество пакетов в секунду, которое может использовать список запросов в игре. (целое число, пакеты/сек)
use-exact-login-location
С тех пор как Minecraft добавил возможность выталкивания объектов из блока, игроки часто оказывались выше того места, откуда они вышли при входе в систему (особенно если они находились в пещере). Эта настройка позволяет серверам отключать или включать такое поведение. Если это так, мы будем обходить поведение Ванили, проверяя столкновения и перемещая игрока, если это необходимо, когда он входит в систему. Если сообщение ложное, мы будем продолжать следить за поведением Ванили и перемещать игроков, которые «сталкиваются» с объектами при входе в систему.
По умолчанию: false
world-container
Имя папки, в которой будут храниться все мировые каталоги. Если он не включен в ваш файл, по умолчанию используется текущая рабочая директория. (string, foldername)
plugin-profiling
Позволяет использовать команду /timings. Используется для измерения времени, затрачиваемого модулем на события.
По умолчанию: false
connection-throttle
Задержка перед подключением клиента разрешена после последней попытки подключения. Значение 0 отключает дроссель соединения, но делает ваш сервер уязвимым для атак (рекомендуется только для тестовых серверов). (долго, миллисекунды)
query-plugins
Возвращает ли сервер список подключаемых модулей при удаленном запросе. (boolean)
deprecated-verbose
Показывает ли сервер предупреждения, когда подключаемый модуль регистрирует устаревшее событие. Значение true’/’false’ работает как переключатель для этих предупреждений, в то время как ‘default’ всегда будет показывать предупреждение, если только данное событие не отмечено разработчиком как не требующее предупреждения при регистрации. (строка)
По умолчанию: default
shutdown-message
Это сообщение отображается клиентам, когда сервер останавливается.
По умолчанию: Server closed
spawn-limits
Опции сервера CraftBukkit, которые определяют, сколько животных или толпы может нереститься в мире.
monsters
Этот параметр bukkit.yml позволяет серверам устанавливать количество монстров, которые могут нереститься в мире.
По умолчанию в Minecraft: 70.
animals
Этот параметр bukkit.yml позволяет серверам устанавливать количество животных, которые могут нереститься в мире.
По умолчанию в Minecraft: 15.
water-animals
Этот параметр bukkit.yml позволяет серверам устанавливать количество водных животных, которые могут нереститься в мире.
По умолчанию в Minecraft: 5.
ambient
Этот параметр bukkit.yml позволяет серверам задавать количество окружающих существ (также известный как летучие мыши), которые могут нереститься в мире.
По умолчанию в Minecraft: 15.
Примечание: Мобильные породистые животные или монстры не следуют этим ограничениям. У них есть свои пределы, которым они следуют.
chunk-gc
CraftBukkit проверит на наличие кусков, которые должны были выгрузиться, но по каким-то причинам не смогли сделать этого.
period-in-ticks
Отметки между рассмотрением каждого случая сбора мусора. Если установлено значение 0, блок gc будет отключен.
По умолчанию в Bukkit: 600.
load-threshold
Количество кусков мусора, которые необходимо загрузить с момента последней уборки мусора перед рассмотрением вопроса о вывозе мусора. Если установлено значение 0, блок gc будет отключен.
По умолчанию в Bukkit: 0.
ticks-per
Параметры сервера CraftBukkit, определяющие задержку срабатывания галочки для конкретных функций
animal-spawns
Эта настройка bukkit.yml позволяет серверам устанавливать задержку срабатывания клещей для порождений животных.
Примечание: Если установлено значение 0, нерест животных будет отключен. Вместо этого мы рекомендуем использовать нерестящихся животных для контроля этого.
По умолчанию в Minecraft: 400.
monster-spawns
Эта настройка bukkit.yml позволяет серверам устанавливать задержку срабатывания галочки для порождений монстров.
Примечание: Если установлено значение 0, нерест монстров будет отключен. Вместо этого мы рекомендуем использовать икру монстров для контроля.
По умолчанию в Minecraft: 1.
autosave
Данная настройка bukkit.yml позволяет серверам задавать количество тиков для каждого события сохранения
По умолчанию в Minecraft: 6000.
По умолчанию в Bukkit: 0.
Примечание: На многих серверах Bukkit’а уже установлены плагины автосохранения, которые генерируют все задачи сохранения, поэтому было решено отключить эту функцию в Bukkit’е, поскольку настройка Minecraft’а по умолчанию вызывала значительное отставание у многих серверов, и была признана избыточной. Если вы хотите включить эту функцию, помните, что настройка установлена на один тик и поэтому должна быть установлена на достаточно высокое число (6000 = 5 минут при максимальной эффективности сервера).
auto-updater
Управляет встроенной функцией проверки обновлений.
aliases
Этот раздел позволяет сопоставлять псевдонимы с командами. Пример:
Для получения дополнительной информации о псевдонимах ознакомьтесь с псевдонимами Commands.yml.
database
В этом разделе можно задать различные параметры конфигурации базы данных для базы данных, которые будут совместно использоваться плагинами, использующими внутренний сервер eBeans. Большинство плагинов не используют это, так что, нужно ли вам это настраивать или нет, зависит от вас. Изменение этих свойств изменит способ подключения к базе данных всех плагинов, использующих интегрированный с Bukkit сервер eBeans.
Ниже приведены примеры того, как будет выглядеть каждая конфигурация для двух наиболее часто используемых приложений баз данных.
SQLite Конфигурация (по умолчанию):
Примечание: слова
MySQL Пример конфигурации:
Примечание:
*OPTIONAL* worlds
В этом разделе вы можете определить генераторы для миров, которые по умолчанию загружаются из bukkit».
Prereqs: Вы ДОЛЖНЫ уже установить генератор, а разработчик генератора должен вставить <<
BukkitWiki
This Wiki is home to Bukkit’s documentation and regulations surrounding the Bukkit Project and it’s services. Want to help out? We would love to have you! Signup to get started!
Bukkit.yml
This page has been marked for inclusion in the Bukkit Official Documentation section, Docs. You can deliberate about its inclusion on its Talk page.
Bukkit.yml is a file that provides you with a wide variety of options for configuring your CraftBukkit server.
Contents
Sections in the YAML
The headings listed below are the top-level keys in the YAML file.
settings
General CraftBukkit server options.
allow-end
Is the End enabled. (boolean)
warn-on-overload
Does the server show «[WARNING] Can’t keep up! Did the system time change, or is the server overloaded?» messages. (boolean)
permissions-file
The name of your custom permissions file. (string, filename)
update-folder
The name of the folder to put updated plugins in, which will be moved upon restart. (string, foldername) NOTE: The folder MUST be in the plugins folder. Absolute paths do NOT work.
ping-packet-limit
Currently disabled. Previously: How many packets a second the ingame ping list can use, maximum. (integer, packets/sec)
use-exact-login-location
Since Minecraft added the feature of pushing entities out whenever they are stuck inside a block, players have often found themselves above the location they logged out of when logging back in (especially if they were in a cave). This setting allows servers to disable or enable this behavior. If true, we will bypass Vanilla’s behaviour of checking for collisions and moving the player if needed when they login. If false, we will continue to follow Vanilla’s behaviour and move players that ‘collide’ with objects when they login.
world-container
The name of a folder to store all the world directories in. If not included in your file, defaults to the current working directory. (string, foldername)
plugin-profiling
Allows the use of the command /timings. Used to measure time taken by plugin for events.
connection-throttle
The delay before a client is allowed to connect again after a recent connection attempt. A value of 0 disables the connection throttle but leaves your server susceptible to attacks (only recommended for test servers). (long, milliseconds)
query-plugins
Does the server return the list of plugins when queried remotely. (boolean)
deprecated-verbose
Does the server show warnings when a plugin registers a deprecated event. A ‘true’/’false’ value works as a toggle for these warnings, while ‘default’ will always show a warning unless the event in question has been tagged by a developer as not requiring a warning when it is registered. (string)
shutdown-message
This is the message displayed to clients when the server stops
Default: Server closed
spawn-limits
CraftBukkit server options that determine how many animals or mobs can spawn per-world.
monsters
This bukkit.yml setting allows servers to set the amount of monsters that can spawn per-world.
Minecraft default: 70.
animals
This bukkit.yml setting allows servers to set the amount of animals that can spawn per-world.
Minecraft default: 15.
water-animals
This bukkit.yml setting allows servers to set the amount of water animals that can spawn per-world.
Minecraft default: 5.
ambient
This bukkit.yml setting allows servers to set the amount of ambient creatures (aka, bats) that can spawn per-world.
Minecraft default: 15.
Note: Mob spawned animals or monsters do not follow these limits. They have their own limits they follow.
chunk-gc
CraftBukkit will check for chunks that should have been unloaded but for some reason failed to do so.
period-in-ticks
The ticks between each chunk garbage collection consideration. If set to 0, chunk gc will be disabled.
Bukkit default: 600.
load-threshold
Number of chunks that need to be loaded since the last garbage collection before considering garbage collection. If set to 0, chunk gc will be disabled.
ticks-per
CraftBukkit server options that determine the tick delay for specific features
animal-spawns
This bukkit.yml setting allows servers to set the tick delay for animal spawns.
Note: If set to 0, animals spawning will be disabled. We recommend using spawn-animals to control this instead.
Minecraft default: 400.
monster-spawns
This bukkit.yml setting allows servers to set the tick delay for monster spawns.
Note: If set to 0, monsters spawning will be disabled. We recommend using spawn-monsters to control this instead.
Minecraft default: 1.
autosave
This bukkit.yml setting allows servers to set the number of ticks for each save-all event.
Minecraft default: 6000.
Note: Many Bukkit servers already run autosave plugins which generate save-all tasks, thus it was decided to disable this feature in Bukkit, as the Minecraft default setting was causing a lot of lag for many servers, and was found redundant. If you wish to enable this, remember the setting is per tick, and thus should be set to a reasonably high number (6000 = 5 minutes at peak server efficiency).
auto-updater
Controls the built in update checker.
aliases
NOTE: In the latest versions, aliases have been moved to the commands.yml file.
This section allows you to map aliases to commands. Example:
database
This section lets you set various database-related configuration options, for the database which will be shared by plugins that use the internal eBeans server. Most plugins do not use this, so whether or not you need to configure it is up to you. Changing these properties will change how all plugins that use the eBeans server integrated with Bukkit connect to their database.
The following are examples of what each configuration would look like for the two most commonly used database applications.
SQLite Configuration (default):
Note: the
MySQL Configuration example:
Note:
*OPTIONAL* worlds
This section lets you define the generators for the worlds that bukkit loads by default.
Configuring Bukkit’s bukkit.yml Quick and Easy for 1.17
Bukkit is a Mod for Minecraft that provides a plugin API for the Minecraft Server that came out in 2011. It provides an easy way to customize the Vanilla experience, allowing you to install plugins that can change every bit of the server. While previously being maintained at https://bukkit.org, the project is now primarily maintained by SpigotMC.
Configuring Bukkit can be a little difficult, so here’s a full breakdown of configuring the bukkit.yml that’s generated by default when you run Bukkit.
Quick Definitions:
settings
This section is used to define generic settings that the Minecraft Server will follow. None of these settings will improve performance, and are just configuration for Bukkit.
settings.allow-end (default: true )
settings.warn-on-overload (default: true )
This configuration option is added by Bukkit to alert you when your server is running behind. It will send a message that looks like:
settings.permission-file (default: permissions.yml )
This setting sets the default permission file, which is generally used to group permission nodes together. We’re not going to go in-depth on the file format here, but you can find the Bukkit Wiki article here.
settings.update-folder (default: update )
settings.plugin-profiling (default: false )
settings.connection-throttle (default: 4000 )
settings.query-plugins (default: true )
This option is used when the Minecraft Server is asked about what plugins it has installed in two different spots:
settings.deprecated-verbose (default: default )
This option is used in several places regarding whether the server will report on a plugin doing deprecated actions. It should be left to default unless you have a reason to use it in another mode ( off / on ).
settings.shutdown-message (default: Server closed )
settings.minimum-api (default: none )
spawn-limits
This section is used to define how many of each entity type can spawn in the world. This can be used to improve performance a lot, especially because ambient (bats) and water-animals/water-ambient mobs do not need as high of a count as these defaults. Reducing these values can reduce the amount of entities that are attempted to be spawned, improving performance.
chunk-gc
The chunk-gc.period-in-ticks allows you to configure how long a chunk loaded by a plugin stays loaded. Generally this shouldn’t need to be changed.
ticks-per
This section is used to define how often certain systems in the game get ticked. It can be used to tune your server performance, specifically reducing how much mob spawning hurts the performance.
These settings have a few possible options for configuration.
ticks-per.autosave (default: 6000 )
Bukkit allows you here to configure how often the worlds and player data is saved. You should set this value as high as you can tolerate data loss, which the default 5 minute ( 6000 ticks ) is generally a good default for this.
If for some reason you’d like to not save this data, you can set it to 0 to disable the autosave.
aliases
Finishing Up
If you’d like to read more articles about configuring and optimizing your 1.17 Minecraft Server, they’re coming soon!
BukkitWiki
This Wiki is home to Bukkit’s documentation and regulations surrounding the Bukkit Project and it’s services. Want to help out? We would love to have you! Signup to get started!
Commands.yml
commands.yml is a configuration file that houses custom defined aliases and command block overrides for your CraftBukkit server.
The command block override system provides a quick and easy way to force the server to use the commands provided by Mojang (as opposed to the ones built into Bukkit) for command blocks specifically, leaving all other commands untouched. While the aliases system, essentially, gives power user server admins the ability to define custom commands and force specific versions of a command to be used for the default commands.
Out of the box, Bukkit provides a useful fallback system for commands that has the following priorities:
On top of this, we provide untouchable ultimate fallbacks for every command which can be used by users or the Aliases system to use specific versions of a command:
Type | Fallback | Example |
---|---|---|
Plugin Commands | pluginname:command | /scrapbukkit:time |
Bukkit Commands | bukkit:command | /bukkit:time |
Mojang Commands | minecraft:command | /minecraft:time |
Of course, for each fallback we also provide permissions to allow you to control access to each command (except for Plugin Commands which depend on the plugin’s handling of permissions):
Type | Permission | Example |
---|---|---|
Plugin Commands | Plugins provide their own system that you’ll have to educate yourself on | N/A |
Bukkit Commands | bukkit.command.* (List of Bukkit permissions) | bukkit.command.give |
Mojang Commands | minecraft.command.* (List of Mojang permissions) | minecraft.command.give |
Contents
Default commands.yml
command-block-overrides
This section of the commands.yml controls what is known as the command block overrides feature. Since Bukkit has historically provided its own version of some Minecraft commands, we’ve added the ability to force the server to use the Mojang provided version for command blocks specifically. Commands used outside of command blocks will use the Bukkit (or plugin) version as usual.
Note: Since Bukkit has no control over the Mojang version of a command, we cannot guarantee that they will work as expected.
If the custom map you’re running uses the /summon and /give commands, you probably want to enable command block overrides for them. To do this, you simply add them to the command-block-overrides list and your commands.yml would look something like this:
If, on the other hand, the custom map uses most of the Minecraft commands, you can also easily enable command block overrides for all valid commands by using a *, like so:
aliases
This section of the commands.yml allows you to define custom aliases for commands on your server. At its core, an alias allows you to create custom commands that can perform multiple functions at once. This is a powerful tool that allows you to define easier to remember commands for your server staff.
Alongside letting you redefine commands, the Aliases System provides extra useful features that allow you to create some powerful custom commands for you server:
Alias Examples
Add an alternative way to run the /version command
In this example we’re registering an alias called «icanhasbukkit» which will execute the version command when used.
Removing a command
In this example we’re registering an alias called ‘summon’ that is mapped to nothing. By doing this, we are telling the server to unregister the command and, as a result, prevent it from existing/functioning.
Note: If you are looking to prevent people from using a command, you should remove their permission to use the command instead of removing it with an alias.
Rename the /version command
In this example we’re registering an alias called «icanhasversion» which will execute the version command when used and creating an alias called «version» that is mapped to nothing to remove it.
Note: If you are looking to prevent people from using a command, you should remove their permission to use the command instead of removing it with an alias.
Requiring a parameter
In this example we’re creating an alias called ‘givedirt’ that requires providing an argument (in this case a player’s name) before the alias will successfully run.
Running multiple commands
In this example we’re creating an alias called ‘givedirtmsg’ which will execute two commands that require an argument before the alias will successfully run.
Using a command supplied by a plugin
In this example we’re overriding the built in /time command to use the version supplied by the plugin ScrapBukkit instead.
Using a command supplied by Mojang
In this example we’re overriding the built in /time command to use the version supplied by Mojang instead.
Using a command supplied by Bukkit
In this example we’re overriding the built in /time command to use the version supplied by Bukkit instead.
Accepting all parameters
In this example we’re creating an alias called ‘broadcast’ that will execute the ‘say’ command and accept any arguments passed to it.
Requiring the first parameter while keeping the second optional
In this example we’re overriding the built in ‘ban’ command. This alias will require the first argument (which in this case is a player’s name) while providing support for an optional ban reason. When the alias is used, the player will be banned and a /say message will be broadcasted, informing the people on the server that someone has been banned.