HyGuard - Claims / Regions

A plugin that manage player claims and/or admin regions. We hope it may help.

Config File - V1.1.1

MapRefreshTick: 100 How often to refresh the world map (expressed in after tot tick refresh)

PlayerMaxChunks = 4; Max player claim limit

PlayerChunksCanDetach = false; In the chunks in the player region can be disconnected to one another

PlayerChunksDecay = false; If the chunks auto-delete if player dont log in for a tot time

WorkbenchChestRadius = 14; Radius of workbench detecting items in chests

Current Commands

/hg Open the claim GUI (Still work in progress)

/hg claim Claim your chunks

/hg unclaim Unclaim your chunks

/hg trust {player} Trust a player to edit your chunk

/hg untrust {player} Untrust a player to edit your chunk

/hg ban {player} Ban a player from entering your chunk

/hg unban {player} Unban a player from entering your chunk

/hg funclaim {region} [ADMIN COMMAND] Force unclaim a chunk

/hg fclaim {region} [ADMIN COMMAND] Force claim a chunk

/hg fclaim {region} [ADMIN COMMAND] Force claim a chunk

/hg region tp {region} [ADMIN COMMAND] Teleport to a region

You can create admin-regions! Those are totally configurable! After all the claims are a custom preset of this regions!

/hg region create {region}

/hg region delete {region}

/hg region group create {region} {group}

/hg region group delete {region} {group}

/hg region group add {region} {group} {player}

/hg region group remove {region} {group} {player}

/hg region group remove {region} {group} {player}

/hg region group permission add {region} {group} {permission} {DENY/ALLOW}

/hg region group permission remove {region} {group} {permission}

Current Events

event.movement

event.breakblock

event.placeblock

event.interact

Added API Support - V1.1.1

MAVEN IMPLEMENTATION

Add the file in the lib config in the main project directory

<dependency> <groupId>it.hytale</groupId> <artifactId>HyGuard</artifactId> <version>1.1.0</version> <scope>system</scope> <systemPath>${project.basedir}/lib/HyGuard-1.1.0.jar</systemPath> </dependency> API METHODS

public interface IRegionManager {

CompletableFuture<Void> create(Ref<EntityStore> ref, String regionName);

CompletableFuture<Void> delete(Ref<EntityStore> ref, String regionName);

CompletableFuture<Void> teleport(Ref<EntityStore> ref, Player player, String regionName);

void decay(String regionName);

}

public interface IPermissionManager {

CompletableFuture<Void> remove(Ref<EntityStore> ref, String regionName, String groupName, String permission);

CompletableFuture<Void> add(Ref<EntityStore> ref, String regionName, String groupName, String permission, State state);

}

public interface IGroupManager {

CompletableFuture<Void> create(Ref<EntityStore> ref, String regionName, String groupName);

CompletableFuture<Void> delete(Ref<EntityStore> ref, String regionName, String groupName);

CompletableFuture<Void> add(Ref<EntityStore> ref, String regionName, String groupName, UUID targetUuid);

CompletableFuture<Void> remove(Ref<EntityStore> ref, String regionName, String groupName, UUID targetUuid);

}

If you are using SimpleClaim and want to use this plugin i made a python converter of the config regions, you can run this in google.colab if you want, here the code:

import json

from collections import defaultdict

input_path = "/content/Claims.json"

output_path = "/content/Regions.json"

with open(input_path, "r", encoding="utf-8") as f:

data = json.load(f)

regions_map = defaultdict(lambda: {

"UUID": None,

"Region": None,

"Chunks": [],

"Groups": [],

"IsFullChunkOnly": True,

"IsOverlapable": True,

"IsOverlapping": False,

"IsDecayable": False,

"Priority": 0,

"MapColor": 16092226,

"Title": None

})

for dim in data.get("Dimensions", []):

dimension_name = dim.get("Dimension", "default")

for chunk in dim.get("ChunkInfo", []):

owner_uuid = chunk.get("CreatedTracker", {}).get("UserUUID")

chunk_x = chunk.get("ChunkX")

chunk_z = chunk.get("ChunkY")

username = chunk.get("CreatedTracker", {}).get("UserName", "Unknown")

title = f"{username} Claim"

region_name = title.replace(" ", "")

if regions_map[owner_uuid]["UUID"] is None:

regions_map[owner_uuid]["UUID"] = owner_uuid

regions_map[owner_uuid]["Region"] = region_name

regions_map[owner_uuid]["Title"] = title

regions_map[owner_uuid]["Groups"] = [

{

"Permissions": [

{"State": "DENY", "Permission": "event.breakblock"},

{"State": "DENY", "Permission": "event.placeblock"},

{"State": "DENY", "Permission": "event.interact"}

],

"Players": [],

"Group": "DEFAULT",

"Priority": 0

},

{

"Permissions": [

{"State": "ALLOW", "Permission": "event.breakblock"},

{"State": "ALLOW", "Permission": "event.placeblock"},

{"State": "ALLOW", "Permission": "event.interact"}

],

"Players": [{"UUID": owner_uuid}],

"Group": "trust",

"Priority": 10

},

{

"Permissions": [

{"State": "DENY", "Permission": "event.movement"}

],

"Players": [],

"Group": "ban",

"Priority": 10

}

]

regions_map[owner_uuid]["Chunks"].append({

"X": chunk_x,

"Z": chunk_z,

"World": dimension_name,

"Offsets": []

})

regions = list(regions_map.values())

output = {"Regions": regions}

with open(output_path, "w", encoding="utf-8") as f:

json.dump(output, f, indent=2, ensure_ascii=False)

For the BUG that player can steal from claimed chest using workbench consider installing AntiWorkBenchDetectChest as a temporary countermeasure!