Open Parties and Claims

_**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. By default, claims are owned by individual players who are able to make protection exceptions based on party relations or custom player groups. Server owners can also turn on party-owned claims which is explained in the FAQ below. 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](https://modrinth.com/mod/xaeros-minimap) and [World Map](https://modrinth.com/mod/xaeros-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 (since 0.30.0): /opac … - player config commands (server claims, wilderness and expired claims also have a "player config") /oclaims … - everything claim-related /oparties … - 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 ## Permission Nodes (since 0.30.0): The permission nodes that this mod looks up for various reasons are not just static paths. They can be configured in the main config file, e.g. option "maxPlayerClaimsPermission". The used permission system (FTB Ranks, LuckPerms etc) can be configured with the "permissionSystem" option in the main config file. If you or the modpack you are using have not changed the permission nodes, then the permission node paths should be the following: * **"xaero.pac\_max\_player\_groups"** - The meta value permission that should override the default "maxPlayerGroups" option value in the main config. * **"xaero.pac\_player\_group\_space"** - The meta value permission that should override the default "playerGroupSpace" option value in the main config. * **"xaero.pac\_max\_claims"** - The meta value permission that should override the default "maxPlayerClaims" option value in the main config. * **"xaero.pac\_max\_forceloads"** - The meta value permission that should override the default "maxPlayerClaimForceloads" option value in the main config. * **"xaero.pac\_server\_claims"** - The permission that gives non-OP players the ability to make server claims and enable server claim mode. * **"xaero.pac\_claims\_moderator\_mode"** - The permission that gives non-OP players the ability to enable claim moderator mode which enables them to see player owners of party-owned claims. * **"xaero.pac\_claims\_admin\_mode"** - The permission that gives non-OP players the ability to enable claim admin mode which, in addition to moderator mode features, gives them the ability to circumvent the vast majority of claim-related limitations, e.g. protection, max claiming distance, inability to claim a chunk. * **"xaero.pac\_claims\_impersonation"** - The permission that gives non-OP players the ability to impersonate other players when performing claim-related actions. * **"xaero.pac\_claims\_teleport"** - The permission that gives non-OP players the ability to teleport to any player's claims. * **"xaero.pac\_parties\_admin\_mode"** - The permission that gives non-OP players the ability to enable parties admin mode which lets them see party chat messages for all built-in party system parties. * **"xaero.pac\_parties\_impersonation"** - The permission that gives non-OP players the ability to impersonate other players when performing party-related commands. ## 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_, 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. ### 7) How do I enable party-owned claims? Setting the _partyOwnedClaims_ option in the main config file _openpartiesandclaims-server.toml_ to _true_ makes it so if a player who technically owns the claims is also the owner of a party from the primary party system (option _primaryPartySystem_ in the main config file), then their claims are effectively treated as if they are owned by the party itself. * This enables other party members to use party-claim-mode to claim as the party if they have permission (at least rank CLAIMER in the default party system, Officer in FTB Teams, any member permission other than TP_MEMBERS in Argonauts/Odyssey Allies). If "Whole Party Can Claim" is enabled in the party owner's config (or enforced by the default player config), then every player in the party can claim/unclaim as the party. * This enables other party members to edit the party claim config (claim-related options in the party owner's config) if they have permission (at least rank ADMIN in the default party system, only the owner in FTB Teams, MANAGE_SETTINGS in Argonauts/Odyssey Allies). * This enables other party members to manage players in the party claim config's custom player groups (at least rank MODERATOR in the default party system, Officer in FTB Teams, MANAGE_MEMBERS in Argonauts/Odyssey Allies). * This enables other party members to edit party claim config's custom player groups beyond managing players (ADMIN in the default party system, only the owner in FTB Teams, MANAGE_SETTINGS in Argonauts/Odyssey Allies). * If the chosen primary party system supports party colors (e.g. FTB Teams), then the default color of the party's claims is the party color, not the random color of the party owner. * The server owner can configure how available claims/forceloads scale with party size and existence using options _claimBonusPerPartyMember_, _forceloadBonusPerPartyMember_, _claimBonusForPartyOwner_ and _forceloadBonusForPartyOwner_ in the main config file. Please read the comments above these options for a detailed explanation. ## 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](https://github.com/thexaero/open-parties-and-claims/issues) 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 before b0.25.1 requires [an extension](https://modrinth.com/mod/opac-fabric-create-support) when used on Fabric/Quilt