# wow-am

> A NPM-like World of Warcraft Addon Manager

Latest version **0.0.4** (published 2017-12-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install wow-am
pnpm add wow-am
yarn add wow-am
bun add wow-am
```

Provides the command `wam`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2017-12-12 |
| First published | 2016-07-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| Author | Lluís Ulzurrun de Asanza i Sàez |
| Maintainers | lluis |
| Keywords | world, of, warcraft, addon, manager, wow, npm |

## Links

- npm: https://www.npmjs.com/package/wow-am
- Repository: https://github.com/Sumolari/WAM
- Homepage: https://github.com/Sumolari/WAM#readme
- Issues: https://github.com/Sumolari/WAM/issues
- npm.io page: https://npm.io/package/wow-am

## Dependencies (9)

- [mv](https://npm.io/package/mv.md) ^2.1.1
- [async](https://npm.io/package/async.md) ^2.0.1
- [colors](https://npm.io/package/colors.md) ^1.1.2
- [lodash](https://npm.io/package/lodash.md) ^4.13.1
- [rimraf](https://npm.io/package/rimraf.md) ^2.5.4
- [request](https://npm.io/package/request.md) ^2.74.0
- [bluebird](https://npm.io/package/bluebird.md) ^3.4.1
- [extract-zip](https://npm.io/package/extract-zip.md) ^1.5.0
- [coffee-script](https://npm.io/package/coffee-script.md) ^1.10.0

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2017-12-12
- 0.0.3 — 2016-07-27
- 0.0.2 — 2016-07-26
- 0.0.1 — 2016-07-26

## 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/<curse-identifier>`.

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

# Usage

```
[INFO] Usage: wam <command> [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.

# 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! 🎉

---
_Source: https://npm.io/package/wow-am · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._