Add installation guide and author credits

2026-10-07 18:46:24 +00:00
parent 1cc4726299
commit 8d58e14088
2 changed files with 78 additions and 2 deletions
@@ -0,0 +1,26 @@
+MIT License
+
+Copyright (c) 2026 John The Baptist
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+Third-party data attribution: VanillaXP.lua contains numeric quest facts
+extracted from MrFox's LibQuestXP data, as distributed in Questie v6.8.0.
+The original library implementation is not included. This notice does not
+purport to relicense third-party materials; their source is credited in README.md.
@@ -1,3 +1,53 @@
-# OctoQuestRewards
+# OctoQuestRewards 1.0.0

-Estimated quest XP in the original quest UI for OctoWoW 1.18.1. Made by John The Baptist.
+See a quest's **estimated XP reward** without leaving the original quest window.
+A small, free addon for **OctoWoW 1.18.1**.
+
+**Made by John The Baptist.**
+
+## What it does
+
+- Shows XP before accepting a quest, in the Quest Log, and when turning it in.
+- Uses the same font as the quest text.
+- Leaves the game's money and item rewards alone.
+- No extra window, libraries or setup menu.
+
+**XP is an estimate.** Custom quests, XP bonuses and server changes can differ.
+If the addon cannot identify a reward safely, it hides the XP line.
+
+## Install
+
+1. Download **OctoQuestRewards-1.0.0.zip** from the forum attachment or repository Releases.
+2. Extract it into your WoW `Interface/AddOns` folder.
+3. Restart WoW and enable **OctoQuestRewards** at character selection.
+
+The folder must contain `Interface/AddOns/OctoQuestRewards/OctoQuestRewards.toc`.
+Use it with **pfQuest + pfQuest-turtle**. **pfExtend** and **ClassicAPI** are optional.
+
+## Commands
+
+- `/oqr` — help.
+- `/oqr status` — version and reward sources.
+- `/oqr debug` — toggle reward comparisons in your own chat window.
+
+## Screenshots
+
+Before accepting:
+
+![Estimated XP before accepting a quest](screenshots/quest-offer.png)
+
+In the Quest Log:
+
+![Estimated XP in the Quest Log](screenshots/quest-log.png)
+
+Turn-in: this test quest estimated **170 XP** and awarded **170 XP**.
+
+![170 XP received after turning in the test quest](screenshots/quest-turn-in.png)
+
+## Credits
+
+Vanilla XP data: [MrFox / LibQuestXP](https://github.com/Questie/Questie/blob/v6.8.0/LibsOnlyClassic/LibQuestXP/LibQuestXPDB.lua).
+Quest matching and optional custom data come from your installed pfQuest, pfQuest-turtle and pfExtend.
+Independent addon; no changes to those addons are required.
+
+*It's not much, but it's honest work.*