Residence Limits
Residence Limits
This plugin allows for a few simple restriction checks when someone creates a residence. Currently Residence allows for per group maximum residence sizes, but doesn't limit the minimum size a player can make allowing for small residences to be created and used as an exploit with flags.
Features
- Restrict residence minimum size by simple directions:
- The X direction (East / West)
- The Y direction (Up/Down)
- The Z direction (North/South)
- Restrict residence minimum size by blocks in plane:
- The XZ plane (Flat Ground Size, most common)
- The XY plane (Vertical Plane East / West)
- The YZ plane (Vertical Plane North / South)
- Restrict residence minimum size by total overall size
Dependencies
Commands
None. Simply set your values up in the config and your done
Permissions
- resLim.override : lets the group or user ignore the minimum set restrictions when creating residences.
Configuration
Put the file in your plugins folder and start/restart server to generate the default config file. You can also simply copy this into a config.yml file and put it into a plugin folder name "ResidenceLimits"
Global: res_x_limit: 16 use_x_limit: true res_y_limit: 5 use_y_limit: true res_z_limit: 16 use_z_limit: true res_xz_limit: 50 use_xz_limit: false res_xy_limit: 1 use_xy_limit: false res_yz_limit: 1 use_yz_limit: false res_total_size: 25 use_total_size: false
Setup / Usage
To require a minimum say in the X direction you would need to specify "resxlimit" to be that minimum number. If you want the plugin to actually use this direction (or plane/ size in the other cases) you need to set it's use flag to true, which is "usexlimit".
In the above example the X, Y, Z limits are 16 , 5 , 16 respectively and their 'use" is set to true, meaning when the plugin goes to check for direction values upon someone attempting to create a residence it will make sure that the minimum in each of those directions is at least the amount set in the config.
For the planes and total size these are simply the combined (multiplied) size of the two sides (or all 3 in the total size) in the plane. So if the "resxzlimit" is set to say 40 and it's "use" is set to true then as long as the X and Z directions multiplied have greater than 40 it should pass the minimum.
Future Ideas
-Add restrictions for 1 or more residences that can have subzones bought from. (IE You have a large residence set as the main residence and you want to restrict the amount of subzones purchased / owned to a set amount)
-Post in the ticket section and see if I add it here.
Known Bugs
- None as long as the config is setup with proper values (Numbers for limits and a true/false for usage)
-Add restrictions for 1 or more residences that can have subzones bought from. (IE You have a large residence set as the main residence and you want to restrict the amount of subzones purchased / owned to a set amount)
+1
I would love this right now. And totally understand waiting until res3.0. If it ever happens.
I'll probably look into expanding this plugin if Residence ever updates to 3.0, but as it stands I probably won't be doing anything further with this until Residence 3.0 at the least
@xclucky
It doesn't restrict subzones, Residence api doesn't provide that ability.
For me this old version dosn't work on 1.2.5, feel free to download/modify/use this ported to new 1.2.5 Event version:
http://mc.dlk.pl/resminlimit.jar
Will this also restrict the minimum size of a subzone? I only ask because during my tutorial I created subzones (which reset every 10 minutes from another plugin) on certain trees and not on others, that way I don't have to reset such a large area.
@burtthaman
That is already a part of residence. I would suggest looking up on the Residence wiki on how to do this. This plugin focuses on making sure users create residences with a minimum size.
I meant instead of typing out coors etc for a residence you break a block in one corner then walk to other corner and break a block then all blocks in between (a square shape) get claimed
@burtthaman
Could you elaborate a little more burtthaman? Do you mean a command to clear a residence of it's blocks?
As far as spout goes, I have yet to look into their API to see what it's capable of. I have seen spout GUI's though for commands.
This is a great idea :-). Another plugin idea... Have a command to break blocks for insertion points of claim boundaries rather than typing.
A spout GUI for commands would be a crazy addon :-)