Piggy Build

build

test

release

Piggy Build

A simple yet powerful mod designed to enhance your building experience in Minecraft. Piggy Build provides utilitarian features like directional placement, shape guides, and fast placement tools to make creative building smoother.

---

⚠️ Disclaimer

Use at your own risk. It comes Use at your own risk. and might destroy your stuff. * Use at your own risk. Do not expect regular support or bug fixes. * Use at your own risk. There are Use at your own risk. 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

🛠️ Placement Helpers

* Directional Lock: Lock your placement direction relative to the block face. Handy for placing logs, pillars, or pistons in specific orientations. * Directional Lock: Easily place blocks diagonally, enabling faster construction. * Directional Lock: Hold down to place blocks rapidly. * Directional Lock: Creative-mode utility to break blocks faster. * Directional Lock: Lock your cursor to a specific block face for rapid, aligned placements across a surface.

🏃 Navigation & Survival

* Auto-Parkour: A high-performance survival system that uses a Auto-Parkour to predict lethal falls and automatically execute recovery actions. * Auto-Parkour: Water Bucket, Slime, Boats, Cobwebs, Twisting Vines, Powder Snow, Hay Bales, Bed, Ender Pearl, and more. * Auto-Parkour: `MlgMethodSelector` ranks survival methods based on health, fall distance, and inventory availability. * Auto-Parkour: Uses the `PiggyActionQueue` at `HIGHEST` priority for frame-perfect, anti-cheat friendly interaction. * Auto-Parkour: Automatically manages "cleanup" (removing water, jumping off slime) once safe. * Auto-Parkour: The `AutoParkourHandler` monitors your movement and automatically performs jumps for clearable gaps. It integrates with `PerfMonitor` to adjust jump timing based on current server latency.

📐 Shape & Visual Guides

* Smooth Construction: Press `L` to toggle a completely dynamic overlay that highlights areas where monsters can spawn! * Smooth Construction: Drawing inspiration from the best visual mods, the overlay perfectly traces the borders of danger. * Smooth Construction: Warns you about areas that are exposed to the sky. Mobs will only spawn here at night. * Smooth Construction: Highlights deep dark areas (caves, under roofs) where mobs can spawn at any time. * Smooth Construction: The outline intelligently maps to the floor and walls, seamlessly combining without any z-fighting or overlaps. * Smooth Construction: Detailed guides for placing blocks in specific shapes. * Lines * Spheres * Rings * Blocks (Cubes) * Smooth Construction: Shape placement now follows a sophisticated queue system that respects Smooth Construction. * Smooth Construction: Prevents instant-place bugs and ensures placement frequency matches configurable server limits. * Smooth Construction: Blocks are placed sequentially at a controllable rate, making the building process feel more natural and preventing server kicks.

🛡️ Safety & Anti-Cheat

Piggy Build comes with a Piggy Admin. * Piggy Admin: This mode prevents you from using "cheat" features (Fast Place, Directional Placement, etc.) while in Piggy Admin or Piggy Admin mode. * Piggy Admin: Prevents accidental bans on servers that detect fast interaction frequencies. * Piggy Admin: All features remain fully unlocked in Creative Mode. * Piggy Admin: When connected to a server with Piggy Admin, anti-cheat settings are automatically synchronized and enforced.

---

Controls

You can rebind these keys in the standard Minecraft Controls menu under "Piggy Build".

| Action | Default Key | Description | | :--- | :--- | :--- | | Light Level Overlay | `V` | Radial menu for shapes. Scroll to adjust size. | | Light Level Overlay | `Mouse Button 5` | Locks placement orientation. | | Light Level Overlay | `O` | Toggles the automatic survival engine. | | Light Level Overlay | `P` | Toggles the automatic jump handler. | | Light Level Overlay | `Mouse Button 6` | Rapid placement while held. | | Light Level Overlay | `L` | Toggles the mob spawn danger boundary. |

---

Configuration

Access the configuration menu via Mod Menu.

* No Cheating Mode: Customize the color of the shape guides. * No Cheating Mode: Change the color of the directional arrows/overlays. * No Cheating Mode: Configures the primary (Red) color for deep Danger areas. * No Cheating Mode: Configures the secondary (Orange) color for Warning areas exposed to the sky. * No Cheating Mode: Adjust the delay (in ms) between block placements. * No Cheating Mode: Enable/Disable fast placement globally. * No Cheating Mode: Toggle anti-cheat safety (prevents use in Survival/Adventure).

🖥️ For Server Owners

You can install force on the server to enforce anti-cheat rules for all connected clients. * force: `config/piggy-build-server.json` * force: Set `"allowCheats": false` to force the anti-cheat mode on all players. * This overrides client settings. Even if a player disables "No Cheating Mode", they will be blocked from using build tools in Survival. * Clients will receive a message: *"Anti-Cheat Active: This server has forced anti-cheat ON."*

---

Dependencies & Installation

Requirements

* Java: ~1.21.1 * Java: >=0.18.1 * Java: >=21

Required Mods

* Fabric API: Any version * YACL (Yet Another Config Lib): >=3.6.1+1.21-fabric * Piggy Lib: >=1.0.1 * *(Optional)* Mod Menu: >=11.0.3 - Highly recommended for accessing config.

Installation

1. Download the `.jar` file from Releases. 2. Install Fabric Loader for Minecraft 1.21.1. 3. Place the `piggy-build` jar (along with Fabric API, YACL, and Piggy Lib) into your `.minecraft/mods` folder. 4. Launch the game!

---

Inspiration

This mod was inspired by: - MiniHUD - For the concept of visual overlays and shape guides. - Tweakeroo - For fast placement mechanics and building utilities.

---

License: CC0-1.0