Wowser Pipeline

Wowser Pipeline is the client asset server for the Wowser project.

It makes World of Warcraft client data available over HTTP, and enables useful transformations of that data (ex: DBC-to-JSON, BLP-to-PNG).

A copy of the World of Warcraft client is required to use Wowser and Wowser Pipeline.

Licensed under the MIT license, see LICENSE for more information.

Features

Wowser Pipeline currently supports clients that use MPQ archives to store data. This covers early alpha builds of World of Warcraft through the Mists of Pandaria expansion. CASC-using versions of World of Warcraft are not currently supported.

Pipeline capabilities:

Serving unmodified copies of assets
Serving transformed copies of assets
Glob-style search API (ex: /pipeline/find/*penguin*)

Transformation capabilities:

BLP-to-PNG
DBC-to-JSON

Node Support

Currently, Wowser Pipeline supports the LTS and current releases of Node:

Node 6.x (LTS)
Node 7.x (Current)

Installation and Use

Wowser Pipeline is available to install from npm.

To install globally, run:
```
npm install -g wowser-pipeline
```
Once the pipeline is installed, and its binary dependencies are built for your system, you can start the pipline server in production mode by running:
```
wowser-pipeline
```
at a shell prompt. If it's your first time running the pipeline server, you'll be prompted to answer a few first-run questions (see the First Run section below).
If all went well, you should be able to try a pipeline search by visiting the following URL in your browser:
```
http://localhost:<configured-port>/pipeline/find/*penguin*
```

First Run

On first run of the pipeline server, you will be prompted to specify the following:

Path to client data folder (e.g. C:/Program Files (x86)/World of Warcraft/Data)
Server port (default is 3000)
Number of cluster workers (default depends on amount of CPUs)

Clear these settings by running npm run reset

Disclaimer: Wowser Pipeline serves up resources to the browser over HTTP. Depending on your network configuration these may be available to others. Respect laws and do not distribute game data you do not own.

Development

Wowser Pipeline is written in ES2015, developed with Gulp, compiled by Babel and soon™ to be tested through Mocha.

Clone the repository:

git clone git://github.com/wowserhq/wowser-pipeline.git

Download and install Node.js – including npm – for your platform.
Install dependencies:
```
npm install
```
Install StormLib and BLPConverter, which are used to handle Blizzard's game files.
Choose a development mode:

Note: If this is your first time running the pipeline server, you'll be prompted for various settings. See the First Run section above for more details.

All-In-One

If you would prefer an all-in-one development setup, you should run:
```
npm run develop
```
This will start the pipeline server, and monitor for any changes in src/**/*. Whenever a change is detected, the pipeline server will be automatically linted, tested, rebuilt and restarted.

Split

If you would prefer to split up linting, testing, and building into separate shell sessions, you should run each of these commands individually:
```
npm run lint:watch
npm run test:watch
npm run build:watch
```
and then run the following to start the server:
```
npm run start
```
Please keep in mind that you'll need to manually restart the server each each time you make changes. Make sure you pay attention to the output of each of the linting, testing, and building sessions.
If all went well, you should be able to try a pipeline search by visiting the following URL in your browser:
```
http://localhost:<configured-port>/pipeline/find/*penguin*
```

Contributing

When contributing, please:

Fork the repository
Create a single-topic branch in your fork
Open a pull request using the branch from step 2
Fix any issues raised by the CI environment
Be patient while waiting for the PR to be reviewed

wowserhq / pipeline