PrefabBuilder

Build complex structures block-by-block with visual guidance!

PrefabBuilder is a construction assistance mod for Hytale that helps you build
prefab structures in survival mode. Load any .prefab.json file and the mod
shows you exactly where each block needs to be placed with ghost block
previews — similar to Litematica for Minecraft.

---
What's New

- Place Mode — Close the UI and scroll your mouse wheel to move the preview in
the direction you're looking. Crouch + Scroll for up/down. No more clicking
buttons one at a time!
- Redesigned UI — Construction Manager and Positioning pages rebuilt with
cleaner layouts. Everything visible at a glance.
- Auto-Build: Place Air — New toggle in the materials header. When enabled,
auto-build also clears existing blocks instead of skipping them.
- Startup Ghost Cleanup — Orphaned ghost blocks from previous sessions are
automatically cleaned up on server start.
- /prefabcleanup Command — Manually remove leftover preview blocks in a
64-block radius around you.
- Self-Build always active — Automatically enabled when you start a preview.
No extra toggle needed.
- Preview Mode Switch fixed — Switching between Server Preview and Client-Only
Preview now works reliably.
- Faster preview movement — Moving the preview uses a new fast-path that
removes and places blocks in one pass.

---
Permission Groups

PrefabDefault — Grants prefabbuilder.user.* (Build, preview, GUI, list
prefabs, delete, freecam, self-build, share, CurseForge)

PrefabAdmin — Grants prefabbuilder.admin.* + prefabbuilder.user.* (Import,
config, reload, debug, analytics, holograms)

Compatible mods: Item Pin Board, MultipleHUD, HyUI

---
Features

Visual Building Guide
- Ghost block preview shows exactly where to place each block
- 2 preview modes: Server Preview (all players see) and Client-Only Preview
(only you see)
- Layer-by-layer view — build one floor at a time
- Filter by block type — focus on placing only stone, wood, etc.
- Rotation (90 degree steps) and free positioning controls
- Place Mode — scroll to move the preview in your look direction
- Hide/show preview without canceling
- Conflict detection — highlights overlapping blocks in red

Self-Build Mode — Place blocks manually with visual guidance. Perfect for
survival!
- Ghost blocks show exactly where to place
- Auto-consume: hold any block and the system finds the correct one from your
inventory
- Wrong block protection: prevents placing the wrong material
- Block break protection: accidentally broken blocks get their ghost restored

Auto-Build Mode — Deposit resources and blocks are placed automatically
(configurable speed)
- Place Air toggle — also clears existing blocks when building

Resource Management
- Resource list shows required materials and current progress
- Deposit items from your inventory to construction sites
- Track which materials you still need
- Pin important items for quick reference (requires MultipleHUD + Item Pin
Board)
- Alternative blocks — use different materials than originally planned

Smart Assistance
- Wrong block notifications when you place the wrong material
- Skip blocks you want to ignore
- Layer auto-filter based on held item
- Construction site holograms show name, progress and owner in 3D

Progress Tracking
- Construction sites persist across server restarts and disconnects
- Multiple construction sites per player
- Progress percentage display with detailed or compact HUD
- Build completion screen with statistics
- Automatic preview restore after reconnect

Easy Import
- Import prefabs via URL (paste a direct download link)
- Browse and download prefabs from CurseForge directly in-game

CurseForge Integration
- Search and browse Hytale prefabs from CurseForge
- Download and import prefabs with one click
- Requires a free API key from console.curseforge.com

Multi-Source Prefab Loading
- Server Prefabs folder (for GPortal/remote servers)
- Run directory (for local development)
- Embedded in plugin JAR
- Hytale UserData/Saves (fallback)

---
Commands

/prefabBuilder — Open the main menu
/prefabimport — Import an external prefab (URL or JSON)
/prefabadmin — Open config editor (Creative mode required)
/prefabcleanup — Remove leftover preview blocks (64 block radius)

---
Permissions

User Permissions (PrefabDefault group):
- prefabbuilder.user.* — All user permissions
- prefabbuilder.user.gui — Open main menu
- prefabbuilder.user.list — View prefab list and details
- prefabbuilder.user.preview — Start ghost block preview
- prefabbuilder.user.build — Start construction
- prefabbuilder.user.selfbuild — Self-Build mode
- prefabbuilder.user.freecam — FreeCam mode during preview
- prefabbuilder.user.delete — Delete prefabs and sites
- prefabbuilder.user.share — Share sites with other players
- prefabbuilder.user.curseforge — CurseForge browse and download

Feature Permissions (grant manually):
- prefabbuilder.feature.autobuild — Auto-Build mode: deposit resources,
automatic placement. PrefabAdmin includes this by default.

Admin Permissions (PrefabAdmin group):
- prefabbuilder.admin.* — All admin permissions
- prefabbuilder.admin.config — Admin settings
- prefabbuilder.admin.import — Import prefabs
- prefabbuilder.admin.reload — Reload configuration
- prefabbuilder.admin.debug — Debug commands
- prefabbuilder.admin.analytics — Analytics commands
- prefabbuilder.admin.holo — Hologram commands

---
Coming Soon

Multiplayer Sharing (Beta)
- Share construction sites with friends
- Build together on the same structure
- Synchronized progress between players

(Sharing system is implemented but disabled by default. Enable with
sharingEnabled: true in config.)

---
If you find any bugs, please let me know and I'll fix them as best I can :)

Perfect for survival builders who want guidance without losing the
satisfaction of placing each block yourself!