Skip to content

About

World of Warcraft addon (Forever & Classic Era): ranks quests, dungeons, raids and crafts by how much their rewards upgrade your gear, using your spec's stat weights.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

165 Commits

Folders and files

Repository files navigation

Stuff Planner logo

Stuff Planner

Which quest, dungeon or craft is worth it for your gear?
A World of Warcraft addon that ranks every reward it knows by the upgrade it brings to your character.

CI Latest release CurseForge License: GPLv3


Why

Leveling and gearing in Classic-style WoW means constantly asking "is this quest chain worth it?" or "should I run this dungeon again?". Stuff Planner answers with numbers: it reads your equipped items, scores every known reward with stat weights for your specialization, and shows how much each one would improve you — then plans a route that balances that gain against the effort it costs.

Features

Now page Quests of the current zone sorted by gear gain, with their source and a confidence level; the play session at the top.
Route page A plan for your next steps: quest chains, dungeons, raids and crafts, weighted by effort, XP and how long the item will last.
Dungeons page Instances sorted by expected gain, with each boss and its useful drops.
Gear page Your target list on top (the items you aim for: star on any item row, share with friends), then the best upgrade for each slot, where to get it and how much it helps.
Profile page Your stat weights, a stat priority editor, import/export of custom weights (SPW1 strings), comparison with a secondary profile; your gear score over time and the bag items worth sending to your other characters.
Floating frame One frame that follows what you do: dungeon bosses, then the followed quest chain, then the best upgrades of the zone. Its mode icons switch mode; right-click its header for its menu.
Tooltips Gain line on item tooltips (also for your other characters); badges on bags, merchants and the auction house; best quest reward highlighted; Need/Greed advice on rolls.
Item sources Each of the Now, Route and Gear pages has its own choice of item sources (quests, dungeons, raids, crafts, world drops) in its Filters menu: only the chosen sources are suggested.
Navigation Built-in 3D waypoint arrow; world map and minimap pins shown as small round badges beside the quest giver, so the ! and ? stay visible. Uses TomTom when installed.
Stat weights 27 specializations, each with a leveling and a level 60 profile (several imported from WoWSims).

Also:

  • Works on its own — ships its own database; uses QuestieDB when installed for richer quest data.
  • Combat-safe — nothing is computed during combat; burst events are batched.
  • Lightweight — the database is a load-on-demand addon, decoded zone by zone.
  • Localized — every language of the Forever client: English, French, German, Spanish (EU and Latin America), Brazilian Portuguese, Russian, Korean, Simplified and Traditional Chinese. Game terms (stats, specializations, interface words) come from the game data; the other phrases are first drafts awaiting review by native speakers on the CurseForge translation portal.

Supported clients

Client Version Notes
WoW Forever 1.60.1 (Interface: 16001) Main target.
WoW Classic Era 1.15.x Forever-only content is hidden automatically.

Installation

CurseForge (recommended): install Stuff Planner from CurseForge or search for Stuff Planner in the CurseForge app — updates are automatic.

Manual: download the latest StuffPlanner-x.y.z.zip from the Releases page and extract it into your Interface/AddOns folder. You must end up with two folders:

Interface/AddOns/
├── StuffPlanner/        the addon
└── StuffPlanner_Data/   its database (loaded on demand)

Optional companions: QuestieDB, TomTom.

Getting started

  1. Log in: a 4-step welcome guide lets you pick the weight profile that matches your specialization and tours the pages.
  2. Open the main window with /splan (or the minimap button, or a key binding); the five tabs on the left switch pages.
  3. Follow the Now page while questing, or the Route page to plan ahead.
  4. The ? button of the window lists every gesture (clicks, modifiers, right-click menu) and command; the gear opens the settings.

Commands

Command Action
/splan Open or close the main window
/splan best List the 5 best quest rewards of the current zone in chat
/splan tracker Turn the zone mode of the floating frame on or off
/splan journal Open the Profile page on your progress
/splan arrow Turn the waypoint arrow on or off (used without TomTom)
/splan pins Show or hide map pins
/splan options Open the settings panel
/splan scale 0.9 Set the window scale
/splan welcome Show the welcome guide again
/splan export Export collected observations as text to share
/splan share Show the sharing status (option, channels, messages)
/splan why <item link> Break down an item's score, stat by stat, for the active profile
/splan perf Show memory use and the last computation times
/splan help Show all commands

How it works

Score(item) = Σ weight(stat) × value(stat)
Gain        = Score(new) − Score(equipped)          shown as a percentage
Priority    = (Gain × item lifetime + α · XP) / effort
  • Hit caps are handled at the margin: hit above the cap is worth nothing.
  • Effort depends on the source: remaining quest chain, elite mobs, distance; drop rate for dungeons; raids are heavily weighted and off the route by default; skill and reagents for crafts.
  • The weight profile switches from leveling to level 60 automatically.

Data comes in three layers, the most specific winning:

  1. Imported database — built offline from public sources, each entry with a confidence level.
  2. Overlay — corrections merged from player exports (/splan export).
  3. Local observations — what the addon saw on your client (rewards, NPC positions, item stats).

Known limitations

  • No world drops or vendor sources yet.
  • Some item stats are estimated on Classic Era until the game sends them (read automatically after login).
  • A few quests without a known quest giver only show their zone.
  • Hidden Forever items are only known once the server reveals them.

Contributing

Bug reports, data exports and pull requests are welcome — please open an issue. For wrong or missing data, attaching the output of /splan export helps a lot.

Building from source

Requirements: GNU Make, a POSIX shell (Git Bash on Windows), Lua 5.1 with luacheck, Python 3.

Command What it does
make lint luacheck + check that version-specific APIs go through Compat
make data Build StuffPlanner_Data from the sources (downloaded and cached in tools/cache/)
make weights Regenerate Profiles/Defaults.lua from tools/weights_input/
make zip Fetch pinned libraries and package build/StuffPlanner-<version>.zip
make deploy Copy the addon to your AddOns folders (WOW_ADDONS_VANILLA and WOW_ADDONS_FOREVER in a .env file)

Project layout

StuffPlanner/        main addon
  Core.lua           namespace, message bus, slash commands
  Compat*.lua        every API that differs between Forever and Classic Era
  Data/              database access, QuestieDB adapter, observation collector
  Engine/            pure Lua (no WoW API): stat parsing, scoring, route planning
  UI/  UI/Presenters/  frames, and the testable logic behind them
  Profiles/          stat weights and priorities
  Locales/           AceLocale strings
tools/               Python database builder, packager, weight generator

Each Lua module starts with a short CONTRAT header describing its interface.

Credits

The database is built from:

  • QuestieDB — quests, rewards, maps, quest conditions (GPLv3)
  • Questie — list of unavailable quests, used to leave them out (GPLv3)
  • CMaNGOS classic-db — fixed vs choice quest rewards (GPLv3)
  • NorgannonDB by Maro — Classic instance boss loot (GPLv3)
  • pfQuest by Shagu — drop rates, via NorgannonDB (MIT)
  • WoW-Spyglass — encounter loot and Forever item stats (MIT)
  • wago.tools — game client tables
  • WoWSims — stat weights for several specializations

Libraries: Ace3, LibDataBroker-1.1, LibDBIcon-1.0, HereBeDragons-2.0, LibDeflate. Full third-party notices: tools/THIRD_PARTY.txt.

World of Warcraft and its game data are trademarks and property of Blizzard Entertainment, Inc. This project is not affiliated with or endorsed by Blizzard.

License

GNU General Public License v3.0.

About

World of Warcraft addon (Forever & Classic Era): ranks quests, dungeons, raids and crafts by how much their rewards upgrade your gear, using your spec's stat weights.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages