diff --git a/README.md b/README.md index e3eb3aa..16c19ed 100644 --- a/README.md +++ b/README.md @@ -1,90 +1,135 @@ -# 🧩 ShaguTweaks +# 🧩 ShaguTweaks — ClassicAPI -> **A small World of Warcraft (1.12.1) AddOn for those who don't want to use any AddOns at all.** +A lightweight fork of [ShaguTweaks](https://github.com/shagu/ShaguTweaks) for **Turtle WoW-like servers**. -This is a **fork of [shagu/ShaguTweaks](https://github.com/shagu/ShaguTweaks)**, patched for **OctoWoW / Turtle WoW**, with several new custom mods added and existing ones tweaked. +Focused on **stability, compatibility and performance** while keeping the original ShaguTweaks experience. -The goal stays the same: stay non-intrusive to the default UI, while giving you the choice to enable extra quality-of-life features if you want them. Every setting can be toggled in-game via **"Advanced Options"** on the Main Menu (*Esc*). - ---- +> This fork requires ClassicAPI and targets **Turtle WoW-like server/client environments**. ## 🔌 Requirements -- **[ClassicAPI](https://github.com/brues-code/ClassicAPI) — required.** This fork uses ClassicAPI for structured spell, cast, nameplate, bag, merchant and player-state data where it is more reliable than legacy tooltip/combat-log parsing. ShaguTweaks declares `!!!ClassicAPI` as a dependency and will not load without it. -- **[SuperWoW](https://github.com/balakethelock/SuperWoW) — optional / recommended.** It remains supported as an additional compatibility source, especially for GUID-based cast information, but ClassicAPI is the primary API layer. +- **[ClassicAPI](https://github.com/brues-code/ClassicAPI) — required** +- **[SuperWoW](https://github.com/balakethelock/SuperWoW) — optional / recommended** -Use the latest ClassicAPI version and follow its upstream installation instructions. - ---- +ClassicAPI is the main API layer. SuperWoW is only used as an additional fallback for some cast/GUID information. ## 📦 Installation -**Vanilla (1.12)** -1. Install/update **ClassicAPI** first -2. Download the latest ShaguTweaks version -3. Unpack the zip -4. Rename the folder to `ShaguTweaks` -5. Copy it into `Wow-Directory\Interface\AddOns` -6. Restart WoW +1. Install **ClassicAPI**. +2. Optionally install **SuperWoW**. +3. Rename the addon folder to `ShaguTweaks`. +4. Copy it to `World of Warcraft\Interface\AddOns\ShaguTweaks`. +5. Restart the game. ---- +Settings: **Esc → Advanced Options**. -## 🆕 Custom mods (added on top of the original) +## ✨ Main changes -- **Energy & Mana Tick** — Adds an energy & mana tick to the player frame. -- **Clean Minimap** — Hides minimap addon buttons automatically when the cursor leaves the minimap area. -- **Minimap Zoom** — Increases the minimap size and shifts buff icons left to prevent overlap. -- **XP Bar Text** — Always shows current XP and rested bonus percentage directly on the experience bar — fixed for OctoWoW. -- **Free Slots Count** — Shows free slot counts on the backpack button: class bag slots (top right), reagent bag slots (bottom left), and total free slots (bottom right). -- **Loot Cursor** — Positions the loot window directly under your cursor so you can loot without moving your mouse. -- **No Toggle** — Keeps Auto Attack, Auto Shot, and Shoot active when re-pressed, preventing accidental cancellation. -- **Range Color** — Action buttons will be colored red when out of range. -- **Hide Tracking Icon** — Hides the tracking icon from the minimap. -- **Improved Roll Frames** — Smaller roll frames with roll tracking. -- **Improved Castbar** — Adds a spell icon and remaining cast time to the cast bar. -- **Chat Spam Filter** — Hides repeated messages in say/yell/channel chat (70s cooldown per unique message). Also suppresses BigWigs cast spam and #showtooltip errors. -- **Smaller Error Frame** — Resizes the error frame to 1 line instead of 3. -- **Skip Gossip Text** — Skip gossip text when interacting with NPCs unless holding shift. ---- +- ClassicAPI-first integration for casts, auras, items and unit data. +- Reduced per-frame work, tooltip scans and repeated UI updates. +- Event-driven target and nameplate castbars where possible. +- Safer GUID-based handling for same-name enemies. +- Better Turtle WoW-like server compatibility for custom items, spells and UI changes. +- Safer hooks and fewer destructive global overrides. +- Various stability fixes across legacy ShaguTweaks modules. -## ⚙️ Original Features +## 🔷 Mods using ClassicAPI directly -- **Auto Dismount** — Automatically dismounts whenever a spell is cast. -- **Auto Stance** — Automatically switches to the required warrior/druid stance on spell cast. -- **Blue Shaman Class Colors** — Changes shaman class color to blue, as in +. -- **Chat Hyperlinks** — Copy website URLs from chat, turns CLINKs into real items, handles quest/player links. -- **Chat Tweaks** — Mouse wheel scroll, sticky chat channels, repeat message on arrow up. -- **Cooldown Numbers** — Shows remaining cooldown duration as text. -- **Darkened UI** — Darker overall interface colors. -- **Equip Compare** — Shows currently equipped items on tooltips while holding Shift. -- **Unit Frame Health Colors** — Health text color changes based on value. -- **Hide Errors** — Hides and ignores Lua errors from broken addons. -- **Hide Gryphons** — Hides the gryphons next to the action bar. -- **Item Rarity Borders** — Item rarity shown as border color on bags/bank/character/inspect frames. -- **MiniMap Clock** — Small 24h clock on the minimap. -- **MiniMap Square** — Square minimap instead of round. -- **MiniMap Tweaks** — Hides unnecessary minimap buttons, mouse wheel zoom. -- **Movable Unit Frames** — Move player/target frames with Shift+Ctrl. -- **Nameplate Castbar** — Castbar on nameplates using ClassicAPI cast state first, with legacy/SuperWoW fallbacks. -- **Nameplate Class Colors** — Nameplate health bar colored by class. -- **Nameplate Scale** — Nameplates honor UI-Scale setting. -- **Reduced Actionbar Size** — Smaller action bar, removes bag panel/microbar. -- **Sell Junk** — "Sell Junk" button at merchants, sells all grey items. -- **Social Colors** — Class colors in Who, Guild, Friends and Chat. -- **Enemy Castbars** — Enemy castbar on target frame using ClassicAPI timing first, with compatibility fallbacks. -- **Debuff Timer** — Debuff durations shown on target frame. -- **Tooltip Details** — Health, class color, guild name/rank, current target on tooltips. -- **Unit Frame Big Health** — Bigger healthbars for player/target. -- **Unit Frame Class Colors** — Class colors on player/target/party frames. -- **Unit Frame Class Portraits** — Replaces portraits with class icons. -- **Vendor Values** — Shows sell value on item tooltips. -- **WorldMap Class Colors** — Class-colored circles on world/battlefield map. -- **WorldMap Coordinates** — Coordinates at the bottom of the World Map. -- **WorldMap Window** — Movable, scalable world map window. +- Actionbar Range Color +- Auto Dismount +- Chat Tweaks +- Equip Compare +- Free Slots +- Improved Castbar +- Item Rarity Borders +- Movable Unit Frames +- Nameplate Class Colors +- Nameplate Castbar +- No Toggle +- Sell Junk +- Skip Gossip Text +- Enemy Target Castbar +- Tooltip Details +- WorldMap Window ---- +Other modules can also benefit indirectly from ClassicAPI through shared ShaguTweaks libraries and caches. + +## ⚙️ Modules + +### Action Bar & Combat + +- Auto Dismount +- Auto Stance +- Actionbar Range Color +- Cooldown Numbers +- Improved Castbar +- No Toggle +- Reduced Actionbar + +### Unit Frames + +- Big Health +- Class Colors +- Class Portraits +- Energy & Mana Tick +- Health Colors +- Movable Unit Frames +- Enemy Target Castbar +- Target Debuff Timer + +### Nameplates + +- Nameplate Scale +- Nameplate Class Colors +- Nameplate Castbar + +### Items & Tooltips + +- Equip Compare +- Free Slots +- Item Rarity Borders +- Sell Junk +- Tooltip Details +- Vendor Values + +### Chat & Social + +- Chat Tweaks +- Chat Levels +- Chat Spam Filter +- Social Colors + +### Minimap & World Map + +- Clean Minimap +- Minimap Clock +- Minimap Square +- Minimap Tweaks +- Minimap Zoom +- Hide Tracking Icon +- WorldMap Class Colors +- WorldMap Coordinates +- WorldMap Window + +### General + +- Darkened UI +- Hide Errors +- Hide Gryphons +- Improved Roll Frames +- Loot Cursor +- Skip Gossip Text +- Smaller Error Frame +- XP Bar Text + +### Compatibility + +- Turtle WoW-like server integration +- ClassicAPI integration +- SuperWoW integration ## 🙏 Credits -Original addon by **shagu**. Code also borrows from **pfUI** and **zUI**. -This fork adapts, patches and extends ShaguTweaks for **OctoWoW / Turtle WoW**. +Original addon by **shagu**. + +Additional code and ideas from **pfUI** and **zUI**.