Configuration
Homerun's configuration file can be found in the plugins/Homerun/config.yml file. The configuration file is in YAML
format, and is automatically generated with all default values when you first run the plugin. You can edit the
configuration file while the server is running, but you will need to run /homerun reload for the changes to take
effect.
Reset rules
Homerun allows you to have multiple reset rules in the configuration file. A "reset rule" defines when and how a
world should be reset. Each reset rule can be given a unique name, which also lets you run the rule at any time using
the /homerun reset <name> command. These all live under the reset_rule top level key.
# This defines a set of reset rules. A "reset rule" is a specific
# set of conditions that, when met, will cause chunks to be reset.
# The conditions and the reset parameters are both configurable.
# ALL conditions must be met for a reset to occur.
reset_rules:
- name: default
enabled: true
# ...
Reset rules have two primary components: the reset conditions and reset parameters. Optionally, you can also have borders and warnings which gives players an indication of where or when a reset will happen.
Tick period
Homerun normally runs all of its checking per tick. If this is a problem for you, or if you're working with a server
that doesn't have a lot of resources, you can sacrifice accuracy and save processing time by increasing Homerun's
tick period. It's recommended that you keep this at 1 unless you know what you're doing.
tick_period: 1
Schema
The following is a technical view of the configuration file. You can find all the details for every part of the configuration file here.