Initial release: HSUI v1.0.0.0 - HUD replacement with configurable hotbars

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-01-30 23:52:46 -05:00
commit f37369cdda
202 changed files with 40137 additions and 0 deletions
@@ -0,0 +1,102 @@
+# HSUI
+
+**A modern HUD replacement for Final Fantasy XIV, built for customization.**
+
+HSUI provides a highly configurable HUD replacement, recreated from DelvUI using KamiToolKit, FFXIVClientStructs, and Dalamud. Replace and customize your entire in-game HUD with a clean, flexible interface.
+
+![HSUI Banner](Media/Images/banner_short.png)
+
+---
+
+## Features
+
+- **Unit Frames** — Player, target, focus target, target of target with customizable health bars, labels, and icons
+- **Castbars** — Player and target castbars with interrupt indicators
+- **Job Gauges** — All job-specific gauges (DRK, WAR, MNK, NIN, etc.)
+- **Party Frames** — Configurable party list with health, buffs, debuffs, and cooldowns
+- **Nameplates** — Customizable enemy and friendly nameplates
+- **Status Effects** — Player and target buff/debuff display
+- **Enemy List** — Enhanced enemy list with debuff tracking
+- **Hotbars** — Configurable action bars with:
+  - Multiple layout options (12×1, 6×2, 4×3, 3×4, 2×6, 1×12)
+  - Drag-and-drop from game UI (Actions, Macros, Inventory)
+  - Shift+drag to rearrange, release outside to clear
+  - Cooldown overlays and combo highlighting
+- **Profiles** — Save and load configurations, import from DelvUI
+- **Other Elements** — Experience bar, GCD indicator, limit break, pull timer, MP ticker
+
+---
+
+## Installation
+
+### Via Custom Plugin Repository (Recommended for FC/local installs)
+
+1. Open **XIVLauncher** → **Dalamud Settings** → **Experimental**
+2. Add a custom plugin repository:
+   ```
+   https://raw.githubusercontent.com/Knack117/HSUI/main/pluginmaster.json
+   ```
+3. Open the **Plugin Installer**, enable "Show custom plugin repositories", and install **HSUI**
+
+### Manual Installation
+
+1. Download the latest release from [Releases](https://github.com/Knack117/HSUI/releases)
+2. Extract the contents to your Dalamud plugins folder:
+   - `%AppData%\XIVLauncher\installedPlugins\HSUI\`
+
+---
+
+## Commands
+
+| Command | Description |
+|--------|-------------|
+| `/hsui` | Open HSUI settings |
+| `/hui` | Alias for `/hsui` |
+
+---
+
+## Building from Source
+
+### Prerequisites
+
+- .NET 10 SDK
+- [KamiToolKit](https://github.com/KamiToolKit/KamiToolKit) (cloned to `../repos/KamiToolKit-master/`)
+
+### Build
+
+```bash
+dotnet build -c Release
+```
+
+The built plugin will be in `bin/Release/`.
+
+---
+
+## Project Structure
+
+```
+HSUI/
+├── Config/           # Configuration system
+├── Enums/            # Shared enumerations
+├── Helpers/          # Utilities and managers
+├── Interface/        # HUD elements and configs
+├── Media/            # Fonts, images, default profiles
+├── HSUI.json         # Plugin manifest
+├── changelog.md      # Version history
+└── README.md
+```
+
+---
+
+## Credits
+
+- **DelvUI** — Original design and inspiration
+- **KamiToolKit** — UI framework
+- **FFXIVClientStructs** — Game data structures
+- **Dalamud** — Plugin framework
+
+---
+
+## License
+
+This project uses code from [MOActionPlugin](https://github.com/attickdoor/MOActionPlugin) (GPL-3.0). See individual files for copyright notices.