Skip to content

Flags and Game Rules

NotMyFault edited this page May 24, 2021 · 12 revisions

Flags

Flags allow you to customize per-world options. A flag in Hyperverse is a world property with a well defined value type.

Flags are set using the /world flag set <world> <flag> <value> command, and a flag can be unset using /world flag remove <world> <flag>

For more complex and fine tuned control it is highly recommended to use WorldGuard. Hyperverse is first and foremost a world management plugin, and so it will not allow you to control specific damage causes, whether block physics is enabled, etc.

Spigot (and Paper) already allow you to configure world settings per world. Because of this, Hyperverse will not include settings that change crop growth rates, etc, as that can already be fined tuned on a per-world basis.

Available Flags

These flags are currently implemented:

force-spawn:
Description: Whether or not players should be teleported to the world spawn each time they enter the world
Note: This flag is only used when persist-locations is enabled in the configuration file
Values: true/false
Default: false

gamemode:
Description: World gamemode. This is enforced when a player enters a world. Give players the permission hyperverse.override.gamemode to prevent their gamemode from changing when they switch worlds.
Values: survival, creative, adventure, spectator
Default: survival

local-respawn:
Description: Whether or not players should respawn at their beds/global spawn, or respawn in this world if they die inside it
Values: true, false
Default: false

pvp:
Description: Whether or not player vs. player combat is enabled in the world
Values: true, false
Default: true

pve:
Description: Whether or not player vs. entity combat is enabled in the world
Values: true, false
Default: true

world-permission:
Description: Permission node required to visit the world
Values: Strings containing alphanumerical characters, -, _ and .
Default: ""

nether:
Description: Decides which world this world's nether portals link to
Values: World names. "disabled" to disable. Remove for vanilla behaviour.
Default: ""

end:
Description: Decides which world this world's end portals link to
Values: World names. "disabled" to disable. Remove for vanilla behaviour.
Default: ""

difficulty:
Description: World difficulty
Values: peaceful, easy, normal and hard
Default: normal

creature-spawn:
Description: Whether or not docile/neutral creatures are allowed to spawn
Values: true, false
Default: true

mob-spawn:
Description: Whether or not hostile creatures are allowed to spawn
Values: true, false
Default: true

respawn-world:
Description: The world you respawn in if local-respawn is disabled
Values: World names.
Default: ""

ignore-beds:
Description: Ignore bed spawn points
Values: true, false
Default: false

alias:
Description: Changes the world display name. Accepts color codes like <green>name</green>. See MiniMessage for more information on formatting.
Values: Strings.
Default: ""

Game Rules

Hyperverse allows you to configure most vanilla game rules (here is a list) per world.

Use /world gamerule set <rule> <value> to set a game rule, and /world gamerule remove <rule> to remove it.