Skip to content
Marcel Bartholet edited this page Aug 30, 2024 · 54 revisions

Yet Another World Protector

Yet Another World Protector, or YAWP for short, is a server-side mod, for Fabric and Forge, which allows you to protect your creations against various different events/actions of players, mobs and the environment.

It was inspired by the forge mod WorldProtector and the WorldGuard plugin.

The mod is currently in its beta state, with many features not yet implemented but to come. These features will, beside others, include most of the things you know from WorldProtector and WorldGuard.

Supported Minecraft/Modloader versions

This is available for Minecraft versions 1.16.5+. If you are living in the past and are looking for a version for Minecraft 1.12.2 (Forge), try using WorldDefender.

Note:

  • Version 0.0.4.0-beta2 is currently only available for Forge 1.16.5, 1.18.2, 1.20.1 and 1.20.4.
  • Version 0.0.4.0-beta2 for Fabric 1.20.1 and 1.21.x will follow soon!
  • The Wiki is up-to-date with version 0.0.4.0-beta2, so you are using fabric and have trouble using the mod visit the discord server and ask for help - thanks!
MC-Version Forge NeoForged Fabric Hybrid (Magma/Mohist/etc.)
1.16.5 ✔️ No! ❌
1.18.2 ✔️ ☑️ Please, ❌
1.19.2 ☑️ ☑️ don't ❌
1.19.3 ☑️ ☑️ ask ❌
1.19.4 ☑️ ☑️ for ❌
1.20.1 ✔️ ✔️ it! ❌
1.20.2 ☑️ ☑️ Thank ❌
1.20.4 ✔️ ✔️ you ❌
1.21.x 🔜 ✔️ (alpha) very much! ❌

Legend

  • ✔️ - actively in development
  • ☑️ - available, but no longer updated/maintained
  • ❌ - not available
  • 🔜 - in progress

YAWP provides three different types of regions to protect your server:

The Global Region is the region which is parent to all Dimensional Regions. Most things you are familiar with from Dimensional Regions work the same way with the Global Region.

Dimensional Regions have no area restrictions. Dimensional Regions work like Local Regions, but are tied to a whole dimension. They can have owners, members, flags and have a state.

Dimensional Regions can't be created manually. They are in fact automatically generated with each new dimension. The first Dimensional Region 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 new dimension with their respective Dimensional Region.

With Local Regions you are able to define areas in your world, which you want to protect from certain actions/events which are caused by players, other entities or the environment. You are able to define separate owners and members for owners by assigning vanilla teams and specific players to the region.

The area of a region is defined by a Cuboid shape (more shapes are planned for the future!). They also have a priority to manage overlapping regions.

You can add Flags to these regions to prevent various actions and events.


Flags are basically rules you can add any region. If the flag is initially defined, it prevents the defined action associated with the flag.

Take a look at the Flags page for more details about flag management.

There will be more flags (and type of flags) in the future. If you have a suggestion for a flag, feel free to add it to the suggestion list on github or share your idea in the #suggestions channel on discord.


Groups

Regions can have owners and normal members. Owners are allowed to manage the region and bypass the flags, members are only allowed to bypass the flags set in the region.

Owners/Members can be individual players or a team.

This allows you to create regions and assign players as their owners. They can then manage their regions themselves and add other players to them, as well as create their own sub-regions within their regions.

If you have trouble with setting up regions, visit the discord for help.

There are more granular features planned for region groups in the future - each group with different permissions (looking at you LuckPerms integration!).


Development Roadmap

There are many more features to come. The mod is in active development. Checkout the roadmap!

The following list is not comprehensive and not in any particular order. Visit the project website on Github to get an up-to-date overview of planned features. It'll try to keep it up to date with my work.

  • Granular Flags to allow/deny specific blocks, entities, items, etc.
  • Different shapes for Local Regions (Sphere, Cylinder, Prism, 3DPolygon,...)
  • Region Templates (save region setups in templates to apply them to other regions)
  • Region triggers for entering/leaving a region (for displaying messages, executing commands, etc)
  • More granular permission system with custom affiliations (most likely with LuckyPerms integration)
  • Highlighting Region boundaries (possible with WorldEdit integration)
  • More flags (see Flag Suggestions)
  • ...