Revamp README for FishingBuddy addon

Updated README to enhance description, features, commands, installation instructions, and credits.
This commit is contained in:
Dusk-92
2026-07-29 10:15:42 +02:00
committed by GitHub
parent ae4b2634c4
commit fa0201c6b6
+47 -2
View File
@@ -1,2 +1,47 @@
# FishingBuddy
OctoWow world of warcraft addon that I've made updates to in order to fix in-game bugs
# 🎣 FishingBuddy
**OctoWoW addon** — the all-in-one fishing companion for classic WoW.
A fork of the original *FishingBuddy* (TackleBox + Impp's Fishing Info + outfit manager, all rolled into one), updated and patched to fix in-game bugs on OctoWoW.
---
## ✨ Features
- 🖱️ **Easy Cast** — right-click to cast your line, same button as looting. Double-click forces an early recast.
- 🐟 **Fish Watcher** — see every fish you've caught before, or just this session.
- 📊 Live display of your **skill level** and **time spent fishing**.
- 👕 **Outfit Manager** — pick a fishing outfit and swap into it in one click.
- 🪱 Auto-apply a **lure** to your fishing pole.
- 🪧 Full **Titan Panel** support.
- 🔌 **myAddOns** support.
- 🔁 Preliminary tracking for **cycle fish** (e.g. Nightfin Snapper) so you know when to hunt them.
- 🎩 Bonus: displays your "style points" based on Draznar's Fishing FAQ, just for fun.
---
## ⌨️ Commands
| Command | Effect |
|---|---|
| `/fishingbuddy` or `/fb` | Toggle the FishingBuddy window |
| `/fb help` | List all available commands |
| `/fb switch` | Wear your chosen fishing outfit (or switch back) |
---
## 📦 Installation
1. Download / unzip the addon.
2. Drop the `FishingBuddy` folder into `Interface/AddOns` in your WoW directory.
3. *(Optional)* Also add `OutfitDisplayFrame` — it powers the outfit-picker UI. Skip it if you already use another equipment manager.
4. Launch the game and enjoy tighter lines 🐠
> 💡 Alt-click an item in the outfit display to clear it.
---
## 🙏 Credits
Original addon by the FishingBuddy authors, with thanks to TackleBox, Impp's Fishing DB, QuickWeaponSwap, GuildMap and more.
This fork adapts and patches the addon for **OctoWoW**.