BetterPrisons: Quick Reference Guide

BetterPrisons is a client-side enhancement mod for CosmicPrisons. No external dependencies required.

---

HUDs (On-Screen Overlays)

• Cooldown HUD — Timers for /jet, /feed, /fix, /home, /tpa, /tpahere, and combat. Super Breaker & Powerball tracked by Enchant HUD.
• Satchel HUD — Fill level and capacity for all satchels (works with renamed satchels). Combines same-type satchels. Threshold color alerts.
• Stats HUD — XP, XP/hour, Cosmic Energy, session totals, time until next level. Shows visual indicator when paused.
• Enchant HUD — Countdown timers for Super Breaker and Powerball.
• Events HUD — Coordinates and icon for each meteor (natural/summoned) and active Ore Merchants (per-tier toggles, distance, timeout).
• Waypoints — Screen-edge arrows and optional 3D beacon beams for every active meteor and merchant. Renders at any distance.
• Gang Pings — Broadcast your position to gang (G) or truce (H) chat. Received pings show as player head icons with beacon beams, info text (name, timer, coords, HP, facing), and sound alerts. 3-second cooldown. Dedicated config tab.
• Super Breaker Aura — Centered ring timer (WeakAura-style) for Super Breaker. Timer offset and enable/disable toggle.

---

EasyView (Inventory Overlays)

Compact text labels on inventory items — no tooltip needed. Supports: Cosmic Energy, Money Notes, Gang Points, Black Scrolls, Charge Orbs, Dust, Pages (with optional tier coloring), Armor, Weapons, and Pickaxes. Each type is toggleable and color-configurable independently.

---

Peaceful Mining

• Nearby players become translucent while holding a pickaxe (opacity 0–255, radius configurable).
• Block-breaking progress remains visible through ghosted players.
• Disables accidental hits and right-clicks on players while mining.
• Auto-disable on combat: peaceful mining turns off when you enter combat and re-enables when combat ends (toggleable).

---

Quality-of-Life

• Message Notifications — Audio alert on private messages. 7 sounds to choose from, volume 0–200%.
• Held Item Scaling — Resize held items per type (pickaxe, sword, axe, other) from 25–150%.
• Pickaxe Drop Protection — Requires pressing drop twice within 3 seconds to drop a pickaxe. Options to block dropping entirely or block dragging out of inventory.

---

Config Screen

Fully custom UI — no external mod required. Open with I or via Mod Menu.

• Tabs in a left sidebar (HUD Settings / Feature Settings / Configuration).
• Collapsible sections and per-setting reset buttons (X icon).
• Hover tooltips on most settings.
• Color picker — HSV selector square, hue bar, live preview, and hex input.
• HUD Editor — Drag to reposition. Right-click a HUD for an inline scale slider (70–150%). Color-coded: green = hovered, yellow = dragging, orange = scaling. Reset Positions button available.
• Theme — 27 color settings (backgrounds, borders, text, accents, etc.) with real-time preview.

---

Keyboard Shortcuts

• I — Open config screen
• R — Reset Stats HUD (clears session totals)
• B — Pause / Resume Stats HUD tracking
• G — Send gang ping
• H — Send truce ping

---

Support: Contact nishu06 on Discord or open a ticket at https://discord.gg/gW4sBdNmac.