https://github.com/royaleint/homestead
Every housing decor vendor across all expansions pinned to your map with full item lists and your collection progress for each. Homestead enhances the decor catalog tooltips with source and pricing so you always know where to find that special piece with their full inventory - no more alt-tabbing
https://github.com/royaleint/homestead
lua warcraft world-of-warcraft world-of-warcraft-addon wow wow-housing
Last synced: 16 days ago
JSON representation
Every housing decor vendor across all expansions pinned to your map with full item lists and your collection progress for each. Homestead enhances the decor catalog tooltips with source and pricing so you always know where to find that special piece with their full inventory - no more alt-tabbing
- Host: GitHub
- URL: https://github.com/royaleint/homestead
- Owner: Royaleint
- License: gpl-3.0
- Created: 2026-02-01T02:34:11.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-06-04T22:46:21.000Z (22 days ago)
- Last Synced: 2026-06-05T00:13:35.568Z (22 days ago)
- Topics: lua, warcraft, world-of-warcraft, world-of-warcraft-addon, wow, wow-housing
- Language: Lua
- Homepage: https://www.curseforge.com/wow/addons/homestead-wow
- Size: 4.56 MB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Homestead
> **Current version:** v2.5.0 | TOC: 120005 | WoW Retail 12.0.5+
A World of Warcraft housing addon for collectors who want answers, not interfaces. Open your map and see exactly where to find the decor you're missing — no massive windows, no menus, no setup.
## Features
- **Map Pins** — Housing decor vendors pinned to your world map and minimap with full inventory tooltips on hover.
- **Pin Colors** — Customize your pins with 10 color presets or a full RGB picker. Unverified vendors stay orange so you can spot them at a glance.
- **Decor Availability** — Vendor pins, zone summaries, and the side panel break down each vendor's stock into three states: collected, available now, and locked behind reputation, quests, or profession requirements.
- **Color-Coded Progress** — Collection progress bars fill in three colors: green for what you own, gold for what you can buy right now, and red for what's locked.
- **Requirements on Hover** — Hover a vendor pin and see exactly what's blocking each locked item — the rep, quest, or profession you still need.
- **Bag and Merchant Icons** — A housing-themed icon overlays decor items in your bags, bank, and at merchants — green when collected, red when not. Works with Blizzard's default UI, Baganator, and BetterBags.
- **Ownership Tracking** — Items tracked globally, so ownership is accurate regardless of source — vendor purchase, quest reward, achievement unlock, or profession craft.
- **Auto-Scanning** — Visit a vendor and Homestead automatically records what they sell, including prices and item requirements. Toggle this off in Options if you prefer.
- **Multi-Source Database** — Vendors, quest rewards, achievement unlocks, profession recipes, and world drops tracked across all expansions from Classic through Midnight.
- **Faction Filtering** — Opposite-faction vendors hidden by default. Toggle visibility in Options.
- **Community Data Sharing** — Export your scanned vendor data and submit it to help fill gaps in the database. [Submit your export here](https://forms.gle/hap2Mn1GKhweu1vp9)
## Installation
1. Download from [CurseForge](https://www.curseforge.com/wow/addons/homestead-wow) or [Wago](https://addons.wago.io/addons/homestead)
2. Or extract manually to `World of Warcraft/_retail_/Interface/AddOns/Homestead`
3. Enable in your addon list and `/reload`
## Commands
| Command | Description |
|---------|-------------|
| `/hs` | Open options panel |
| `/hs scan` | Refresh your ownership cache |
| `/hs vendor [name]` | Search for a decor vendor by name |
| `/hs vendors` | List scanned vendor data |
| `/hs panel` | Toggle the detached vendor panel |
| `/hs refreshmap` | Refresh all map pins |
| `/hs corrections` | Show detected NPC ID corrections |
| `/hs export` | Export scanned vendor data for sharing |
| `/hs welcome` | Reopen the welcome screen |
| `/hs whatsnew` | Reopen the latest What's New screen |
| `/hs debug` | Toggle debug mode (useful for bug reports) |
## How It Works
Homestead tracks your housing decor collection across your entire account. When you acquire a decor item from any source like buying from a vendor, completing a quest, or earning an achievement it's recorded and reflected everywhere. If two vendors sell the same item, buying from either one marks it as owned on both.
Visit any decor vendor and Homestead will automatically scan their inventory, recording items, prices, and requirements. This data shows up in map pin tooltips so you always know what a vendor sells before you travel there. This helps us keep the database up-to-date! Not interested in this? Disable vendor scanning in /hs config
## Known Limitations
- **First Login** — Some ownership data may not appear until you open the Housing Catalog UI once per session. After that, everything stays accurate.
- **Data Gaps** — A small number of vendors may have incomplete item lists while we gather scan data. These are marked "unverified" on the map.
## Contributing
Community-scanned vendor data is welcome! Use `/hs export` and submit via [GitHub Issues](https://github.com/Royaleint/Homestead/issues).
When reporting bugs, include the vendor name, zone, what you expected vs. what the addon showed, and your character's faction.
## Acknowledgments
Vendor and item data verified against [WoW Housing Hub](https://housing.wowdb.com) — an invaluable community resource for housing decor tracking.
Special thanks to Azro, author of [HomeDecor](https://www.curseforge.com/wow/addons/homedecor), for being open to sharing ideas and suggestions for improvements.
### Libraries
- [Ace3](https://www.wowace.com/projects/ace3) (AceDB)
- [CallbackHandler](https://www.wowace.com/projects/callbackhandler)
- [LibDataBroker](https://www.wowace.com/projects/libdatabroker-1-1)
- [LibStub](https://www.wowace.com/projects/libstub)
- [WagoAnalytics](https://addons.wago.io/addons/wago-analytics)
## License
[GPL-3.0](LICENSE)