diff --git a/README.md b/README.md index e0be0a6..6e61fbb 100644 --- a/README.md +++ b/README.md @@ -1,145 +1,91 @@ -# ShaguTweaks +# ๐Ÿงฉ ShaguTweaks - +> **A small World of Warcraft (1.12.1 / 2.4.3) AddOn for those who don't want to use any AddOns at all.** -> **A small World of Warcraft (1.12.1 / 2.4.3) AddOn for those, who don't want to use any AddOns at all.** +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. -The goal of ShaguTweaks is to be non-intrusive to the default appearance, but also giving the user the choice to change additional settings if desired. The pre-selected defaults of ShaguTweaks only add those quality of life changes to the game, that are preserving the look and feel of the original interface. It's up to everyones own preferences to enable more or even disable some more. +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*). -All tweaks are made to the default interface and might not take effect if you already replaced some of the elements with other addons. +--- -All addon settings can be controlled in game via the "Advanced Options" button on the Main Menu (*Esc*). -Every of the listed features below, can be completely disabled in that menu in case you don't like it. +## ๐Ÿ“ฆ Installation -**Notice:** -*This Addon or a superior and maintained version of it, is already included in [pfUI](https://github.com/shagu.pfUI). If using this in combination with pfUI you might get bad results or up to performance regressions.* +**Vanilla (1.12)** +1. Download the latest version +2. Unpack the zip +3. Rename the folder to `ShaguTweaks` +4. Copy it into `Wow-Directory\Interface\AddOns` +5. Restart WoW -## Installation (Vanilla, 1.12) -1. Download **[Latest Version](https://github.com/shagu/ShaguTweaks/archive/master.zip)** -2. Unpack the Zip file -3. Rename the folder "ShaguTweaks-master" to "ShaguTweaks" -4. Copy "ShaguTweaks" into Wow-Directory\Interface\AddOns -5. Restart Wow +**The Burning Crusade (2.4.3)** +Same steps, but rename the folder to `ShaguTweaks-tbc`. -## Installation (The Burning Crusade, 2.4.3) -1. Download **[Latest Version](https://github.com/shagu/ShaguTweaks/archive/master.zip)** -2. Unpack the Zip file -3. Rename the folder "ShaguTweaks-master" to "ShaguTweaks-tbc" -4. Copy "ShaguTweaks-tbc" into Wow-Directory\Interface\AddOns -5. Restart Wow +--- -## Features +## ๐Ÿ†• Custom mods (added on top of the original) -![preview](screenshots/settings.jpg) +- **Energy & Mana Tick** +*Adds an energy & mana tick to the player frame.* -- **Auto Dismount** - *Automatically dismounts whenever a spell is casted.* +- **Clean Minimap** ๐Ÿงญ +*Hides minimap addon buttons automatically when the cursor leaves the minimap area.* -- **Auto Stance** - *Automatically switch to the required warrior or druid stance on spell cast.* +- **Minimap Zoom** +*Increases the minimap size and shifts buff icons left to prevent overlap.* -- **Blue Shaman Class Colors** - *Changes the class color code of shamans to blue, as known from TBC+.* +- **XP Bar Text** ๐Ÿ“Š +*Always shows current XP and rested bonus percentage directly on the experience bar โ€” fixed for OctoWoW.* -- **Chat Hyperlinks** - *Copy website URLs from the chat, transforms CLINKs into real items and handles quest and player links.* +- **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).* -- **Chat Tweaks** - *Allows to scroll using the mouse wheel, enables sticky chat channels and repeats message on arrow up.* +- **Loot Cursor** ๐Ÿ–ฑ๏ธ +*Positions the loot window directly under your cursor so you can loot without moving your mouse.* -- **Cooldown Numbers** - *Display the remaining duration as text on every cooldown.* +- **No Toggle** โš”๏ธ +*Keeps Auto Attack, Auto Shot, and Shoot active when re-pressed, preventing accidental cancellation.* -- **Darkened UI** - *Turns the entire interface into darker colors.* +--- -- **Equip Compare** - *Shows currently equipped items on tooltips while the shift key is pressed.* +## โš™๏ธ Original Features -- **Unit Frame Health Colors** - *Change health text color based on its value.* +- **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 TBC+. +- **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. +- **Real Health Numbers** โ€” Estimated health numbers on player, pet and target frames. +- **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 based on combat log estimation. +- **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. +- **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. -- **Real Health Numbers** - *Estimates health numbers, and shows numbers on player, pet and target unit frames.* +--- -- **Hide Errors** - *Hides and ignores all Lua errors produced by broken addons.* +## ๐Ÿ™ Credits -- **Hide Gryphons** - *Hides the gryphons left and right of the action bar.* - -- **Item Rarity Borders** - *Show item rarity as the border color on bags, bank, character and inspect frames.* - -- **MiniMap Clock** - *Adds a small 24h clock to the mini map.* - -- **MiniMap Square** - *Draw the mini map in a squared shape instead of a round one.* - -- **MiniMap Tweaks** - *Hides unnecessary mini map buttons and allows to zoom using the mouse wheel.* - -- **Movable Unit Frames** - *Player and Target unit frames can be moved while "Shift" and "Ctrl" are pressed together.* - -- **Nameplate Castbar** - *Adds a castbar to the nameplate based on combat log estimations.* - -- **Nameplate Class Colors** - *Changes the nameplate health bar color to the class color.* - -- **Nameplate Scale** - *Makes all nameplates honor the UI-Scale setting.* - -- **Reduced Actionbar Size** - *Reduces the actionbar size by removing several items such as the bag panel and microbar* - -- **Sell Junk** - *Adds a โ€œSell Junkโ€ button to every merchant window, that sells all grey items.* - -- **Social Colors** - *Show class colors in Who, Guild, Friends and Chat.* - -- **Enemy Castbars** - *Shows an enemy castbar on target unit frame.* - -- **Debuff Timer** - *Show debuff durations on the target unit frame.* - -- **Tooltip Details** - *Display health, class color, guild name, guild rank and current target on unit tooltips.* - -- **Unit Frame Big Health** - *Increases the healthbar of the player and target unitframe.* - -- **Unit Frame Class Colors** - *Adds class colors to the player, target and party unit frames.* - -- **Unit Frame Class Portraits** - *Replace unitframe portraits with class icons.* - -- **Vendor Values** - *Shows the vendor sell values on all item tooltips.* - -- **WorldMap Class Colors** - *Show class colored circles on world and battlefield map.* - -- **WorldMap Coordinates** - *Adds coordinates to the bottom of the World Map.* - -- **WorldMap Window** - *Turns the world map into a movable window. The map can be scaled with "Ctrl" + Mousewheel.* - -## Screenshots -![preview](screenshots/dark.jpg) -*All options enabled, except for squared minimap.* - -![preview](screenshots/castbars.jpg) -*Target Frame Castbars* - -![preview](screenshots/bighealthclass.jpg) -*Big Healthbar, Class Portraits, Darkened UI* - -![preview](screenshots/debufftimers.jpg) -*Debuff Timers & Mob Health* +Original addon by **shagu**. Code also borrows from **pfUI** and **zUI**. +This fork adapts, patches and extends ShaguTweaks for **OctoWoW / Turtle WoW**.