Plot Manager Plugin for Hytale

A comprehensive plot management system for Hytale servers that provides players with customizable land claims in designated plot worlds with full configuration support.

Features

Fully Configurable Grid System - Customize plot size, road width, cell size, and world offset
Multiple Plot Worlds Support - Configure different worlds for plot systems
Custom Spawn Points - Set individual spawn points for each plot with adjustable offsets
Advanced Member Management - Add/remove friends with detailed permission control
Granular Flag System - Leverage Region Manager's complete flag system for plot permissions
Scalable Plot Limits - Configurable per-player plot limits with permission-based overrides
Automatic Region Creation - Integrates with Region Manager for seamless protection setup
Detailed Plot Information - Display ownership, boundaries, and configuration
Custom Data Storage - Store plot-specific data like spawn points and custom settings

Dependencies

Required: Region Manager Plugin - This plugin requires the Region Manager plugin as a dependency for region management functionality.

Configuration

The plugin now features a comprehensive configuration file with the following options:

General Settings

WorldName - Name of the plot world (default: "Plots")
PlotSize - Size of each plot in blocks (default: 51)
RoadWidth - Width of roads between plots (default: 5)
CellSize - Total cell size (plot + road) (default: 56)
OffSet - World offset for plot grid alignment (default: 3)
PlotHeight - Height limit for plots (default: 256)
DefaultSpawnHeight - Default Y coordinate for spawn points (default: 126)

Permission Settings

DefaultMaxPlots - Default maximum plots per player (default: 1)
MaxPlotsForVip - Maximum plots for VIP players (default: 5)

Region Settings

RegionPriority - Default priority for plot regions (default: 10)
AllowPvP - Whether PvP is allowed by default (default: false)
AllowBuildByDefault - Default build permission (default: true)
AllowBreakByDefault - Default break permission (default: true)
AllowInteractByDefault - Default interaction permission (default: true)

Message Settings

PluginPrefix - Plugin prefix in messages (default: "PlotManager")
PrefixColor - Color for plugin prefix (default: "YELLOW")

Spawn Settings

SpawnOffsetX - X offset for spawn points (default: 0.5)
SpawnOffsetZ - Z offset for spawn points (default: 0.5)
UseCenterSpawn - Whether to use plot center as default spawn (default: true)

Commands

Main Commands

/plot or /plots - Main plot command (requires razorplay.plotmanagerplugin.plot.use permission)

Subcommands

Plot Claiming

/plot claim - Claim a plot at your current location (requires razorplay.plotmanagerplugin.plot.claim permission)
- Automatically creates a protected region
- Checks for road placement
- Verifies plot availability
- Enforces configurable plot limits

Plot Information

/plot info - View information about the plot you're standing on (requires razorplay.plotmanagerplugin.plot.info permission)
- Shows owner and members
- Displays plot boundaries
- Shows region flags
- Displays custom plot data

Plot Listing

/plot list - List all your claimed plots (requires razorplay.plotmanagerplugin.plot.list permission)
- Displays all plots owned by the player
- Shows plot names and grid coordinates
- Indicates plot location information

Plot Management

/plot delete - Delete the plot you're standing on (requires razorplay.plotmanagerplugin.plot.delete permission)
- Removes the region protection
- Only works for plot owners or admins
- Clears all plot data

Member Management

/plot member <add/remove> <player> - Manage plot members (requires razorplay.plotmanagerplugin.plot.member permission)
- Add friends to your plot: /plot member add PlayerName
- Remove members: /plot member remove PlayerName
- Members gain configured permissions in the plot
- Supports UUID or player name

Plot Settings

/plot setting <flag> <value> - Change plot settings (requires razorplay.plotmanagerplugin.plot.settings permission)
- Modify region flags using the full flag system (e.g., player.entry, action.build, interact.chest)
- Supports all Region Manager flags
- Example: /plot setting player.entry true
- Example: /plot setting action.build false

Teleportation

/plot home [plot] - Teleport to your plot spawn (requires razorplay.plotmanagerplugin.plot.home permission)
- Teleport to first plot: /plot home
- Teleport to specific plot: /plot home PlotName or /plot home plot_X_Z
- Uses custom spawn if set, otherwise plot center with configured offsets
/plot spawn <set/reset> - Set or reset plot spawn point (requires razorplay.plotmanagerplugin.plot.spawn permission)
- Set spawn at current location: /plot spawn set
- Reset to plot center with offsets: /plot spawn reset

Permissions

Player Permissions

razorplay.plotmanagerplugin.plot.use - Access to plot commands
razorplay.plotmanagerplugin.plot.claim - Claim new plots
razorplay.plotmanagerplugin.plot.info - View plot information
razorplay.plotmanagerplugin.plot.list - List owned plots
razorplay.plotmanagerplugin.plot.delete - Delete owned plots
razorplay.plotmanagerplugin.plot.member - Manage plot members
razorplay.plotmanagerplugin.plot.settings - Change plot settings
razorplay.plotmanagerplugin.plot.spawn - Set plot spawn points
razorplay.plotmanagerplugin.plot.home - Teleport to plot homes

Plot Limit Permissions

razorplay.plotmanagerplugin.plot.plots.1 - Allows 1 plot (default)
razorplay.plotmanagerplugin.plot.plots.2 - Allows 2 plots
razorplay.plotmanagerplugin.plot.plots.3 - Allows 3 plots
razorplay.plotmanagerplugin.plot.plots.4 - Allows 4 plots
razorplay.plotmanagerplugin.plot.plots.5 - Allows 5 plots
razorplay.plotmanagerplugin.plot.plots.6 - Allows 6 plots
razorplay.plotmanagerplugin.plot.plots.7 - Allows 7 plots
razorplay.plotmanagerplugin.plot.plots.8 - Allows 8 plots
razorplay.plotmanagerplugin.plot.plots.9 - Allows 9 plots
razorplay.plotmanagerplugin.plot.plots.10 - Allows 10 plots
razorplay.plotmanagerplugin.plot.plots.unlimited - Unlimited plots

Integration with Region Manager Permissions

Inherits all Region Manager flag permissions (modify/ bypass per flag)
Supports region.admin for administrative access
Uses owners-modify-flags and members-use-global-flags plot settings
Integrates with members-can-invite flag for member management

World Configuration for Plot Worlds

This plugin includes all necessary data for generating a plot world using the Hytale Gen2 world generator. Configure your plot world name in the config file (default: "Plots").

Example world configuration:

"WorldGen": {
    "Type": "HytaleGenerator",
    "WorldStructure": "PlotGrid",
    "PlayerSpawn": {
        "X": 0.5,
        "Y": 126.0,
        "Z": 0.5
    }
}

Plot Protection Features

Owners: Full control over their plots (configurable via owners-modify-flags)
Members: Build/break/interact permissions (configurable per flag)
Non-members: No modification permissions
Road Protection: Automatic protection for road areas
PvP Control: Configurable via player.pvp flag
Entry Control: Configurable via player.entry flag

Advanced Plot Features

Grid Coordinate System: Automatic calculation of plot boundaries
Adjacent Plot Detection: Tools for detecting neighboring plots
Road Detection: Built-in road detection and protection
Custom Data Storage: Extensible data storage for plot enhancements
Cache System: Performance-optimized plot coordinate caching
Automatic Loading: Plots automatically loaded on server start

Technical Details

Region Naming Convention

Plots are automatically named using the format: plot_X_Z where X and Z are grid coordinates.

Data Storage

Plot boundaries stored in region data
Custom spawn points stored in PlotCustomData
Member lists managed by Region Manager
Configuration stored in config file
All data persists through server restarts

API Integration

The plugin integrates with Region Manager API for:

Region creation and deletion via RegionBuilder
Member management through region API
Flag configuration using the comprehensive flag system
Custom data storage for plot-specific information
Priority system for overlapping protections

Performance Features

Coordinate Caching: Caches plot coordinates for fast lookups
Chunk-based Indexing: Optimized spatial queries
Thread-safe Operations: Safe for multiplayer environments
Efficient Loading: Batch loading of existing plots
Minimal Overhead: Lightweight integration with Region Manager

Installation & Setup

Install Region Manager Plugin first
Place Plot Manager JAR in the mods folder
Configure plot world name and settings in config
Restart server
Generate or prepare your plot world
Use /plot claim to start claiming plots

Version Information

Requires Hytale Server API
Compatible with Region Manager 2.0+
Full support for Region Manager's flag permission system

Support

For issues or questions:

Ensure Region Manager is installed and working
Verify you're in the configured plot world
Check permissions with proper flag syntax
Review configuration values in config file
Check server logs for detailed error information