Skip to content
This repository has been archived by the owner on Jun 4, 2018. It is now read-only.

AddonList

Adrian L Lange edited this page Oct 14, 2017 · 7 revisions

The app requires a list of the addons you want to use with the app, and a bit of details about each addon.
But, first off, we're going to prepare a gist!

  1. Visit gist.github.com, you will be greeted with a few text input fields.
  2. Where it says Name this file..., type addons.json. This will turn the dropdown next to it to Language: JSON.
  3. In the big text input field, we're going to add something called a JSON array of objects. Follow this syntax:
[
   {
      "path": "AmazingAddon",
      "repo": "Amazing-Addon",
      "curse": "amazing-addon",
      "wowi": "87162",
      "changelog": true,
      "changelogPath": "docs/CHANGES.md"
   }
]
  • path is the packaged file's name and directory, basically the same as your .toc file.
  • repo is the name of the repository on GitHub.
  • curse is the "slug" for the addon on Curse/CurseForge, commonly seen in the urls.
    • Example: amazing-addon in http://www.curse.com/addons/wow/amazing-addon
  • wowi is the id for the addon on WowInterface, also commonly seen in the urls.
    • Example: 87162 in http://www.wowinterface.com/downloads/info87162-AmazingAddon.html
  • changelog must be set to true if you want the app to update the changelog on WowInterface. See this wiki page for more details.
  • changelogPath full path to the changelog file.
    • Defaults to /CHANGELOG.md

To add more, just chain objects together. See my list if you're confused.

When you're done editing, click either of the two Create Gist buttons.
It doesn't matter which one you choose, the app can use both.

Notice the url on the page, you need to grab the ID, the last part.
Example: a04cf78336885b350b64 in https://gist.github.com/p3lim/a04cf78336885b350b64

And there you go, that's your ID.
Use this string of letters and digits for the GIST_ID input in the deploy prompt.

Updating the list

Whenever you want to change your addons list, let say add, remove or change an addon's details, just do your changes and save it, the gist uses the same ID forever.

Clone this wiki locally