🛡️ Guilds: The Ultimate Guild System for Hytale

🌟 Overview

Welcome to Guilds — a complete guild management plugin for Hytale servers.

Guilds now uses a modern territory model where:

• Regions are the main guild territories.
• Lots are internal parcels inside regions for detailed ownership/rules.

It also includes private guild chat, global guild tag support, economy integrations, placeholders, localized docs, and rank-based internal permissions.

✨ What’s Included (Updated)

• Full guild lifecycle: create, invite, accept/decline, leave, kick, promote/demote, transfer leadership, disband.
• Regions + Lots territory system (replacing old claim-only mindset).
• Region/lot visualization on world map (fully rolled out in v1.2), locate tools for lots, and configurable protection rules.
• Guild chat channel + toggle mode + optional global chat guild tag prefix.
• Economy module with guild bank, lot selling/renting, and lot market settings.
• Placeholder module with %guild_*% placeholders.
• Multi-language support + localized Guilds-README docs (docs/<lang>/Guilds-README.md).

🗺️ Territory Model: Regions vs Lots

Regions

Regions are the core guild territories (macro-level control):

• Claim/unclaim territory.
• Global protection rules for the area.
• Guild ownership and map visualization.

Lots

Lots are subdivisions inside regions (micro-level control):

• Assign/revoke lot ownership.
• Override behavior per lot (based on lotsProtection policy).
• Support lot sale/rent flows when economy is enabled.

This split gives better scalability and organization compared to treating everything as a single “claim” concept.

💰 Economy Module (with Compatible Bridges)

Economy works when economy.enabled=true and a supported bridge is available.

Supported economy bridges

• VaultUnlocked (vaultunlocked)
• EcoAPI (ecoapi)
• Ledger (ledger)

If economy.bridge=auto, Guilds tries: vaultunlocked → ecoapi → ledger.

Economy features

• Guild bank: balance, deposit, withdraw, logs.
• Withdraw safeguards (revert on provider payout failure).
• Daily withdrawal limits (economy.bank.dailyWithdrawDefault).
• Lot economy actions: sell, buy, rent offer/accept/pay/cancel.
• Lot market controls: tax, expiration, listing limits, tax destination.

🧩 Placeholder Module

Guilds integrates with PlaceholderAPI-style placeholders (reflection-based, no hard dependency), including:

• %guild_name%
• %guild_tag%
• %guild_rank%
• %guild_leader%
• %guild_member_count%
• %guild_online_count%
• %guild_claims%
• %guild_lots%
• %guild_bank_balance%
• %guild_provider%
• %guild_preferred_economy%

📚 Documentation & Localization

Guilds ships with localized language files and localized docs to improve onboarding:

• mods/Guilds/lang/*.lang
• mods/Guilds/docs/<language>/Guilds-README.md

Available docs/language coverage includes: pt-BR, en-US, es-ES, fr-FR, it-IT, ja-JP, zh-CN, de-DE.

🆕 v1.3 Highlights

• Introduced the first public iteration of the Diplomacy Module.
• Added alliance/enemy/neutral relationship flows and relations overview commands.
• Added allied chat channel support for coalition communication.
• Added conflict-state integration as the base for future war progression improvements.
• Applied a global stability pass with fine-tuning and bug fixes.

Diplomacy Module (Detailed Scope)

Current diplomacy release includes:

• /guild ally to send/accept alliance requests.
• /guild enemy to declare hostility.
• /guild neutral to reset diplomacy state.
• /guild relations to inspect active relationships and war status context.
• /guild allychat and /guild allytoggle for allied-channel communication.

This is an initial milestone and still evolving. Minor bugs or edge-case inconsistencies may still occur while we continue expanding and balancing diplomacy.

⚠️ Version Compatibility Policy (Hytale)

Hytale now requires exact game-version matching for mod compatibility.

Guilds policy:

• Always target the latest stable release.
• No default targeting of pre-release game versions.
• Future alternative builds may be published with explicit naming (example: 1.3-pre-release) if needed.

⚔️ Commands (Complete)

Default root command is /guild (aliases can include /guilds and /g).

Basics

• /guild help [page]
• /guild create <name> <tag>
• /guild disband
• /guild info [guild]
• /guild list
• /guild spawn
• /guild setspawn

Members and Ranks

• /guild invite <player>
• /guild accept <guild>
• /guild decline <guild>
• /guild invites
• /guild leave
• /guild kick <player>
• /guild promote <player>
• /guild demote <player>
• /guild transfer <player>
• /guild members
• /guild chat <message>
• /guild gc <message>
• /guild toggle
• /guild radar <on|off>

Territory (Regions)

• /guild region or /guild claim
• /guild unregion or /guild unclaim
• /guild region info or /guild claim info
• /guild region list or /guild claim list
• /guild region ui or /guild region visual

Territory (Lots)

• /guild lot enable
• /guild lot disable
• /guild lot info
• /guild lot assign <player>
• /guild lot revoke
• /guild lot locate [off]

Economy (Bank)

• /guild bank
• /guild bank deposit <amount>
• /guild bank withdraw <amount> [player]
• /guild bank log [page]

Economy (Lot Market / Rent)

• /guild lot sell <price>
• /guild lot buy
• /guild lot rent offer <price> <days> [grace]
• /guild lot rent accept
• /guild lot rent pay
• /guild lot rent cancel

Lot Rule Controls

• /guild lot rules
• /guild lot set <rule> <inherit|allow|deny>

Admin / Staff

• /guild admin set <setting> <on|off>
• /guild admin list

⚙️ Permission Nodes (pattern)

Guilds uses permission nodes in the format:

guilds.command.<subcommand>

Examples:

• guilds.command.create
• guilds.command.invite
• guilds.command.claim
• guilds.command.region
• guilds.command.lote
• guilds.command.bank
• guilds.command.admin
• guilds.command.spawn
• guilds.command.setspawn

Build your guild community with more control, better progression, and clearer territory management.

Developed by CrystalOcean