Feature Request: OrbisGuard Integration

[derrickmehaffy]

Feature Request

Description

Add integration with OrbisGuard, the popular WorldGuard-like region management mod for Hytale.

Use Cases

1. Automatic Region Creation - When a faction claims territory, optionally create corresponding OrbisGuard regions with appropriate flags
2. Protection Delegation - Allow server admins to use OrbisGuard's more granular flag system for faction territories instead of HyperFactions' built-in protection
3. Region Overlap Detection - Prevent factions from claiming chunks that are already protected by OrbisGuard regions (e.g., spawn areas, admin builds)
4. Entry/Exit Integration - Leverage OrbisGuard's entry/exit command flags for faction territory notifications or effects

Proposed Implementation

Soft Dependency

• Detect OrbisGuard at runtime (similar to HyperPerms integration)
• All features work without OrbisGuard installed
• Integration enables additional functionality when present

Configuration Options

{
  "orbisguard": {
    "enabled": true,
    "createRegionsOnClaim": false,
    "respectExistingRegions": true,
    "regionNameFormat": "faction_{faction_name}_{chunk_x}_{chunk_z}",
    "defaultFlags": {
      "build": "members",
      "pvp": "allow"
    }
  }
}

API Integration Points

• Check OrbisGuard regions before allowing claims
• Optionally sync faction membership with OrbisGuard region membership
• Support OrbisGuard's polygonal regions for non-chunk-based faction territories (future)

Benefits

• Leverages OrbisGuard's battle-tested protection system
• Allows admins familiar with WorldGuard to use similar workflows
• Enables more granular control over faction territory permissions
• Compatible with OrbisGuard-Mixins for complete bypass protection

References

• OrbisGuard on CurseForge
• OrbisGuard Mixins (companion module for complete protection)

Priority

Low - This is a nice-to-have integration for servers already using OrbisGuard. HyperFactions' built-in protection system is sufficient for most use cases.

[derrickmehaffy]

TODO: need to talk to the orbisguard maintainer to get their thoughts, this is just a high level feature request. I've done absolutely no discovery.

[derrickmehaffy]

Implementation Status Update

OrbisGuard-Mixins Integration: Mostly Complete

The following hooks have been registered and are functional (when Hyxin + OrbisGuard-Mixins are installed):

• ✅ Harvest hook - F-key rubble/crop pickup protection
• ✅ Pickup hook - Auto pickup protection (pending mixin trigger issue [Bug]: Auto pickup protection not working with OrbisGuard-Mixins #13)
• ✅ Spawn hook - NPC spawn control in zones
• ✅ Detection system with status logging at startup

OrbisGuard API Integration: Not Yet Implemented/Tested

The OrbisGuardIntegration class exists for detecting OrbisGuard regions to prevent claim conflicts, but this has not been fully implemented or tested:

• Claim conflict detection (prevent claiming OrbisGuard-protected regions)
• Region overlap warnings

This issue remains open until the OrbisGuard API integration is completed and tested.