RegionClaim
This free version will no longer get updates! Consider getting the improved premium version of this plugin which has many improvements and will continue to get new features!
About RegionClaim
Do you want your users to easily claim their base and keep it safe with WorldGuards protection standard, while you retain full control? Tired of manually creating predefined regions for people to claim? Then RegionClaim is the plugin for you!
RegionClaim allows people to create regions through its own very user-friendly command. The claim size, the number of claims a person may create and which settings will be set on them is highly configurable. You can use three permission levels with different settings for each. Under the hood it uses WorldGuard’s amazing API, making the regions both very well protected and adding almost no extra weight to your server!
Key features
Extremely user friendly
To make claiming easy to use for inexperienced players, I made this plugin as user friendly as possible. The main command has many different help messages, guiding a user though its usage in a constructive manner. It gives clever suggestions for mistyped commands, hinting at possible options. On top of that every command has full tab autocompletion making it much easier to use!
Highly configurable
I really think that a plugin should allow you to configure all its aspect for maximum flexibility. Of course you can change how many claims users may make, and what size these can be for all three permission levels. You can also set which WorldGuard flags will be set on users claims. Since version 2.2 my plugin also has Vault support, so it works with any Economy plugin out there.
As a bonus every user message can be changed, optionally allowing you to change it to your language!
Performance
As this plugin is built upon WorldGuard’s API to handle events it adds almost no extra load to your server!
Stability
The plugin validates its configuration on launch to guarantee an invalid configuration won’t break anything. If it finds any errors it lets you know exactly what should be fixed!
Getting started
Installation
From version 2.2.0 onwards, this plugin requires Java 8 or higher.
Download the jar file from the top of this page and put it in your plugins folder. Reload/restart your server and you are done! Keep in mind that this plugin uses WorldGuard, which in turn uses WorldEdit, so these should be installed as well if not already present.
Claiming a region
First set the outer boundaries of the area you want to claim using /claim setpos twice. This will take the block you are standing on at that moment as the boundary. Then do /claim create my_house (or any other name of course) to create a protected region. This region will be vertically expanded automatically, meaning the ground below and sky above are also part of your claim! You won’t be able to create overlapping claims (and can’t claim over other WorldGuard regions).
Commands
- /claim help - Displays help message explaining usage (unrecognized commands will also show this message)
- /claim setpos - Selects the block you are standing on as a boundary for a new claim
- /claim create <region_name> - Creates a new claim with the second argument as the name
- /claim remove <region_name> - Removes your claim with the name provided (if it exists)
- /claim show <region_name> - Gives the coordinates of a user’s claim. Also displays the border interactively using particles!
If inviting is allowed for the user's permission level
- /claim invite <region_name> <player_name> - Invite a friend to your claim, who will then also be also to build there! You will still remain the owner of the claim
- /claim uninvite <region_name> <player_name> - Remove someone you had invited from your claim
All these commands show custom help messages when used without the correct arguments.
For administrators only
This command won’t appear in the tab completion and of course requires a different permission.
- /claim resetconfig - Reset the config.yml file to its default. This will overwrite your own configuration file and should be used with care.
Permissions
To able to claim, users need at least claim.min. Setting multiple permissions for a user will give them the settings for the highest given level. In brackets is the default setting for the permission. I highly suggest using a permission manager to handle permissions properly.
- claim.min (true) - corresponds to the lowest permission level (referred to as ‘minimum’ in configuration)
- claim.normal (op) - corresponds to medium permission level (referred to as ‘normal’ in configuration)
- claim.max (op) - corresponds to the highest permission level (referred to as ‘maximum’ in configuration)
- claim.admin (op) - Allows you to reset the configuration file
Configuration
The configuration has a lot of settings and allows you to customise many aspects. This is of course optional, as it has sensible defaults. For specific details about a setting please read the comments above each setting in the config file or ask a question (see below).
The configuration is split into two sections:
The first one deals with settings about claims. Just like the permissions it has three permission levels, allowing custom settings for each of them. As of now you can set all WorldGuard flags of the ALLOW or DENY type. To get a full list see all flags labeled ‘state’ on this wiki. Unrecognized flags will simply be ignored and a message will be shown in the console.
The second section is about the messages shown to a user when using the claim-command. The messages can use color-codes using the §-symbol, see this resource for a full list. Some messages allow for arguments to be passed in, such as a claim’s name or size for example. This is done by putting the name of the argument between curly braces, for example ‘{region_name}’. Which argument is applicable where is explained in the comment above the message. Not including the argument will work as well, but the message might be less helpful to users.
Donate? :)
If you really like this plugin, you could consider making a one time donation to my PayPal. This allows me to continue improving and expanding the functionality of this plugin!
Questions, bugs or feature suggestions?
Feel free to ask a question about the plugin in the discussion page. If you have an idea how this plugin could be improved let me know!
Hello! I'm looking at using your plugin, but can't make heads or tales of what to do. I just want people to be able to pay for regions, that's it. I understand your plugin uses another plugin called Vault to handle currencies. However Vault itself provides absolutely no resources for utilizing the plugin beyond writing my own plugin.
I've searched for hours for plugins and most either don't support Vault, or are extremely vague with how they work.
All I want is to be able to have some sort of item be paid to claim a region. I've read through many of your replies to people on the forums, and the closest I've gotten is EssentialsX, which is horrifically undocumented relying on the original Essentials documentation and seemingly has no way to automatically grant currency. Not to mention I'd really rather use a physical in-game item than w/e EssentialsX is doing.
All I'm asking is for just one complete example of how to setup your payment system. I'm even happy to buy your premium plugin, but only if I can actually get it to work.
In reply to TheRealDiscordian:
Yes that's correct, Vault itself does not provide an economy plugin, it is merely a necessary bridge you need for plugins like
mine to work together together with your economy plugin.
Through Vault you can literally use any economy plugin on the planet, they will all support Vault. You do not have to use Essentials, it's just one of the popular economy plugins used by a lot of servers. It should definitely have up to date documentation (the plugin is updated really often), even if it might not look like it. I just recommend it as it is a well-known plugin, that many people have experience with.
I think you should be able to get close to what you want with this plugin: https://www.spigotmc.org/resources/the-new-economy.7805/ . Haven't tested it obviously, that's up to you as setting up an economy is completely outside the scope of my plugin and rather a server setup essential.
Should work with my free plugin, if you want more support/updates, you could consider switching to the premium version.
In reply to ericdebouwer:
Thank you so much for the reply and guidance. I'm sorry I put my newbie frustrations on you, and I will definitely be supporting your work in the very near future. If anything because you're clearly very dedicated, kind, and your price is very low
My confusion about economy plugins is I'm not really sure how the classifications work. I felt like I understand Vault allows for a unified API for currency. But then I'm not sure what an "economy plugin" is exactly. I tried a plugin called "Jobs Reborn" but it seems they also need an economy plugin lol.
I will be exploring The New Economy and doing more reading. Thanks again.
In reply to TheRealDiscordian:
Thank you for your kind words, that means a lot to me!
Basically an economy plugin implements the actual economy logic on your server. It is responsible for storing/keeping track of each player's balance, and provides commands to give/take money to players etc.
Vault is indeed a kind of bridge. My plugin asks Vault how much money a player has for example, and the economy plugin then tells Vault the answer. Vault itself doesn't keep track/do economy logic. Yet it is an essential plugin, as it means any plugin in the world can support any economy system in the world implicitly, as both only depend on Vault (instead of me having to depend on every single economy plugin out there).
Hello, i am new to setting up a server and i really want to add a claim system. But i really need an explanation about that. I want to set a price per chunk (like 1 stack of gold) and i want to set a limit for claiming chunks (like 10 chunk). Also itll be good for players to not claim the spawn. And the most importantly, i dont know how to add this plugin to my aternos server and i dont know if theres any requirements. I didnt understand anything from the text above. Please help me...
In reply to cigkofte:
To set a non-money price for claiming you need to find an economy plugin that supports that, see the comment below this. My plugin hooks into Vault, so you can use any economy plugin.
This plugin is more complex than claiming chunks, you can claim any rectangular region. You can configure it's max size (i.e. 16) and the maximum amount (i.e. 10) in the configuration file.
To not claim spawn, just manually put a WorldGuard region on top of spawn; claims cannot go on top of those anyway.
I know nothing of Aternos, only that it has lead to trouble getting things to work before.
Just as a heads up: all of this is very clearly explained in the descriptions above, at least according to the 40k users of this plugin. If you truly don't understand it at all, maybe it 'd be wise to learn a bit more about how setting up a server works before hand, to save you from having to ask everything
hi I wanted to know if you can set the plugin so that users have to pay about 100 iron or something like that to claim the chunck, and then if you can put a claim zone limit
In reply to adextry_:
My plugin hooks into Vault to handle economy related stuff, which means that in theory you can use any form of "currency" as long as you find a plugin that supports it. So you need to look for a plugin that allows iron ingots as a currency and supports vault.
"Claim zone limit" is quite ambiguous. In my plugin you can limit the number of claims a player can make and what size they can be. You can also block off areas for claiming by creating worldguard regions yourself in those areas.
im in that situation where i cannot use the plugin after i have installed it :/
In reply to LangeMath:
I cannot help you without more information. Are there any errors in console? What doesn't work exactly? I can assure you the plugin works if installed correctly.
How can i protect my doors?
In reply to paulohceccon:
Depends on what exactly you define by "protect". If you don't set any flags, WorldGuard will already prevent non-owners from entering/using doors. If your permission group contains the "use" flag, everyone will be able to open doors, so remove that flag if you don't want people to be able to open doors.
If you want more fine grained control (for example setting exactly which group a flag applies to) check out RegionClaimPlus: https://www.spigotmc.org/resources/regionclaimplus-full-recode-extremely-configurable-1-8-1-18.94961/
In reply to ericdebouwer:
Everybody can open doors even with Claim Protection, and i`m just using USE FLAG here:
normal:
amount: 2
price: 0
can-invite: true
size: 50
depth: 256
height: 256
allow-flags:
- use
deny-flags:
- fire-spread
- creeper-explosion
If I remove, nobody even the owner of the land can open doors.
Do you know how can i fix it, please?
In reply to paulohceccon:
If you remove the "use" flag from allow-flags it should work according to WorldGuard's documentation. Make sure NOT to add it to deny flags.
If it doesn't work, then the only way to fix it is by using group based flags, where you apply a flag to only the owners. This feature is only available in RegionClaimPlus (https://www.spigotmc.org/resources/94961/)
In reply to ericdebouwer:
Every time I restart the server the -use goes back to allow-flags by itself.
Do you know how to fix it?
In reply to paulohceccon:
That is very strange. Can you check if it gives any messages in console? Also make sure your configuration is valid, it might be resetting it because it's not valid.
And make sure you don't reload but actually restart, world guard can't handle reloads.
Hello I have à problem how can I allow default group to have a specific max Numbers of claim ?
thanks
In reply to agentRRG:
Sorry for the late reply, I don't check Bukkit often, primarily use Spigot. Simply change the "amount" setting for the permission group in "config.yml". The default permission group is the minimum one, so change it for that one.
I'm trying to create a region, I could select the two positions fine but I can't name it. It gives the error message: "Region names CANNOT contain spaces, up to 20 lowercase letters, numbers, minus(-), underscore (_).
When attempting to name the region I tried:
/claim create Orange
/claim create_Orange
/claim create-Orange
/claim create <Orange>
/claim create<Orange>
I found the plugin through Apex hosting's plugin list. I'm using version 2.2.0.jar - Aug15.2020 release, server is running Paper_1.17
In reply to orange_classic:
Well the message tells you haha, you can only use lowercase letters. In your first command you use uppercase “Orange” so that won’t work. Try “/claim create orange“. As with any plugin, there need to be spaces between the arguments so the second third and last option won’t work (as there is no space between ”create” and the name).
And again, as the message tells you, you cannot use special characters (nor uppercase), which is why the penultimate option fails.