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!
why this plugin not working?
In reply to ivanburyy:
I don't know if you don't provide my any details (mc version, plugin version, errors?, what doesn't work). I can assure you the plugin works if used correctly, I don't know where in the installation you went wrong without any details.
How can I restrict the commands only for operators?
In reply to ras5_gamer:
See my answer on the similar question below (copied here for reference):
To manage permissions properly, you need a permission management plugin. If you don't have one yet, I would highly recommend LuckPerms. With such a plugin you can make permission groups and assign different permissions to those groups (like the permissions from my plugin).
This explanation generalizes btw. You will need a permission management plugin to be able to change the permissions of any plugin.
how to enable pvp on each region ?
In reply to domino_gg:
This is more of a WorldGuard question than something my plugin does, but will try to answer it anyway. There is a world guard flag 'pvp', which if set allows PVP inside a region. For an explanation, see the WorldGuard info on flags. So if you add 'pvp' to the 'allow-flags' of a permission group, people in that group will have pvp set to enabled for their claims.
If you are unsure about how to control which people are in what group, see my explanation in the answer below.
how to change a members permission to claim.admin, claim.max etc.?
In reply to セイバーストライク:
To manage permissions properly, you need a permission management plugin. If you don't have one yet, I would highly recommend LuckPerms. With such a plugin you can make permission groups and assign different permissions to those groups (like the permissions from my plugin).
This explanation generalises btw. You will need a permission management plugin to be able to change the permissions of any plugin.
Hello,
This Plugin would be perfect for my server. Is there a way to allow longer region names?
I realized the way your plugin works by a Script over Mycommand. This script stopted working. So i was pleased to find a simular Pugin witch has the same functions.
My claim regions names are always the Playername_Date. I need this to collect data over a Python script.
I was sad that your plugin just allows 20 characters. Is there a way to allow more? So it can be a Players name and a date code?
Kind regards
Ben
In reply to Rebeqt:
Sadly enough this is not possible. My plugin uses WorldGuard, which imposes a restriction too if I am not mistaken. My plugin also adds stuff to the name, so 20 characters long means it actually 36 (or something like that).
However my plugin already puts the players UUID as a part of the Worldguard region name. So maybe you can adjust the script a little bit? UUID is the proper way to store a link to a player. Try and do /rg info inside a claim to see what I mean.
Does this plugin support me adding more permission groups? Because my permission plugins (luckperms) won't auto-tab fill in the claim permission groups I added. Just double-checking that this is a not supporting auto-tab completion for commands thing and that adding new permission groups does still work.
In reply to lord_grievous07:
No my plugin doesn't allow the addition of more permission groups. I don't currently have the time to work on this plugin (keep in mind I have to do this for free), so I don't know when/if this will be added. For now I would try to do it with just the default three permission levels (maximum, normal, minimum).
Hi we got this plugin just to previde grief and we want eveyone to claim as they want to etc etc so i was asking my self which permissions give and how ? and try to find out by my self but i'm a newbie
someone have the answer? ty !
In reply to Forge_User_41414854:
Just assign everyone to a permission class (claim.max) for example, you do this by giving everyone this permission (if you don't know how to do this, I advise you to use a plugin like LuckPerms) . Then inside the configuration (config.yml) set the allowed claims for the 'maximum' class to a very high number. Now all players can claim as much as they want.
For any more detailed questions, please see the description above, I explain everything in a lot of details. Also read the comments in the config.yml, they explain what certain settings do.
Hi!,
Can this work with a economy plugin, for example the Essentials Economy plugin?
In reply to skygamer34:
Since the last update my plugin already has Vault support (and thus works with any Economy plugin), for more details see https://dev.bukkit.org/projects/regionclaim/files/3033322
In reply to ericdebouwer:
Ok, Thank you!
This an error when me and my friend attempt to invite other people to our claims:
i'm just trying to invite someone to a claim while standing inside the claim and i can't.
Actually i have the latest version (2.1.2) and i'm playing in the version 1.16.1.
Here the error in the console:
[19:30:47] [Server thread/INFO]: KudoaGamer issued server command: /claim invite 1 Caywo
[19:30:47] [Server thread/ERROR]: Could not pass event PlayerCommandPreprocessEvent to MyPermissions v1.0.3
org.bukkit.event.EventException: null
at org.bukkit.plugin.java.JavaPluginLoader$1.execute(JavaPluginLoader.java:311) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
at org.bukkit.plugin.RegisteredListener.callEvent(RegisteredListener.java:70) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
at org.bukkit.plugin.SimplePluginManager.fireEvent(SimplePluginManager.java:588) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
at org.bukkit.plugin.SimplePluginManager.callEvent(SimplePluginManager.java:575) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
at net.minecraft.server.v1_16_R1.PlayerConnection.handleCommand(PlayerConnection.java:1646) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
at net.minecraft.server.v1_16_R1.PlayerConnection.a(PlayerConnection.java:1510) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
at net.minecraft.server.v1_16_R1.PacketPlayInChat.a(SourceFile:36) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
at net.minecraft.server.v1_16_R1.PacketPlayInChat.a(SourceFile:9) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
at net.minecraft.server.v1_16_R1.PlayerConnectionUtils.lambda$0(PlayerConnectionUtils.java:19) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
at net.minecraft.server.v1_16_R1.TickTask.run(SourceFile:18) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
at net.minecraft.server.v1_16_R1.IAsyncTaskHandler.executeTask(SourceFile:144) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
at net.minecraft.server.v1_16_R1.IAsyncTaskHandlerReentrant.executeTask(SourceFile:23) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
at net.minecraft.server.v1_16_R1.IAsyncTaskHandler.executeNext(SourceFile:118) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
at net.minecraft.server.v1_16_R1.MinecraftServer.aZ(MinecraftServer.java:901) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
at net.minecraft.server.v1_16_R1.MinecraftServer.executeNext(MinecraftServer.java:894) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
at net.minecraft.server.v1_16_R1.IAsyncTaskHandler.awaitTasks(SourceFile:127) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
at net.minecraft.server.v1_16_R1.MinecraftServer.sleepForTick(MinecraftServer.java:878) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
at net.minecraft.server.v1_16_R1.MinecraftServer.v(MinecraftServer.java:817) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
at net.minecraft.server.v1_16_R1.MinecraftServer.lambda$0(MinecraftServer.java:155) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
at java.lang.Thread.run(Unknown Source) [?:1.8.0_211]
Caused by: java.lang.NullPointerException
at me.manatorde.mypermissions.Main.onCommandPreProcess(Main.java:420) ~[?:?]
at sun.reflect.GeneratedMethodAccessor35.invoke(Unknown Source) ~[?:?]
at sun.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source) ~[?:1.8.0_211]
at java.lang.reflect.Method.invoke(Unknown Source) ~[?:1.8.0_211]
at org.bukkit.plugin.java.JavaPluginLoader$1.execute(JavaPluginLoader.java:309) ~[craftbukkit-1.16.1.jar:git-Bukkit-7560f5f]
... 19 more
In reply to KudoaGamer:
Oh i already solved it.
i Changed a litle thing in the folder of config. Here the config:
In reply to KudoaGamer:
Glad that solved it! Just for your information: your error was caused by a bug in your permissions plugin MyPermissions v1.0.3 (I can see that from the stacktrace ;) ) not something related to my plugin. If it happens again you could contact them as well or use a different permission plugin.