https://github.com/sumolari/wam

World of Warcraft Addons Manager
https://github.com/sumolari/wam

Last synced: 24 days ago
JSON representation

World of Warcraft Addons Manager

• Host: GitHub
• URL: https://github.com/sumolari/wam
• Owner: Sumolari
• License: mit
• Created: 2016-07-24T06:09:52.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-10-15T05:44:32.000Z (about 5 years ago)
• Last Synced: 2024-10-19T05:26:51.067Z (28 days ago)
• Language: CoffeeScript
• Size: 14.6 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![npm](https://img.shields.io/npm/v/wam.svg?maxAge=2592000)](https://www.npmjs.com/package/wow-am) [![npm](https://img.shields.io/npm/l/wow-am.svg?maxAge=2592000)](https://www.npmjs.com/package/wow-am)

**wam** is a command-line utility to bulk install and update [World of Warcraft](https://battle.net/wow) addons on **macOS**. It uses [Curse.com](http://mods.curse.com/addons/wow) addons database.

# Installation

**wam** requires [Node.js](https://nodejs.org) and [NPM](https://www.npmjs.com). Having both set up you can just install it as a global package:

```

npm install -g wow-am

```

![Installation](https://cloud.githubusercontent.com/assets/779767/17183583/7778fbe6-5428-11e6-912d-89de8724e048.gif)

# Configuration

**wam** reads a `wamfile` config file to know where is located your World of Warcraft installation and which addons you want to install/update.

A `wamfile` is just a JSON file with two keys:

1. `wowPath` has a string associated telling **wam** where is located your World of Warcraft installation. The path should point to the folder containing World of Warcraft executable and `Interface` folder.

1. `addons` is an array of strings. Each item is a `Curse identifier` of an addon.

This is a sample `wamfile` shipped with **wam**:

```

{

	"wowPath": "/Applications/Battle.net/World of Warcraft",

	"addons": [

		"deadly-boss-mods"

	]

}

```

## Curse identifiers

The easiest way to know the identifier of an addon is searching it in [Curse.com database](http://mods.curse.com/addons/wow). Each addon has an information page with a download link and the URL to that page follows this pattern: `http://mods.curse.com/addons/wow/`.

For instance, [Deadly Boss Mods](http://mods.curse.com/addons/wow/deadly-boss-mods)'s identifier is `deadly-boss-mods`.

# Usage

```

[INFO] Usage: wam  [wamfilePath]

```

**wam** supports two commands:

1. `init` will create a sample `wamfile` in specified folder.

2. `update` installs or updates addons specified by `wamfile` at given path.

If no path is given the current directory will be used.

![wam init](https://cloud.githubusercontent.com/assets/779767/17184185/32c2dac8-542b-11e6-9de6-66433bad0ce7.gif)

![wam update](https://cloud.githubusercontent.com/assets/779767/17184190/3711dcd2-542b-11e6-9c29-5f3a2bc74d75.gif)

# To do...

- [x] Fix wamfile creation when path to a folder is given

- [x] Fix wamfile creation when path to a file is given

- [x] Add some images to Readme.

- [ ] Check Windows compatibility.

- [ ] Port to ES6.

- [ ] Add tests.

- [ ] Improve metadata (version) extraction from curseforge.com.

# Changelog

## 0.0.4

- Add support for new curseforge.com AddOns repository.

## 0.0.3

- Fixed `wamfile` creation when given a path.

## 0.0.2

- Fixed sample `wamfile`.

## 0.0.1

- First released version! 🎉