Command line tool to build and upload mods to CurseForge
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
.travis.yml
README.md
cli.js
index.js
package-lock.json
package.json

README.md

UpMod 📦

Builds and uploads World of Warcraft addons to CurseForge. It supports the following features:

  • Build and upload of .zip files using a curseforge API key
  • .gitignore style ignore for upload (called .upignore)
    • .lua and .xml files will be replaced by the simplest file the game client will accept without crashing
  • Version name detection from changelogs
    • Automatic .toc version update
  • .toc title color removal, without changing source code (so you can highlight your mods ingame in awful colors locally, without harming users eyeballs)
  • Automatic patron list generation into any chosen .lua variable
  • Automatic copyright years period duration

CLI Usage

Install using npm:

npm install -g upmod

Use the help flag to learn how to use it:

upmod -h

When you first start the command line interface, you will be guided to input the required global configuration. Then, you can use the CLI commands normally as described by the help flag.

Programmatic Usage

Yes, there is an API to use in node if you really want one.

const upmod = require('upmod')

let build = upmod.make(data)
let result = upmod.upload(build)