Skip to content

Server Config

Marcel Bartholet edited this page Apr 28, 2024 · 14 revisions

Overview

Since YAWP is a server-side mod, the config for it is found in the directory /serverconfig in the minecraft world directory.

config-location

The configuration is split in different files, covering different topics.

  • yawp-common.toml - config for command permissions
  • yawp-flags.toml - config for specific flags, which are not covered in-game yet
  • yawp-region-defaults - config for default region properties when creating new regions

Common config

  • command_op_level - This controls the OP level which is required to execute the mods commands. Range 0-5, defaults to 4. 0 allows for all players to use the commands, 1-4 needs the corresponding OP level and 5 prevents all operators from using the commands (so only players from the list players_with_permission or the server console can use commands for every region).

    • Example: command_op_level = 4
  • players_with_permission - This is a list of player UUIDs for players which have the permission to use the mods commands regardless of their OP level. You need to provide the full UUID, not the trimmed version. See: How to get your UUID.

    • Example: players_with_permission = ["614c9eac-11c9-3ca6-b697-938355fa8235", "b9f5e998-520a-3fa2-8208-0c20f22aa20f"]
    • Example: players_with_permission = ["614c9eac-11c9-3ca6-b697-938355fa8235"]
  • command_block_execution - This toggles whether command blocks are allowed to execute the mods commands. Note for this to work the command_op_level additionally needs to be 2 or higher and command blocks needs to be enabled in the server.properties file.

    • Example: command_block_execution = true
  • allow_info_cmds- This decides whether all players are allowed to use commands to display information about regions. This includes listing players, flags, state, etc.

    • Example: allow_info_cmds = true
  • disable_cmd_for_non_op- Defines whether mod commands are disabled for non-OP players.

    • Example: disable_cmd_for_non_op = true
  • op_bypass_flags- Defines whether OPs/permitted players are allowed to bypass flags set in regions.

    • Example: op_bypass_flags = true
  • hierarchy_ownership- Defines whether owners of parent regions have implicit ownership rights for child regions as well

    • Example: hierarchy_ownership = true
  • allow_region_tp- Defines whether teleport in and out of a region is allowed by everyone. Mostly useful when using something like Waystones inside of regions.

    • Example: allow_region_tp = true
  • wp_root_command - This controls the default root-command for YAWP. Options are 0 for /wp or 1 for /yawp. Defaults to 0. You need to restart the server for this configuration to take effect (this is due to the command registration on server startup)!

Flag config

  • covered_block_entities - This is a list of block-entities, which can be placed and destroyed like a block, but are not automatically covered by the break-blocks and place-blocks flags. These list includes tile-entities like armor stands, paintings, leash knots and item frames by default.

    • Example: covered_block_entities = ["minecraft:armor_stand", "minecraft:painting", "minecraft:item_frame", "minecraft:glow_item_frame", "minecraft:leash_knot"]
  • covered_block_entity_tags - This is used like the covered_block_entities config, but can be provided with tags. This is currently disabled.

    • Example: covered_block_entity_tags = ["botania:floating_flowers", "botania:special_floating_flowers"]
  • remove_entities_for_spawning_flags- #Toggle to remove entities when adding spawning-* flags. Entities with the PersistenceRequired tag will not be removed.

    • Example: remove_entities_for_spawning_flags = true

Region default config

  • default_flags - these are the default region flags for newly created Local Regions. Default is empty.

    • Example: default_flags = ["break-blocks", "place-blocks"]
  • dim_default_flags - the same as default_flags just only for Dimensional Regions. Default is empty.

    • Example: dim_default_flags = ["spawning-animal", "no-pvp", "no-flight"]
  • default_region_priority - this is the default region priority for newly created regions. This is only important for local, normal regions. Dimensional Regions do not have an explicit priority. Defaults to 10.

    • Example: default_region_priority = 10
  • default_region_priority_inc - this is used for the interactive command line interface to manage local regions. It sets the step value for the QoL links for changing a region's priority. Range 1-1000, defaults to 5.

    • Example: default_region_priority_inc = 5
  • cli_entries_per_page - Amount of pagination entries for CLI output of flags, region, children region, players, teams, etc. Range 5-15, defaults to 5.

    • Example: cli_entries_per_page = 10
  • dim_enable_new - Decides whether newly created Dimensional Regions are enabled or disabled by default.

    • Example: dim_enable_new = true