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!
This an error were receiving when attempting to invite people to our claims. https://gyazo.com/c686ff0f35b6fb3129326f3fb6887a2a
Were just trying to invite someone to a claim whilst standing inside the claim and no luck any idea?
In reply to pogchompers:
First of all make sure you are using the newest version, as I fixed something similar recently. Download the latest file in the top right corner. If the error still continues to exist, could you send me the actual error trace from the server log (console/terminal window)? Or even better, just send logs/latest.log (in your server folder) after this happens. This way I can see what precisely caused this error.
In reply to ericdebouwer:
Thank you very much for sending this to me, it was indeed a bug which could happen in exceptional cases. It is now fixed in version 2.1.2. I have uploaded the new version here, but as Bukkit takes some time for it to be approved (1-2 days usually), you can also get it directly from its spigot page.
Hi, is it possible to claim land in the nether?
In reply to Alexplumbridge:
Yes I am fairly sure it is! For Bukkit the nether is just another world and my plugins works with multiple worlds. All claim settings/allowed amount will be *per world*, so if someone may make 3 claims, that means 3 in the normal world and 3 in the nether. If you want to alter this, you can use per world permissions (luckperms supports this for example).
Is there a way to add more permission
for example, I would like to have min,medium,max and builder.
I tried in the config file to add another "option" and it didn't work:
# refers to the group of users who have permission claim.builder
builder:
amount: 10
can-invite: true
size: 999999
allow-flags:
- use
deny-flags:
- fire-spread
- mob-damage
- pvp
I am new with config file and things like that, so thanks to help me!
(also didn't know what you were talking about by "discussion page", so sorry for asking here)
sorry for my english
In reply to Erag0n001:
No, unfortunately there isn't. I tried implementing a variable amount of permission classes, but I eventually chose not to continue it. I noticed it made the config section a lot more difficult. But most importantly it broke permission manager plugins as those require a plugin to specify it's permission on forehand which was impossible this way.
PS: It is completely fine to post stuff here! The message about the discussion page was meant for my spigot plugin page were that thing actually exists :). I removed it from the text as it was indeed confusing.
It will work for 1.15.2 ?
In reply to javitomate:
Yes it definitely will! This plugin was made and tested on 1.15.2. You can see the versions next to the download link on the file page (1.15 also means 1.15.2 compatibility in general)
In reply to ericdebouwer:
Hello again! I get this error when they invite friends to their land
''An internal error occurred while attempting to tab-complete this command''
I checked the settings but couldn't figure it out, HEEEEEELP ME:(!!!
In reply to javitomate:
Did one of the player's on your server recently change his/her minecraft name? Or have you whitelisted/opped people who have never been on your server? Also could you look into the stacktrace of the error printed in the console of your server. Does it say something like
because than I think I found out what is going wrong.
In reply to ericdebouwer:
I have attached the error on the server and I still can't solve it: I do not know what to do :(.
https://prnt.sc/spy24o
In reply to javitomate:
No that is still the same non-informational default bukkit error message :). Please look into your server terminal /console (where you launch the server from). So not in game. There should be a detailed error message there. Could you paste/print screen that please?
In reply to ericdebouwer:
That is the error that the console shows!
https://prnt.sc/sqfmp8
https://prnt.sc/sqfp49
https://prnt.sc/sqfpmz
In reply to javitomate:
Fixed it! Thank you for pointing this bug out to me. The new version can be downloaded from the spigot page directly. I also uploaded it to Bukkit, but it usually takes about a day to process and I can imagine you would like a working version now :).
Having an issue where when I use "/claim show" it makes the server freeze and maxes out the servers ram. No problems with the other commands tho :S very nice plugin aswell gj
In reply to Forge_User_02909250:
Yes the show command is by far the most server-intense one, due to the particles it has to show. I am however quite surprised that that already lags out the server though. On both my testing servers it usually doesn't cause much lag spikes. How large are the claims you are using /claim show on? Because I just looked at the code and the larger the claim the more particles shown (Might fix that later). But if that already lags your server, don't you have problems with many other plugins as well :)? Because showing particles is still nothing compared to listening to many events etc. How many RAM does your server have? And maybe you can install a plugin like LaggRemover? That fixes a lot of wrong ram allocation. Also did the lagg increase/start after the new update of my plugin?
In reply to Forge_User_02909250:
Please check the updated version! Available on spigot now (version 2.1.1) and here in about a day when it is approved. I reduced the amount of particles by about 80% so I hope that will massively reduce lag.
hello! i really like your plugin but would like to set a claim block limit? is there any way to do this
In reply to lolten278:
Yes that is definitely possible! In the config.yml you can set a max claim size for each different permission level. Setting that to 80 for example allows players in that rank to claim an area with a max size of 80 by 80 blocks (in x and z-axis). Is this what you were looking for?