README.md

Protect

A lightweight modern alternative to WorldGuard optimized for API usage

• Commands
• Area flags
• Permission Packs
• API

Commands

Command	Description	Permission
/area create <name> [<priority>]	create new areas	protect.command.area.create
/area delete <area>	delete existing areas	protect.command.area.delete
/area flag info [flag] (area)	query information about area flags	protect.command.area.flag.info
/area flag list [<provider>]	list all existing area flags	protect.command.area.flag.list
/area flag reset <flag> [<area>]	reset specified flags of areas	protect.command.area.flag.reset
/area flag set <flag> <value> [<area>]	change specified flags of areas	protect.command.area.flag.set
/area group add <group> [<name>]	add your current selection to a group	protect.command.area.group.add
/area group create <area>	create a group from an area	protect.command.area.group.create
/area group delete <group>	delete a group (does not delete the area)	protect.command.area.group.delete
/area group list [<group>]	list all groups or regions of a group	protect.command.area.group.list
/area group redefine <group> <region>	redefine a region inside a group	protect.command.area.group.redefine
/area group remove <group> <region>	remove a region from a group	protect.command.area.group.remove
/area group select <group> <region>	select a region inside a group	worldedit.selection.pos
/area info [<area>]	query information about specific areas	protect.command.area.info
/area list	list all areas	protect.command.area.list
/area members add <area> <players>	add members to an area	protect.command.area.members.add
/area members list [<area>]	list all members of an area	protect.command.area.members.list
/area members remove <player>	remove a member from an area	protect.command.area.members.remove
/area owner remove <player>	remove the owner of an area	protect.command.area.owner.remove
/area owner set <area> <player>	set the owner of an area	protect.command.area.owner.set
/area parent remove <area>	remove the parent of an area	protect.command.area.parent.remove
/area parent set <area> <parent>	set the parent of an area	protect.command.area.parent.set
/area priority <area> [<priority>]	view or change the priority of areas	protect.command.area.priority
/area protect <area> [remove]	add, update or remove the protection of an area	protect.command.area.protect
/area redefine <area>	redefine the region of an existing area	protect.command.area.redefine
/area schematic delete <area>	delete an area's schematic	protect.command.area.schematic.delete
/area schematic load <area>	load in an area's schematic	protect.command.area.schematic.load
/area schematic save <area>	save an area's schematic	protect.command.area.schematic.save
/area select <area>	(worldedit) select the region of an existing area	worldedit.selection.pos
/area teleport <area>	teleport yourself to an area	protect.command.area.teleport

Area flags

Flag	Description	Value
protect:farewell	message that is send when leaving an area	MiniMessage String
protect:farewell_actionbar	actionbar that is shown when leaving an area	MiniMessage String
protect:farewell_title	title that is send when leaving an area	MiniMessage String
protect:greetings	message that is send when entering an area	MiniMessage String
protect:greetings_actionbar	actionbar that is shown when entering an area	MiniMessage String
protect:greetings_title	title that is send when entering an area	MiniMessage String
protect:time	change the time inside of an area	Integer
protect:weather	change the weather inside of an area	DOWNFALL / CLEAR

Boolean Flags

Flag	Description
protect:enter	allows or denies entrance
protect:leave	allows or denies exit
protect:damage	controls whether damage can be applied
protect:entity_item_drop	controls whether entities can drop items
protect:entity_item_pickup	controls whether entities can pickup items
protect:game_events	controls whether sculk sensors can pick up on game events (sounds)
protect:gravity	enables or disables gravity
protect:hunger	controls whether hunger is applied
protect:liquid_flow	enables or disables liquid flow
protect:natural_entity_spawn	controls whether entities can naturally spawn
protect:notify_failed_interactions	enables or disables failed-interaction messages
protect:physics	enables or disables physics
protect:redstone	enables or disables redstone

Protection Flags

Flag	Description
protect:armor_stand_manipulate	allows or denies armor stand manipulations
protect:block_absorb	controls whether sponges can absorb water
protect:block_burning	controls whether blocks can burn
protect:block_drying	controls whether blocks can dry out (farmland)
protect:block_fading	controls whether blocks can fade away (like ice or snow melting or corals fading)
protect:block_fertilize	controls whether blocks can be fertilized
protect:block_forming	controls whether blocks can randomly form (like snow from a snow storm or ice in cold environment)
protect:block_growth	controls whether blocks can grow (like wheat or carrots)
protect:block_igniting	controls whether blocks can ignite (like fire spreading or lightning striking)
protect:block_moisturising	controls whether blocks can moisturise (farmland)
protect:block_spread	controls whether blocks can spread (like grass or fire)
protect:cauldron_evaporation	controls whether cauldrons can evaporate from biome dryness
protect:cauldron_extinguish_entity	controls whether cauldrons can extinguish flaming entities
protect:crop_trample	allows or denies crop trampling
protect:destroy	allows or denies destroying objects (like blocks or entities)
protect:entity_attack_entity	controls whether entities can attack other entities
protect:entity_attack_player	controls whether entities can attack players
protect:entity_interact	allows or denies interaction with entities (like trading with merchants)
protect:entity_shear	allows or denies shearing entities (like sheep or snow golems)
protect:explosions	controls whether explosions can do block damage
protect:interact	allows or denies block interactions (like opening chests or doors)
protect:leaves_decay	controls whether leaves can decay
protect:natural_cauldron_fill	controls whether cauldrons can fill naturally (like from rain or dripstone)
protect:physical_interact	allows or denies physical interactions (like standing on pressure plates or drip leaves)
protect:place	allows or denies placing objects (like blocks or entities)
protect:player_attack_entity	controls whether players can attack entities
protect:player_attack_player	controls whether players can attack players
protect:player_item_drop	controls whether players can drop items

Permission Packs

Permission packs streamline server management by providing bundled options instead of dealing with a multitude of individual permissions.

protect.admin

Allows players to manage all areas and bypass all restrictions

protect.bypass.admin
protect.command.area.create
protect.command.area.delete
protect.command.area.info
protect.command.area.list
protect.command.area.priority
protect.commands.area.flag
protect.commands.area.group
protect.commands.area.members
protect.commands.area.owner
protect.commands.area.parent
protect.commands.area.schematic

protect.bypass.admin

Allows players to bypass any restriction

protect.bypass.attack
protect.bypass.destroy
protect.bypass.enter
protect.bypass.entity-interact
protect.bypass.entity-shear
protect.bypass.interact
protect.bypass.leave
protect.bypass.physical-interact
protect.bypass.place
protect.bypass.trample

protect.command.area.flag

Allows players to manage area flags

protect.command.area.flag.info
protect.command.area.flag.list
protect.command.area.flag.reset
protect.command.area.flag.set
protect.command.area.protect

protect.command.area.group

Allows players to manage area groups

protect.command.area.group.add
protect.command.area.group.create
protect.command.area.group.delete
protect.command.area.group.list
protect.command.area.group.redefine
protect.command.area.group.remove

protect.command.area.members

Allows players to manage area members

protect.command.area.members.add
protect.command.area.members.list
protect.command.area.members.remove

protect.command.area.owner

Allows players to manage area owners

protect.command.area.owner.remove
protect.command.area.owner.set

protect.command.area.parent

Allows players to manage area parents

protect.command.area.parent.remove
protect.command.area.parent.set

protect.command.area.schematic

Allows players to manage area schematics

protect.command.area.schematic.delete
protect.command.area.schematic.load
protect.command.area.schematic.save

API

https://repo.thenextlvl.net/#/releases/net/thenextlvl/protect/api