BetterBuildingTools (BBT)

SHORT SUMMARY

────────────────────────────────
Precision building tools for Windrose — fine rotation (1/5/10 degrees),
copy object, copy angle, undo, build status HUD, in-game settings menu
with guide, and optional free-build cheats. Fully configurable.

FULL DESCRIPTION

────────────────────────────────

>>> BETA — ACTIVE DEVELOPMENT <<<
This mod is currently in beta. Features are functional but still being
tested and improved. Expect occasional bugs and changes between versions.

We need YOUR help to make this mod solid — if something breaks, crashes,
or behaves unexpectedly, please report it! Try to break it. Seriously.
Build weird things, spam buttons, push it to its limits. The more detail
you can give us about what you were doing when something went wrong, the
faster we can fix it. Include your UE4SS.log if possible.

Bug reports: Post in the comments or send a message.
Source code: GitHub repository coming soon — we're structuring
the repo before going public.

Overview
--------
BetterBuildingTools adds quality-of-life tools for the building system
that the base game doesn't provide. Fine-tune rotation down to a single
degree, copy a placed block's exact angle, undo misplaced builds, and
see your rotation/snap state at a glance — all from an in-game HUD and
settings menu. Every feature can be toggled on or off individually, and
all settings persist between sessions.

Features
--------

FINE ROTATION (1 / 5 / 10 Degrees)
  Adds 1, 5, and 10 degree steps to the game's built-in rotation cycle.
  Uses your existing Rotation Step keybind — no new key needed. Each
  increment can be enabled or disabled independently.
  Note: The game auto-snaps blocks within ~3 degrees of a neighbor, so
  the 1-degree step can occasionally cause subtle misalignment. Disable
  it in settings if that bothers you.

COPY OBJECT (Shift+C)
  Look at any placed object and press Shift+C to instantly switch your
  build selection to that piece. No more scrolling through menus to
  find what you need.

COPY ANGLE (Alt+C)
  Look at a placed block and press Alt+C to copy its exact rotation to
  your build preview. Great for matching wall angles, roof pitches, or
  any non-standard rotation. The placement uses the correct angle — the
  ghost preview doesn't visually update until you toggle build mode, but
  the final block lands exactly where it should.

UNDO (Shift+Z)
  Misplaced a block? Press Shift+Z to undo your last build action —
  no need to hunt for it with the delete tool. Remembers up to 10
  actions by default (configurable up to 50).

BUILD STATUS HUD (BStat)
  A compact overlay on the left side of your screen during build mode
  showing:
    - Current rotation (Yaw) in degrees
    - Rotation step size
    - Snap mode (ON/OFF)
    - Target block rotation (with green highlight when matching)
    - Copy Angle lock status
    - Undo stack count
    - LookAt — the name of the block you're aiming at
    - Full keybind reference
  Can be toggled off in the settings menu if you prefer a clean screen.

IN-GAME SETTINGS MENU (F2)
  Press F2 during build mode to open the settings panel. Arrow keys to
  navigate, Left/Right to toggle values. All changes apply immediately
  and are saved automatically — no restart needed. Includes a built-in
  guide with detailed info on every feature (9 pages).

IN-GAME GUIDE
  Access from the top of the Settings menu. A 9-page feature reference
  covering every tool, keybind, and known issue — all without leaving
  the game. Navigate with Left/Right, press F2 to go back to settings.

FREE BUILD (Cheats — Off by Default)
  Three optional cheats for creative building, all disabled by default:
    - No Build Cost — build without consuming resources
    - Build Anywhere — skip the bonfire/building-center requirement
      for both structures and decorations
    - No Stability Req — DISABLED in this beta, coming in a future
      release

Configuration
-------------
All settings live in a single config file:

  Mods/BetterBuildingTools/config.txt

Every feature can be toggled on/off, and keybindings can be changed to
any single key (A-Z, 0-9) with optional Shift/Alt modifiers.

Settings changed in the F2 menu are saved to config.txt automatically
and persist between sessions. Keybind changes in the config file require
a game restart to take effect.

Installation
------------
1. Install UE4SS if you haven't already
   https://github.com/UE4SS-RE/RE-UE4SS

2. Extract the mod folder into your UE4SS Mods directory:
   Windrose/R5/Binaries/Win64/ue4ss/Mods/BetterBuildingTools/

3. Make sure the folder contains:
   - dlls/main.dll
   - Scripts/main.lua
   - config.txt
   - enabled.txt

4. Launch the game

!!Important Notes!!
---------------
- The Build Status HUD may take a moment to disappear after leaving
  build mode. This is normal — it will go away on its own.

- "Restart All Mods" in the UE4SS console works best if you exit build
  mode first. Using it while in build mode may cause a fatal error.
  A full game restart is recommended for reliable reloading.

- "Build Anywhere" decoration removal cannot be undone within the same
  session — restart the game to restore the bonfire requirement for
  decorations.

- Copy Angle is a work in progress — placement works perfectly, but
  the ghost preview doesn't rotate visually until you re-enter build
  mode. Toggle destroy mode and back, or exit and re-enter build mode
  to refresh it.

- This mod requires UE4SS. It uses a C++ DLL for performance-critical
  operations and Lua for the in-game UI.

What's New in v0.32 Beta
------------------------
  - Settings now persist between sessions (saved to config.txt)
  - LookAt now shows the name of the block you're aiming at
  - In-game Guide panel (9 pages, accessible from Settings menu)
  - Build Status HUD hides when Settings/Guide menus are open
  - Improved build mode exit detection
  - Reduced resource usage when not in build mode
  - Fixed crash when returning to main menu
  - UI polish: dim styling on disabled toggles, color improvements

What's in v0.32 Beta
---------------------
  1.  Fine Rotation 1/5/10 Degrees                        (Done)
  2.  Copy Object — Grab Any Placed Piece          (Done)
  3.  Copy Angle — Match Exact Rotation             (Done — Ghost Visual WIP)
  4.  Undo Build Actions                                        (Done)
  5.  Build Status HUD (BStat)                                (Done)
  6.  In-Game Settings Menu (F2)                          (Done)
  7.  In-Game Guide (9 Pages)                               (Done)
  8.  Free Build — No Cost / Build Anywhere        (Done)
  9.  Free Build — No Stability                               (Disabled) Needs a Bug Fix
  10. Config File + Custom Keybinds                    (Done)
  11. Persistent Settings                                        (Done)
  12. Safe Mod Unload on Game Exit                   (Done)

Roadmap — What's Next
---------------------
We're actively developing BBT. This list will update with each release.

  - Copy Angle ghost preview fix                 (Work in Progress)
  - Redo build actions                                  (Work in Progress)
  - Replace Object — swap a placed piece          (Planned)
  - More build camera modes                             (Planned)
  - Copy Selection — grab multiple pieces         (Planned)
  - Blueprints — save and load structures          (Planned)
  - ...and more to come

Many of these features build on internal work we're doing right now.
Once the foundation is in place, expect them to roll out quickly.

Compatibility
-------------
- Solo play only. May work in co-op or multiplayer but this has not
  been tested yet. At this stage of beta we're focused on getting the
  features solid first — multiplayer support will come later.
- Works alongside other UE4SS mods
- Does not modify game files — fully reversible by removing the mod folder