🇬🇧   🇩🇪   🇨🇳

A better chunk claim system for Paper servers
Get it? It sounds like exclaim...

| Installation | Features | Config | Permissions | Commands | Support | Roadmap |

Installation

You can download a build from the releases tab on the right, or build the plugin yourself if you want. Then, place the JAR into your plugins folder. Don't use the JAR labelled "original" unless you know what you are doing.

Features

The main command is /xclaim (alias /xc). This allows players to create and manage their claims. Claims have several permissions that can be toggled, either by general groups (nobody, trusted players, veteran players, all players) or by individuals. The GUI also allows players to add/remove players from their trusted list.

Map Integration

• Dynmap integration should work out-of-the-box as long as it is configured properly. If it does not, please create an Issue on the Issues page.
• BlueMap integration has also been supported since version 1.10.0.

Importing from ClaimChunk

This process should be done without any players online. The server should have ClaimChunk AND XClaim loaded at the same time. It's possible that you need PlaceholderAPI on the server as well while doing this (unverified), but you definitely don't need either ClaimChunk nor PlaceholderAPI for XClaim to work normally. Once all of those conditions are met, run /importclaims. This may take a while or be resource intensive (hasn't been tested at scale) since it will attempt to turn adjacent claimed chunks into one group.

Languages

As of version 1.6.x, multiple languages are supported. When the plugin starts, default language packs are loaded into /plugins/XClaim/lang. Below are a list of default language packs:

• en-US (American English)
• de (German) by eingruenesbeb
• zh (Simplified Chinese) by SnowCutieOwO

The plugin decides what language to use based on the "language" option in the config.

If you want to make your own language pack, copy an existing one as an example (e.g. /plugins/XClaim/lang/en-US.json) and rename it accordingly (e.g. fr.json). You can then translate the contents of that file. Knowledge of JSON and MiniMessage is highly suggested. Do not translate the keys, only the values. Language packs may become less human-readable after encoding, so it is suggested to get your language pack base from the source. There are some cases where the symbols $1, $2, etc. are used. This means that "something is inserted here", for example Hello $1! may resolve to Hello Username! ingame.

Economy

By default, economy features are disabled. To enable them, set "use-economy" in the config to true.
If use-economy is enabled, XClaim will attempt to hook into the following economy plugins if present:

• Vault
• EssentialsX

Players will then pay depending on the permission group the player is in (see here).
For instance, if you wanted to set the default price for a claim to 2.25, then you would set limits.default.claim-price to 2.25.
See all options in the config section.

Config

Name	Description	Default Value
language	The language to use, must be a valid language pack from /plugins/XClaim/lang otherwise falls back to en-US	en-US
veteran-time	The time in seconds it takes for a player to be on the server in order for Veteran status to take effect	604800 (1 week)
stop-editing-on-shutdown	Whether players should be booted out of the chunk editor on shutdown	false
stop-editing-on-leave	Whether players should be booted out of the chunk editor when they leave voluntarily	true
exempt-claim-owner-from-permission-rules	If claim owners should have access to all permissions on the claim implicitly. You shouldn't change this, it's mainly for debugging	true
enforce-adjacent-claim-chunks	Whether chunks in a claim must be next to each other	true
allow-diagonal-claim-chunks	If enforce-adjacent-claim-chunks is true, this sets if chunks diagonal from each other are considered as "next to" each other. Otherwise, does nothing.	true
enter-chunk-editor-on-create	If true, then players will enter the chunk editor when they make a new claim	true
use-economy	Whether to use economy features	false
limits.𝘨𝘳𝘰𝘶𝘱-𝘯𝘢𝘮𝘦.max-chunks	Sets the max chunks for a group. See Permissions for more info.
limits.𝘨𝘳𝘰𝘶𝘱-𝘯𝘢𝘮𝘦.max-claims	Sets the max claims for a group. See Permissions for more info.
limits.𝘨𝘳𝘰𝘶𝘱-𝘯𝘢𝘮𝘦.give-after	The time in seconds it takes for a player to play until they are automatically entered into this group. Values less than 0 signify "never".	-1
limits.𝘨𝘳𝘰𝘶𝘱-𝘯𝘢𝘮𝘦.claim-price	If economy is enabled, sets the price for claiming a chunk.	20
limits.𝘨𝘳𝘰𝘶𝘱-𝘯𝘢𝘮𝘦.unclaim-reward	If economy is enabled, sets the refund amount for unclaiming a chunk.	0
limits.𝘨𝘳𝘰𝘶𝘱-𝘯𝘢𝘮𝘦.free-chunks	If economy is enabled, sets the amount of chunks a player can claim for free before the next chunk requires a payment of limits.𝘨𝘳𝘰𝘶𝘱-𝘯𝘢𝘮𝘦.claim-price.	4
limits.𝘨𝘳𝘰𝘶𝘱-𝘯𝘢𝘮𝘦.max-claims-in-world	The maximum number of claims allowed at a time in each world. Values less than 1 signify no limit.	-1
dynmap-integration.enabled	If true, XClaim will look for dynmap on startup and hook into it. Mild speedup if turned off.	true
dynmap-integration.use-old-outline-style	If true, the dynmap will use the old convex hull outlines on claims. This is mainly for debugging, as the new outline system is experimental.	false
disable-paper-warning	Disables the message posted to console on startup when the server is running Spigot instead of Paper	false
worlds.use-whitelist	If worlds.whitelist should be considered	false
worlds.use-blacklist	If worlds.blacklist should be considered	false
worlds.case-sensitive	Whether capitalization in world names in the white/blacklist matter	true
worlds.whitelist	A list that a world must be in for it to work with XClaim	a sample list
worlds.blacklist	A list that a world must NOT be in for it to work with XClaim	a sample list
worlds.grace-time	If a claim is in a disallowed world, players have this much time in seconds before the claim is automatically removed	604800 (1 week)

Permissions

Don't worry, there aren't that many.

Name	Description
xclaim.override	Allows you to overwrite claimed chunks
xclaim.admin	Allows you to modify/delete any claim
xclaim.import	Allows you to import claims from the ClaimChunk plugin
xclaim.update	Allows you to use the auto-updater
xclaim.restart	Allows you to restart xclaim
xclaim.clear	Allows clearing claims from players with /xclaim clear
xclaim.group.𝘨𝘳𝘰𝘶𝘱-𝘯𝘢𝘮𝘦	If a player has this permission, they are a part of this group. Players will inherit the "best" values from each group they are in. If the group is named "default", all players are in this group implicitly.

Commands

Name	Description
xclaim	XClaim main command. Without any extra arguments, is the same as /xclaim gui
xclaim help	List the available subcommands
xclaim info	Provides basic info about XClaim
xclaim gui	Opens an easy-to-use GUI that covers most of XClaim's important features
xclaim update	Scans for new versions of XClaim and, if desired, runs the auto-updater
xclaim chunks [claim_name]	Opens the chunk editor for the specified claim or, if absent, the current residing claim
xclaim current	Gets info about the current claim you are in
xclaim restart	Restart XClaim without restarting the server (experimental)
xclaim clear	Clear all claims from a player
xclaim list	Lists all claims a player owns
importclaims	Import claims from ClaimChunk

Support

	1.8 - 1.11	1.12 - 1.13	1.14 - 1.16	1.17	1.18	1.19	1.19.4	Folia	Paper	Spigot
< 1.3.1	❌	❌	❌	❔	✔	❌	❔	❔	✔	❌
1.3.1	❌	❌	❌	❔	✔	✔	❔	❔	✔	❌
1.4.0	❌	❌	❌	✔	✔	✔	❔	❔	✔	❌
1.5.0	❌	❌	❌	✔	✔	✔	❔	❔	✔	✔
1.8.0	❌	❌	✔	✔	✔	✔	❔	❔	✔	✔
1.9.0	❌	✔	✔	✔	✔	✔	❔	❔	✔	✔
1.9.1	✔	✔	✔	✔	✔	✔	❔	❔	✔	✔
1.10.0	✔	✔	✔	✔	✔	✔	✔	❔	✔	✔
1.10.2	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔

Versions before 1.5.0 are no longer supported

Roadmap

• Add more management commands