Files
ShaguTweaks-ClassicAPI/README.md
T

136 lines
2.9 KiB
Markdown

# 🧩 ShaguTweaks — ClassicAPI
A lightweight fork of [ShaguTweaks](https://github.com/shagu/ShaguTweaks) for **Turtle WoW-like servers**.
Focused on **stability, compatibility and performance** while keeping the original ShaguTweaks experience.
> This fork requires ClassicAPI and targets **Turtle WoW-like server/client environments**.
## 🔌 Requirements
- **[ClassicAPI](https://github.com/brues-code/ClassicAPI) — required**
- **[SuperWoW](https://github.com/balakethelock/SuperWoW) — optional / recommended**
ClassicAPI is the main API layer. SuperWoW is only used as an additional fallback for some cast/GUID information.
## 📦 Installation
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**.
## ✨ Main changes
- 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.
## 🔷 Mods using ClassicAPI directly
- 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**.
Additional code and ideas from **pfUI** and **zUI**.