Open Parties and Claims

Description

The mod is currently in Beta!

This mod adds the ability to claim and to forceload world chunks, as well as create and manage player parties. It also gives server owners powerful controls over their players' usage of the mod's features.

The mod's API allows other mods or plugins to easily interact with the parties and the chunk claims, both on the server and the client side. The mod already integrates with Xaero's Minimap and World Map mods. Make sure to update them to the latest versions.

The API of the mod allows the implementation of player permission systems to be used by the mod for some permission nodes (e.g. for having rank-based claim limits), with Prometheus, FTB Ranks, LuckPerms and the Forge/Fabric permission APIs having built-in support. It also allows the implementation of party systems to be used by claims alongside or instead of the default party system, with Argonauts and FTB Teams having built-in support. The default party system or claims can be disabled completely in the main config file.

Commands:

/openpac ... - player config commands
/openpac-claims ... - everything claim-related
/openpac-parties ... - everything party-related
/opm - shortcut for the party chat

Key Bindings:

' - open the mod UI. Can be changed in the controls menu.

Configs:

[world directory]/serverconfig/openpartiesandclaims-server.toml - the usual location of the main config file. Make sure to shut down the server before editing it, or the server might overwrite all your changes.
[server directory]/config/openpartiesandclaims-server.toml - sometimes the location of the main config file on Fabric/Quilt.
[world directory]/serverconfig/openpartiesandclaims-... - some global "player configs", although all of them can be accessed in game through the UI

FAQ

1) How do I configure the mod on my server?

The mod is mainly configured through the main config file at [world directory]/serverconfig/openpartiesandclaims-server.toml, or sometimes [server directory]/config/openpartiesandclaims-server.toml on Fabric/Quilt, while the server isn't running. Server claim, expired claim and wilderness configs, as well as the default player config, can be edited by OPs in-game with the UI (check your key bindings). Normal players can configure their own player config with the same UI. If the mod isn't installed on the client side, then you can use the player config chat commands instead.

2) How do I use this mod as a regular player?

Most things related to claims can be accessed with the in-game UI (check your key bindings). If you have the Xaero's World Map mod installed, you can view and edit your claims on the map screen as well, by right-clicking on the map or dragging with the right mouse button to make a selection. You can also use chat commands to make/edit claims. Parties can only be created and managed through chat commands at the moment.

3) Why are some options greyed out in my player config?

The server admin/owner can configure with the main config file option playerConfigurablePlayerConfigOptions which specific options players have access to. Everything else uses the value in the default player config.

4) How do I disable all protection on my server?

In the server claim, expired claim and wilderness configs, as well as the default player config, disable the main protection option. Next, edit the config file [world directory]/serverconfig/openpartiesandclaims-server.toml (sometimes in [server directory]/config), while the server isn't running. Remove the main option claims.protectClaimedChunks from playerConfigurablePlayerConfigOptions.

5) How do I add claim protection exceptions for interaction or breaking/attacking of specific blocks, entities/mobs or using items?

The mod comes with some global exceptions preconfigured, as well as some default exception groups you can toggle in individual claims. Both forced and per-claim toggleable exceptions can be added through the main config file [world directory]/serverconfig/openpartiesandclaims-server.toml (sometimes in [server directory]/config). The file must be edited/replaced while the server isn't running to ensure that it is not overwritten on server restart. For exceptions forced on every claim, the options you are interested in are forcedBlockProtectionExceptionList, forcedEntityProtectionExceptionList, itemUseProtectionExceptionList. For toggleable exception groups, similar to the default ones (Controls, Doors, Traders, Livestock), the options you are interested in are blockProtectionOptionalExceptionGroups, entityProtectionOptionalExceptionGroups, itemUseProtectionOptionalExceptionGroups. You can add new groups or edit existing ones. Please carefully read the comments above the options. They have crucial information that would take too much space to put here.

6) How do I give specific entity/mob types access to blocks, entities or dropped items (e.g. letting zombies attack villagers)?

Both forced and per-claim toggleable exceptions can be added through the main config file [world directory]/serverconfig/openpartiesandclaims-server.toml (sometimes in [server directory]/config). The file must be edited/replaced while the server isn't running to ensure that it is not overwritten on server restart. To force access by specific entities on all claims, the options you are interested in are entitiesAllowedToGrief, entitiesAllowedToGriefEntities, entitiesAllowedToGriefDroppedItems. For access groups toggleable per claim, similar to the default ones (Villagers, Zombies, Piglins, Foxes), the options are blockAccessEntityGroups, entityAccessEntityGroups, droppedItemAccessEntityGroups. For "fake players" that operate from specific block positions they are tied to, usually as part of automation machines, check out the staticFakePlayers option. Please carefully read the comments above the options. They have crucial information that would take too much space to put here.

Supported Mods:

A lot of (usually smaller) mods should be supported by the claimed chunk protection automatically. Some mods go above and beyond with the mechanics they add to the game or modify, in which case chunk protection is not guaranteed and should be manually added, either to this mod or with an additional one. Feel free to leave suggestions on the issue tracker for the mods that you'd like to be supported. Please make sure that they are not already by testing it and provide an example of chunk griefing one can achieve with the mod.

Explicitly supported mods:

• (Since b0.8.0) Create - built into the Forge version, but requires an extension when used on Fabric/Quilt. Protected chunks should be protected from all survival mode Create mechanics, but let me know if I missed something (please make sure it's not just a client-sided glitch by relogging). I don't know if support for creative mode mechanics will be added as well, but we'll see.

What means Verified?

• Compatibility: The mod should be compatible with the latest version of Minecraft and be clearly labeled with its supported versions.
• Functionality: The mod should work as advertised and not cause any game-breaking bugs or crashes.
• Security: The mod should not contain any malicious code or attempts to steal personal information.
• Performance: The mod should not cause a significant decrease in the game's performance, such as by causing lag or reducing frame rates.
• Originality: The mod should be original and not a copy of someone else's work.
• Up-to-date: The mod should be regularly updated to fix bugs, improve performance, and maintain compatibility with the latest version of Minecraft.
• Support: The mod should have an active developer who provides support and troubleshooting assistance to users.
• License: The mod should be released under a clear and open source license that allows others to use, modify, and redistribute the code.
• Documentation: The mod should come with clear and detailed documentation on how to install and use it.

How to Install