Piggy Admin

A server-side administration mod designed to help manage and enforce settings for compatible client-side mods (like Piggy Build and Piggy Inventory). Currently, it serves as a central point for managing anti-cheat options, logging, and detection, but it will evolve to include more administration tools.

---

⚠️ Disclaimer

This is a personal project. It comes AS IS and might cause issues.

• No Support: Do not expect regular support or bug fixes.
• No Forge Port: There are NO plans to port this mod to Forge.
• Use at your own risk.

Feel free to fork the project or submit a Pull Request if you want to contribute fixes or features!

---

Features

🛡️ Anti-Cheat Enforcement

• Centralized Control: Configure whether "cheat" features (like fast placement, tool swapping) are allowed on your server.
• Automatic Sync: When a player joins, the server's anti-cheat configuration is automatically sent to their client.
• Strict Enforcement: If the server disables cheats, client-side overrides are ignored, ensuring fair play.
• Granular Control: Enable/disable specific features individually (e.g., allow tool swapping but forbid fast placement).

🕵️ Advanced X-Ray Detection

Piggy Admin uses a multi-layered heuristic engine to detect suspicious mining patterns without false positives from branch mining.

• Ore Cache Manager: Asynchronously tracks valuable ore locations in an efficient ConcurrentHashMap, minimizing main-thread impact.
• Vector Correlation: Uses HeuristicsMathUtil to calculate the mathematical correlation between a player's look vector and the distance to invisible ores.
• Hybrid Detector: Combines raw mining ratios with semantic analysis of "suspicious turns" and "direct-to-ore" paths.
• Sensitivity Levels: From LOW (relaxed) to PARANOID (strict), configurable via xraySensitivity.
• Admin Alerts: Real-time notifications for admins with clickable teleport links to the suspect's coordinates.

📜 Forensic Data & Attribution

The mod acts as a powerful investigation tool for griefing.

• Explosion Attribution: Tracks the true owner of TNT, even if sparked by a flint-and-steel, fire charge, or other entities.
• Creeper Ownership: Identifies players who intentionally ignite creepers (using Flint & Steel) to destroy territory.
• Lava & Fire Blame: Specialized trackers for fluid flow and block-fire spread. Even if the original source block is gone, the mod maintains a history of who placed it.
• Dispenser Tracking: Custom mixins at the dispenser level attributes all dispensed projectiles or bucket operations to the player who placed or last interacted with the dispenser.
• Interactive Notifications: AdminNotifier sends rich, hoverable chat components to OPs, allowing for instant "Blame Lookup" directly from an alert.

📜 Moderation Engine

• AI-Powered Moderation: Integrates with Google Gemini AI to automatically filter toxic or inappropriate chat and sign text.
• Dynamic Rule System: Define custom moderation rules and categories (e.g., Profanity, Harassment, Hate Speech).
• Performance Optimized: Includes a high-performance cache and rate-limiting system to minimize API latency and handle free-tier API limits gracefully.
• Hybrid Checking: Combines fast local Regex checks with deep semantic analysis from Gemini.
• Categorized Logs: All blocked messages are logged with their specific category for easy review.

🤖 Gemini AI Setup

To use the AI moderation features, you need a Google Gemini API Key.

1. Get an API Key: Visit the Google AI Studio and create a free API key.
2. Configure the Mod:
   • Start the server once to generate the config file.
   • Open config/piggy-admin-server.json.
   • Paste your key into the "geminiApiKey" field.
   • Set "moderationEnabled": true.
3. Advanced Options:
   • geminiModel: defaults to gemini-1.5-flash (recommended for speed and cost).
   • geminiSystemPrompt: You can customize the AI's "personality" and strictness here.

[!NOTE]
The free tier of Gemini has rate limits (approx. 15 requests per minute). The mod includes a built-in cache and rate-limiter to handle these limits gracefully without lagging the server.

📜 History & Logging

• Sign History: Tracks who placed a sign and what was written on it.
• Chat History: Logs all chat messages for administrative review.
• Explosion Logging: Detailed logs for TNT placement, ignition, and explosions, including player attribution whenever possible.
• Blame Tool: Inspect existing signs/blocks to see who interacted with them and when.
• Persistent Storage: History survives server restarts (saved to config/piggy-admin-history.json).

---

Commands

All commands require OP level 2 or higher.

General Administration

• /piggy cheats <allow|forbid>: Globally allow or forbid "cheat" features for all players.
• /piggy feature list: List all controllable features and their current status.
• /piggy feature <id> <enable|disable>: Enable or disable a specific feature (e.g., flexible_placement, tool_swap).
• /piggy sync: Manually trigger a synchronization of all admin settings and moderation rules to all connected clients.

Investigation & Logging

• /blame: Look at a block or sign and run this to see the interaction history.
  • Works on: Fire, Lava, Signs, Containers, and exploded regions.
• /logs <player>: View a categorized history for a player (Chat, Sign, Fire, Explosion, Moderation).
  • Clickable Teleports: Log entries include coordinates that you can click to investigate the scene.
• /piggy xray <clear|stats>: Manage the X-Ray heuristic cache or view current player standings.

---

Configuration

The mod generates a configuration file at config/piggy-admin-server.json (server-side).

{
  "allowCheats": false,
  "features": {
    "flexible_placement": true,
    "fast_place": false,
    "tool_swap": true
  },
  "xrayCheck": true,
  "xrayMaxRatio": 0.15,
  "xrayMinBlocks": 20,
  "moderationEnabled": true,
  "geminiApiKey": "YOUR_KEY",
  "geminiModel": "gemini-1.5-flash"
}

• "allowCheats": false: Forces all connected clients to disable restricted features.
• "allowCheats": true: Allows clients to use their own local settings.
• "features": Granular control over individual features.
• "xrayMaxRatio": Maximum allowed ratio of rare ores to total blocks (default 15%).
• "xrayMinBlocks": Minimum blocks mined before X-Ray detection activates (default 20).
• "xrayCheck": Toggle the X-Ray detection system.
• "moderationEnabled": Toggle the AI and Regex moderation engine.
• "geminiApiKey": Your Google Gemini API Key.
• "geminiModel": The Gemini model to use (default: gemini-1.5-flash).

---

Dependencies & Installation

Requirements

• Minecraft: ~1.21.1
• Fabric Loader: >=0.18.1
• Java: >=21

Required Mods

• Fabric API: Any version
• YACL (Yet Another Config Lib): >=3.6.1+1.21-fabric (for clients to view config)
• Piggy Lib: >=1.0.1
• (Optional) Mod Menu: >=11.0.3 - Recommended for clients.

Installation

1. Download the .jar file from Releases.
2. Install Fabric Loader for Minecraft 1.21.1.
3. Place the piggy-admin jar (along with Fabric API and Piggy Lib) into your server's mods folder.
4. Launch the server!

---

Todo / Future Features

• Detect XRay: Implement heuristics/checks to detect players using XRay texture packs or mods.
• Moderate Sign Text: Add tools to inspect and filter text on signs to prevent inappropriate content.

---

Inspiration

This mod was inspired by:

• ItemSwapper - For the concept of server-side item management and swapping mechanics.

---

License: CC0-1.0