Yet Another World Protector (YAWP) is the admin tool to protect your minecraft server (dedicated or LAN as well as single-player!). It's available for (Neo-) Forge and Fabric.
YAWP designed to be used on dedicated servers, but can also be used in single player worlds and worlds opened to LAN.It allows admins (and players with assigned permission) to protect their creations against various events/actions ofplayers, mobs andthe environment.
Create regions for your builds and apply region flags to protect them.Assign players or vanilla teams to regions, so they can manage their own regions.
YAWP was inspired by the forge mod WorldProtector andthe WorldGuard plugin.
Join our discord if you have any questions or suggestions: YAWP Discord
| Discord | Paypal | Patreon | Github | Wiki | Issues | Curseforge | Modrinth |
|---|
The mod is currently in its beta state, with many features not yet implemented but to come. These features willinclude most of the things you know from WorldProtector and WorldGuard.
This mod will be released for Minecraft versions 1.16.5+. If you are living in the past and are looking for a version for Minecraft 1.12.2, I suggest looking into using WorldDefender.
Starting with Minecraft 1.20.4, YAWP will no longer be available for Forge and adapt NeoForge instead.
In YAWP there are three different kinds of regions to protect your server:
The Global Region
The Global Region is... well global. Flags set in the Global Region, apply to all dimensions of the server and thus allLocal Regions.
Dimensional Regions
Dimensional Regions are special regions which are tied to one dimension - like gamerule-flags for different dimensions.
Dimensional Regions have no spatial restrictions in the corresponding dimension. Dimensional Regions work like normalregions, but are tied to a dimension.
They can't be created manually. They are in fact automatically generated with each new dimension. The first DimensionalRegion for the overworld is created when the server is created.
The following Dimensional Regions are created whenever a player travels to a new dimension, thus creating the newdimension with their respective Dimensional Region. Modded dimensions are supported as well.
Local Regions
Local Regions are the regions you most likely now from WorldGuard or WorldProtector. They have a defined area in whichthey work in and which they are limited to.
With Local Regions you are able to create areas in your world, which you want to protect from certain actions/eventswhich are caused by players, other entities or the environment.
To create a Local Regions you will need to have the permission of the parent region or permission from the config.
Local Regions can be createdby marking the area with a RegionMarker and executing the corresponding command or by just using a command without theRegionMarker.
For now the area of a region can be defined as in a cuboid or spherical shape, but I am planning to add more shapes forregion areas in future updates.
Properties of regions
The properties of regions, flags, groups, etc. can all be managed throughan interactive CLI.
The colored text indicates interactive shortcuts commands or command suggestions. All colored text have a tooltip hintwhich explains shortly what clicking on the corresponding link does.
Clicking on them gives the player a suggestion for executing a command or sometimes straight execute the command whichis hinted by the hover text.
Regions can only be managed by their owners, or by players which have the required OP level or have an entry in theconfiguration. For more information, visit the wiki.
Whenever a new Local Region is created without supplying a parent region, the parent is set to the Dimensional Regionwhich the new Local Region is created in.
Local Regions can also have child regions. The children of a Local Regions need to be contained in the area of theparent region. The region hierarchy also defines the region priorities. Child regions always must have a higher prioritythan their parent.
Dimensional Regions always have the Global Region as a parent, and thus the Global Region all Dimensional Regions aschild regions.
Regions have owners and normal members. Owners are allowed to manage the region and bypass the flags, members areonly allowed to bypass the flags set in the region.
Owners and Members can be individual players or a team.
Groups allow you assign specific region permissions to different players and teams. Currently, there are only twodefault groups: owners and members.
Owners can manage their region themselves and add other players/teams to the region. They can also create theirown sub-regions within their region, manage flags, ect. and of course owners bypass flags.
Members are only allowed to bypass flags only.
I am planning on adding a LuckPerms integration with a futureupdate, so you can define your own groups and permissions.
If you have trouble with setting up regions, visit the discord for help.
Flags are the core of the region protection system. They define which actions are allowed or denied in a region. Flagscan be set to
- Allowed, to allow the corresponding action,
- Denied, to deny the corresponding action,
- Disabled, to disable the specific flag for flag checks.
Child regions inherit the flags from their parent regions. It is further possible to override the flag state for childregions by setting the override property of the flag of the parent region accordingly.
See the Flags page for more details about thedifferent flags.
I am planning to add more flag in the future. A list of suggested flags which I'll slowly add to the mod can be foundhere: Flag suggestions
There will also be more complex flags in the future. Like ListFlag which will allow you to define a list of allowedblocks/entities/.. which are forbidden in the context of a flag.
The commands of mod are also designed to be used by the server console and can be executed by command blocks.
This allows you to automate region setups, add/remove players, enable or disable regions, etc.
YAWP provides a growing mod integration API for easier mod and modpack integration. Currently, the API allows other modsto listen for events for region creation, changes and deletion and cancel these events to prevent them from happening.
Additionally, there are events for flag checks and their results, which can be used to manipulate the outcome of theflag check.
The client side installation of the mod provides language support (I18n) in form of a resource pack. Currently, english,german and russian language is supported.
Starting with mod version 0.0.2.9-beta2 and Minecraft Version 1.19.4, YAWP provides a default english translation.
If your language is not yet supported, feel free to reach out to me via discord or issue a pull request via github! :)
The configuration of the mod allows you to control which is allowed to use the mod, sets default flags for Local andDimension Regions, command line interface options, etc.
The configuration is split in different files, covering different topics.
yawp-common.toml- config for command permissionsyawp-flags.toml- config for flags, custom flag messages, etcyawp-region-defaults.toml- config for default region properties
Since YAWP is a server-side mod, the config for it is found in the directory /serverconfig in your minecraft worlddirectory.
The documentation of the mod is small but growing. I am trying to keep up with the content. You can find thedocumentation << here >>.
The documentation covers
- descriptions of different regions
- getting started & FAQ
- available commands & flags
- configuration
- and more ...
If something is not covered feel free to hop on our discord server and ask your question there. :)
Roadmap
There are many more features to come. The mod is in active development!The following list is not comprehensive.
- Different flag types (List, Effect, ...) for more granular control
- Data pack driven flag configuration
- Region boundary visualization
- Define your own region groups for more granular management of regions (LuckPerms)
- More granular permission system (combined with the more granular group features)
- Region templates for easier managing same regions with different spatial properties
- Region triggers for entering/leaving a region (for displaying messages, executing commands, etc)*
- Regions with different shapes (Cylinder, Prism, 3DPolygon)*
- <your suggestion here>
