← Back to documentation

Server documentation

BetterClaim

Active

Hytale • Version 1.5.1

Complete setup guide for server owners: commands, hierarchical permissions, configuration reference, and admin workflows.

Every BetterClaim command, permission node, config option, and common setup pattern for Hytale server owners.

Inspired by SimpleClaims.


Overview

BetterClaim lets players own individual chunks, manage parties with a full GUI, mark admin deny zones, set homes inside claims, and sync claim colors on /bc and the world map (M). Data persists in SQLite per world save.


Installation

  1. Download BetterClaim-1.5.1.jar from the CurseForge Files tab
  2. Place the JAR in your server’s mods/ folder (or Hytale user mods folder for singleplayer)
  3. Start the server, config is generated at plugins/BetterClaim/config.json
  4. Grant permissions to your player groups (see Permissions below)
  5. Use /bc in-game to open the BetterClaim hub (or the claim map directly if useBcHubUi is false)

Optional: install LuckPerms so dynamic nodes (betterclaim.limit.N, betterclaim.playtime.N, betterclaim.admin.max-add-limit.N) resolve with inherited group permissions. Without LuckPerms, BetterClaim uses the native Hytale permission providers (same as 1.2.x).

Singleplayer: use /perm group add OP betterclaim.gui (and other nodes as needed) to grant yourself access.


Admin Commands

Main command: /bc (alias: /betterclaim)

Player commands are listed on the mod overview page.

CommandDescription
/bc adminOpens the admin player list GUI
/bc admin playersSelect a target player for admin actions
/bc admin chunkOpens the claim map in admin mode for the selected target
/bc admin partyEdit any party as admin
/bc admin claimClaims the current chunk for the selected target player
/bc admin unclaimUnclaims the current chunk for the selected target player
/bc admin overrideToggles bypassing claim limits and full claim protection while using admin tools
/bc admin denyzoneOpens the deny zones admin GUI (recommended)
/bc admin denyzone startStarts deny zone selection (map or chat)
/bc admin denyzone cancelCancels an in-progress selection
/bc admin denyzone confirm <name>Saves the region after both corners are set
/bc admin denyzone pos1Saves corner 1 (current chunk or via map)
/bc admin denyzone pos2Saves corner 2 of a no-claim rectangle
/bc admin denyzone create <name>Creates a persisted zone from pos1 + pos2 (legacy flow)
/bc admin denyzone listLists all claim-denied regions
/bc admin denyzone remove <name>Removes a claim-denied region
/bc admin set-limit <player> <limit>Sets a persistent claim limit override
/bc admin add-limit <player> <amount>Adds bonus claim chunks to a player
/bc admin create-party <player> [name]Creates a party for a player

Admin chunk mode: run /bc admin players first to select a target, then use /bc admin chunk or the admin claim/unclaim commands.


Deny zones (claim-denied regions)

Rectangular areas where players cannot create new claims. Admins with betterclaim.admin or betterclaim.admin.chunk can create and remove zones.

  1. /bc admin → open Deny zones
  2. Click Start — opens the selection map centered on your position
  3. Click two chunks (corner 1 and corner 2). Works on wilderness and already-claimed chunks
  4. Use Back to return to the admin panel (selection stays active)
  5. Enter a name and click Save

While selecting, an orange preview appears on the /bc map and on the in-game world map (M key). Saved zones do not keep permanent preview particles.

Alternative flow (chat)

/bc admin denyzone start
/bc admin denyzone pos1    # or click on the map
/bc admin denyzone pos2
/bc admin denyzone confirm MyZone

To cancel: /bc admin denyzone cancel or the GUI equivalent.

Maintenance commands

  • /bc admin denyzone list — list saved zones
  • /bc admin denyzone remove <name> — remove a zone

Permissions

BetterClaim uses hierarchical permissions. Granting a parent node also grants all its children.

Command Permissions

PermissionGrants access to
betterclaim.gui/bc: territory map GUI
betterclaim.claim/bc claim and claim clicks in GUI
betterclaim.unclaim/bc unclaim and unclaim clicks in GUI
betterclaim.home/bc sethome, /bc home, /bc delhome, /bc homes
betterclaim.partyAll party subcommands (parent node)
betterclaim.party.edit/bc party: party GUI
betterclaim.party.create/bc party create
betterclaim.party.invite/bc party invite
betterclaim.party.accept/bc party accept
betterclaim.party.decline/bc party decline
betterclaim.party.leave/bc party leave
betterclaim.party.kick/bc party kick
betterclaim.party.transfer/bc party transfer
betterclaim.party.disband/bc party disband
betterclaim.adminAll admin subcommands (parent node)
betterclaim.admin.players/bc admin, /bc admin players
betterclaim.admin.chunk/bc admin chunk
betterclaim.admin.party/bc admin party
betterclaim.admin.claim/bc admin claim
betterclaim.admin.unclaim/bc admin unclaim
betterclaim.admin.override/bc admin override
betterclaim.admin.set-limit/bc admin set-limit
betterclaim.admin.add-limit/bc admin add-limit
betterclaim.admin.create-party/bc admin create-party

Dynamic Permissions

When a player has multiple matching nodes, the highest value wins.

PermissionDescription
betterclaim.limit.NBase claim limit per player (e.g. betterclaim.limit.10 = 10 chunks). Highest matching value wins.
betterclaim.playtime.NMinutes of playtime per bonus chunk (e.g. betterclaim.playtime.120). Highest matching value wins; overrides config when greater than 0.
betterclaim.admin.max-add-limit.NMaximum total claim limit reachable via /bc admin add-limit for that admin.

Limit Calculation Order

  1. Admin /bc admin set-limit override (database): highest priority
  2. Permission betterclaim.limit.<N> (highest value)
  3. Config defaultClaimLimit
  4. Playtime bonus chunks (if enabled)
  5. Admin /bc admin add-limit bonus chunks
  6. Capped by config maxClaimLimit (unless admin override mode is active)

Quick Setup with Hytale /perm

Default players (Adventure group example):

/perm group add Adventure betterclaim.gui
/perm group add Adventure betterclaim.claim
/perm group add Adventure betterclaim.unclaim
/perm group add Adventure betterclaim.home
/perm group add Adventure betterclaim.party
/perm group add Adventure betterclaim.limit.10

Staff / admins (OP group example):

/perm group add OP betterclaim.admin

LuckPerms

BetterClaim declares LuckPerms as an optional dependency. Command checks still go through Hytale’s PermissionsModule (LuckPerms registers as a provider). Dynamic numeric nodes (betterclaim.limit.N, betterclaim.playtime.N, betterclaim.admin.max-add-limit.N) use LuckPerms inherited permissions when LuckPerms is active, so VIP groups and inheritance work as expected.

Example setup:

/lp group default permission set betterclaim.gui true
/lp group default permission set betterclaim.party true
/lp group default permission set betterclaim.limit.10 true
/lp group vip permission set betterclaim.limit.20 true
/lp group admin permission set betterclaim.admin true
/lp user <player> permission set betterclaim.playtime.120 true

After changing LuckPerms data, run /lp sync (or your usual reload) and re-check limits in /bc.


Configuration

Config file: plugins/BetterClaim/config.json (auto-generated on first run)

Claim Limits

OptionDefaultDescription
defaultClaimLimit5Starting claim limit per player
maxClaimLimit50Hard cap on total claims (unless admin override)
enablePlaytimeClaimGaintrueEnable bonus chunks from playtime
claimGainMinutes600Minutes of playtime per bonus chunk
enableAdjacentClaimsfalseRequire new claims to touch an existing claim (first claim is free)
creativeBypassProtectiontrueCreative mode players ignore claim protection
worldNameBlacklistForClaiming[]World names where players cannot claim (exact match)
scaleClaimLimitByPartyMembersfalse(unused) Legacy config flag
showPartyTotalClaimsfalseShow party total instead of personal count in GUI

Party

OptionDefaultDescription
maxPartyMembers10Maximum members per party
maxPartyAllies-1Maximum allies (-1 = unlimited)
enableAllySystemtrueEnable player/party allies
enablePartyInactivityDisbandfalseDisband parties when the owner exceeds the inactivity threshold
partyInactivityDisbandDays30Days of owner inactivity before auto-disband
partyInactivityCheckIntervalMinutes60How often the server runs the inactivity check (minimum 5)

Zone Titles & Sounds

OptionDefaultDescription
wildernessNameWildernessName shown for unclaimed areas
titleTopText(empty)Optional text shown above zone titles
personalClaimSubtitlePersonal ClaimSubtitle for personal claims
enableZoneTitlestrueShow zone title on entry
showWildernessZoneTitletrueShow title when entering wilderness
enableClaimEntrySoundtruePlay sound on claim entry
claimEntrySoundOncePerZonetrueOnly once per zone visit
claimEntrySoundIdSFX_Discovery_Z1_ShortSound ID

Map & Visuals

OptionDefaultDescription
enableCustomMaptrueTerrain map in /bc GUI
mapOverlayAlpha0.5World map claim overlay opacity
guiMapResolutionScale0.75GUI map resolution (0.1–1.0)
guiMapCacheTtlSeconds120Map image cache TTL in seconds
enableParticleBorderstrueParticle borders at chunk edges
useBcHubUitrue/bc opens the hub (map / party / create) instead of the claim map only

Homes

OptionDefaultDescription
maxHomes5Maximum homes per player
homeCooldownSeconds5Teleport cooldown

Global Protection

OptionDefaultDescription
protectBucketstrueBlock outsider fluid placement and container refill in protected claims
protectBenchestrueProtect crafting benches
isolateCraftBenchMaterialstrueBench crafts only use the player’s inventory plus nearby chests they may access
protectTamedEntitiestrueBlock outsider damage to tamed NPC roles inside claims (party flag applies)
tamedEntityRoleIdentifiersTamed_NPC role name prefixes treated as tamed companions
blocksThatIgnoreInteractRestrictionsgravestone, tombstone, corpse, loot_chestBlocks always interactable

Default Party Protection (new parties)

OptionDefaultDescription
defaultPartyBlockPlaceEnabledfalseAllow non-members to place blocks
defaultPartyBlockBreakEnabledfalseAllow non-members to break blocks
defaultPartyBlockInteractEnabledfalseAllow non-members to interact with blocks
defaultPartyPVPEnabledfalseAllow PVP in party claims
defaultPartyFriendlyFireEnabledfalseAllow friendly fire between members
defaultPartyInteractChestfalseAllow non-members to open chests
defaultPartyInteractDoorfalseAllow non-members to use doors
defaultPartyInteractBenchfalseAllow non-members to use benches
defaultPartyInteractChairfalseAllow non-members to use chairs
defaultPartyInteractPortalfalseAllow non-members to use portals
defaultPartyTamedDamageEnabledfalseAllow non-members to damage tamed entities

Party Owner Toggles

OptionDefaultDescription
allowPartyPlaceBlockSettingtrueOwner can toggle block placing for non-members
allowPartyBreakBlockSettingtrueOwner can toggle block breaking for non-members
allowPartyInteractBlockSettingtrueOwner can toggle block interaction for non-members
allowPartyPVPSettingtrueOwner can toggle PVP
allowPartyFriendlyFireSettingtrueOwner can toggle friendly fire
allowPartyInteractChestSettingtrueOwner can toggle chest access
allowPartyInteractDoorSettingtrueOwner can toggle door access
allowPartyInteractBenchSettingtrueOwner can toggle bench access
allowPartyInteractChairSettingtrueOwner can toggle chair access
allowPartyInteractPortalSettingtrueOwner can toggle portal access
allowPartyTamedDamageSettingtrueOwner can toggle tamed entity damage

Example config.json

{
  "configVersion": 28,
  "useBcHubUi": true,
  "worldNameBlacklistForClaiming": [],
  "tamedEntityRoleIdentifiers": ["Tamed_"],
  "defaultClaimLimit": 5,
  "maxClaimLimit": 50,
  "enablePlaytimeClaimGain": true,
  "claimGainMinutes": 600,
  "enableAdjacentClaims": false,
  "creativeBypassProtection": true,
  "enablePartyInactivityDisband": false,
  "partyInactivityDisbandDays": 30,
  "partyInactivityCheckIntervalMinutes": 60,
  "maxPartyMembers": 10,
  "maxPartyAllies": -1,
  "enableAllySystem": true,
  "enableCustomMap": true,
  "enableParticleBorders": true,
  "maxHomes": 5,
  "homeCooldownSeconds": 5
}

See the full default config inside plugins/BetterClaim/config.json after first launch.


Notes

  • GUI claim/unclaim requires betterclaim.claim / betterclaim.unclaim. Party members always claim personal chunks: no separate party claim permission.
  • Admin chunk mode requires selecting a target first with /bc admin players.
  • Admin override requires betterclaim.admin.override and bypasses limits and protection.
  • Claim-denied regions are stored in SQLite and block player claims in the marked rectangle.
  • Deny zones do not block players from walking through; they only prevent new claims in the area.
  • Set useBcHubUi to false if you prefer /bc to open the claim map directly (legacy behavior).
  • Worlds listed in worldNameBlacklistForClaiming reject new claims with an in-game message.
  • With LuckPerms installed, check the server log for LuckPerms detected on startup when dynamic limits should use group inheritance.
  • Disbanding a party keeps claims. They remain owned by individual players (including auto-disband from owner inactivity).
  • Party inactivity disband is disabled by default; enable enablePartyInactivityDisband and set partyInactivityDisbandDays to activate it.
  • Database location: universe/BetterClaim/BetterClaim.db (inside your world save)

License

MIT License. Copyright (c) 2026 DurkzPRG