From 0a1bc74f457bc050d8e1568ede6d2729b306bce4 Mon Sep 17 00:00:00 2001 From: Xurkon <36556990+Xurkon@users.noreply.github.com> Date: Sun, 15 Feb 2026 07:22:30 -0600 Subject: [PATCH] Docs: Complete README overhaul with professional aesthetics and badges --- README.md | 241 +++++++++++++++++------------------------------------- 1 file changed, 76 insertions(+), 165 deletions(-) diff --git a/README.md b/README.md index efc6a92..485714e 100644 --- a/README.md +++ b/README.md @@ -1,194 +1,105 @@ -# \# Questie-335 +
-# +# Questie (3.3.5a) -# A fork of the WoW Classic \*\*Questie\*\* addon aiming to provide compatibility with \*\*ANY\*\* private server. +![Version](https://img.shields.io/badge/version-v9.7.2-blue.svg?style=for-the-badge) +![Downloads](https://img.shields.io/github/downloads/Xurkon/PE-Questie/total?style=for-the-badge&color=e67e22) +[![Documentation](https://img.shields.io/badge/Documentation-View%20Docs-58a6ff?style=for-the-badge)](https://xurkon.github.io/PE-Questie/) +[![Patreon](https://img.shields.io/badge/Patreon-F96854?style=for-the-badge&logo=patreon&logoColor=white)](https://www.patreon.com/Xurkon) +[![PayPal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://www.paypal.me/Xurkon) +![License](https://img.shields.io/github/license/Xurkon/PE-Questie?style=for-the-badge&color=2980b9) +![WoW](https://img.shields.io/badge/WoW-3.3.5a-blue?style=for-the-badge&logo=world-of-warcraft&logoColor=white) -# +
+**A fork of the WoW Classic Questie addon aiming to provide compatibility with ANY private server.** -# \## Installation +[⬇ **Download Latest**](https://github.com/Xurkon/PE-Questie/releases/latest)   β€’   [πŸ“‚ **View Source**](https://github.com/Xurkon/PE-Questie)   β€’   [πŸ“– **Read Documentation**](https://xurkon.github.io/PE-Questie/) -# \- \[Download](https://github.com/Xurkon/PE-Questie/releases) the archive. +
-# \- Extract it into the `Interface/AddOns/` directory. The folder name should be `Questie-335`. +--- -# \- If you are playing on a custom server that emulates a previous expansion using the \*\*3.3.5\*\* client, you can add `-Classic` or `-TBC` to the addon folder name to load only the required files for the chosen expansion. +## πŸ“₯ Installation -# \- If your server doesn't provide a patch for the world map, enable the in-game setting: `Options β†’ Advanced β†’ Use WotLK map data`. +1. [Download](https://github.com/Xurkon/PE-Questie/releases) the archive. +2. Extract it into the `Interface/AddOns/` directory. The folder name should be `Questie-335`. +3. **Custom Server Support**: If you are playing on a server emulating a previous expansion (Classic or TBC) using the 3.3.5 client, you can add `-Classic` or `-TBC` to the folder name to load specific datasets. +4. **Map Compatibility**: If your server lacks a world map patch, enable `Options β†’ Advanced β†’ Use WotLK map data`. -# +--- -# \## Fixes +## πŸ”§ Fixes & Compatibility -# \- \*\*Nameplates\*\* +### πŸ›‘οΈ Nameplates +- Explicitly skips **Ascension Nameplates** to avoid conflicts, while maintaining compatibility with generic nameplate addons. -#   - Skips \*\*Ascension Nameplates\*\* and works with other addons. +### πŸ“Š Quest Tracker +- **Ascension API**: Fully compatible with custom quest APIs; no crashes on auto-turn-in quests. +- **Header Persistence**: Resolved issues where quest headers would disappear from the tracker. +- **Dynamic Updates**: Instant refresh when accepting, completing, or abandoning quests. +- **Combat Safety**: Protected with `pcall` to prevent UI lockups during intense combat updates. -# +### πŸ’¬ Tooltips +- Fixed all legacy Lua errors. +- **New Feature**: Displays if an NPC drops an item that starts a quest directly in the tooltip. -# \- \*\*Tracker\*\* +### πŸ—ΊοΈ Maps (Minimap & World Map) +- **Minimap**: Fixed zoom-related Lua errors. +- **World Map**: Full support for Ascension's `WorldMapFrame` (minimized mode), **Mapster**, and **Magnify-WotLK**. +- **Icon Cleanup**: Resolved "ghost icon" bug where completed quests remained visible on the map. -#   1. Compatible with the Ascension API and doesn't fail with auto-turn-in quests. +### πŸ“¦ Custom IDs +- Native support for large integer IDs common on custom private servers. -#   2. No more missing header issues. +--- -#   3. Refreshes correctly when accepting, completing, or abandoning quests. +## ✨ Features -# +### βš”οΈ Ascension Scaling +- Quests automatically scale to character level, perfectly matching the Ascension Scaling system. -# \- \*\*Tooltips\*\* +### πŸ“ Visual Map Objectives +Notes for quest starters, turn-ins, and complex objectives are drawn directly on your maps. -#   1. Fixed all errors. +
+ Quest Givers + Quest Complete + Quest Tooltip +
-#   2. New: shows if an NPC drops an item that starts a quest. +### πŸ“œ Advanced Quest Tracker +- **Smart Tracking**: Automatically tracks quests upon acceptance. +- **Expanded Capacity**: Displays up to 20 quests (original limit: 5). +- **Interactive**: Left-click to open the log; Right-click for focus modes or TomTom arrow integration. -# +
+ Tracker +
-# \- \*\*Custom IDs\*\* +### πŸ—ΊοΈ My Journey & Quests by Zone +- **Journey Log**: Record every major step of your adventure. +- **Completionist View**: Lists all available and completed quests per zone to ensure nothing is missed. -#   - Supports large integer IDs. +
+ Journey + Zone Quests +
-# +### πŸ” Database Search & Config +- **Global Search**: Find any NPC, Object, or Quest in the massive Questie database. +- **Deep Customization**: Adjust everything from icon scale to tracking logic. -# \- \*\*Minimap\*\* - -#   - Fixed errors when zooming the minimap. - -# - -# \- \*\*World Map\*\* - -#   1. Supports Ascension `WorldMapFrame` when minimized and draws icons correctly. - -#   2. Works with \*\*Mapster\*\* and \*\*Magnify-WotLK\*\*. - -# - -# \- \*\*New Content (Maps \& Quests)\*\* - -#   - Currently supports \*\*Ascension starter zones\*\* and some \*\*Ebonhold objectives\*\*. - -# - -# - -# - -# \## Features - -# - -# \### Ascension Scaling system - -# \- Scaling all quest to character level like Ascension Scaling system - -# - -# \### Show quests on map - -# \- Show notes for quest start points, turn in points, and objectives. - -# - -# !\[Questie Quest Givers](https://i.imgur.com/4abi5yu.png) - -# !\[Questie Complete](https://i.imgur.com/DgvBHyh.png) - -# !\[Questie Tooltip](https://i.imgur.com/uPykHKC.png) - -# - -# \### Quest Tracker - -# \- Improved quest tracker: - -#   - Automatically tracks quests on accepting (instead of progressing) - -#   - Can show all 20 quests from the log (instead of default 5) - -#   - Left click quest to open quest log (configurable) - -#   - Right-click for more options, e.g.: - -#   - Focus quest (makes other quest icons translucent) - -#   - Point arrow towards objective (requires TomTom addon) - -# - -# !\[QuestieTracker](https://user-images.githubusercontent.com/8838573/67285596-24dbab00-f4d8-11e9-9ae1-7dd6206b5e48.png) - -# - -# \### Quest Communication - -# \- You can see party members quest progress on the tooltip. - -# \- At least Questie version 5.0.0 is required by everyone in the party for it to work, tell your friends to update! - -# - -# - -# \### Tooltips - -# \- Show tooltips on map notes and quest NPCs/objects. - -# \- Holding Shift while hovering over a map icon displays more information, like quest XP. - -# - -# - -# \#### Quest Information - -# \- Event quests are shown when events are active! - -# - -# \#### Waypoints - -# \- Waypoint lines for quest givers showing their pathing. - -# - -# \### Journey Log - -# \- Questie records the steps of your journey in the "My Journey" window. (right-click on minimap button to open) - -# - -# !\[Journey](https://user-images.githubusercontent.com/8838573/67285651-3cb32f00-f4d8-11e9-95d8-e8ceb2a8d871.png) - -# - -# \### Quests by Zone - -# \- Questie lists all the quests of a zone divided between completed and available quest. Gotta complete 'em all. (right-click on minimap button to open) - -# - -# !\[QuestsByZone](https://user-images.githubusercontent.com/8838573/67285665-450b6a00-f4d8-11e9-9283-325d26c7c70d.png) - -# - -# \### Search - -# \- Questie's database can be searched. (right-click on minimap button to open) - -# - -# !\[Search](https://user-images.githubusercontent.com/8838573/67285691-4f2d6880-f4d8-11e9-8656-b3e37dce2f05.png) - -# - -# \### Configuration - -# \- Extensive configuration options. (left-click on minimap button to open) - -# - -# !\[config](https://user-images.githubusercontent.com/8838573/67285731-61a7a200-f4d8-11e9-9026-b1eeaad0d721.png) +
+ Search + Config +
+--- +## πŸ‘₯ Credits +- **Questie Team** - Original addon developers. +- **Xurkon** - Private Expansion fork and maintenance. +- **Project Ascension & Ebonhold Communities** - Testing and data feedback. +## πŸ“„ License +MIT License - See [LICENSE](LICENSE) for details.