The WowUp Hub

How the Hub lists addons released on GitHub and GitLab, and how authors can get theirs listed.

The WowUp Hub lists addons that their authors release on GitHub or GitLab. WowUp installs and updates them like addons from any other source, and you can browse them on this site under Addons.

For authors, the Hub is a way to distribute an addon on your own terms: keep your code and releases where they are, and the Hub picks up each new release for WowUp players. It also shows your funding links in the app.

Listing your addon

The Hub supports GitHub and GitLab, since both let you publish releases. Other sources are possible case by case; ask on Discord.

Zip file

Each release needs your addon in a zip file. The zip can have any name, but your addon's top-level folder (or folders) must be at the root of the zip. For example, the WowUp addon's WowUp.zip contains a single WowUp folder:

WowUp.zip
└── WowUp
    ├── WowUp_Mainline.toc
    ├── main.lua
    └── ...

If your releases use the BigWigs packager's release.json, the Hub reads it to tell which zip is for which game version.

TOC files

The Hub supports a single Addon.toc, or one TOC file per game version, such as:

  • Addon_Mainline.toc for Retail
  • Addon_Mists.toc for Mists of Pandaria Classic
  • Addon_TBC.toc for Burning Crusade Classic
  • Addon_Vanilla.toc for Classic Era
  • Addon_Forever.toc for WoW Forever

The Hub reads each TOC to work out which game versions a release supports.

Images

Icon

On GitHub, the Hub uses your repository's social preview image, and your avatar if you haven't set one. See GitHub's guide to customizing your repository's social media preview. On GitLab, the Hub uses the project's avatar, or the group's if the project has none.

Screenshots

To show screenshots in the app and on your addon's page, add a .previews folder with your images to the branch you tag for a release. The Hub takes the images that are in the folder when it processes the release, so each release can have its own screenshots.

On GitHub, the Hub reads your funding links from .github/FUNDING.yml. WowUp shows them next to your addon, and so does your addon's page on this site.

Funding links shown next to an addon in WowUp

Categories

On GitHub, topics put your addon into categories on WowUp's Get Addons tab. Add any of the topics below, in any order, with or without a wow- prefix (wow-bags works too). Each line is a category, followed by the topics that put an addon in it.

Category Topics
Achievements achievements
Action Bars action-bars
Auction & Economy auction-economy, auction, economy
Bags & Inventory bags-inventory, bags, inventory
Boss Encounters boss-encounters
Buffs & Debuffs buffs-debuffs, buffs, debuffs
Bundles bundles, bundle
Chat & Communication chat-communication, chat, communication
Class class, warrior, paladin, hunter, rogue, priest, shaman, mage, warlock, monk, druid, demon-hunter, death-knight
Combat combat
Companions companions
Data Export data-export
Development Tools development-tools, development, tools
Guild guild
Libraries libraries, library
Mail mail
Map & Minimap map-minimap, map, minimap
Miscellaneous miscellaneous, misc
Missions missions
Plugins plugins, plugin
Professions professions, profession, alchemy, engineering, leatherworking, mining, fishing, blacksmithing, inscription, tailoring, skinning, archaeology, enchanting, jewelcrafting, herbalism, cooking
PvP pvp
Quests & Leveling quests-leveling, quests, leveling
Roleplay roleplay, rp
Tooltips tooltips, tooltip
Unit Frames unit-frames, unit-frame