Skip to content

Commit

Permalink
Flesh out README
Browse files Browse the repository at this point in the history
  • Loading branch information
timkurvers committed May 11, 2020
1 parent 4339e71 commit 3a114c3
Showing 1 changed file with 83 additions and 3 deletions.
86 changes: 83 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,88 @@
# Wowser Client

[![Join chat](https://img.shields.io/badge/gitter-join_chat-blue.svg?style=flat)](https://gitter.im/wowserhq/wowser)
[![Build Status](https://travis-ci.org/wowserhq/ui.svg?branch=master)](https://travis-ci.org/wowserhq/client)
![Node Version](https://badgen.net/badge/node/12+/green)
[![MIT License](https://badgen.net/github/license/wowserhq/client)](LICENSE.md)
![Checks](https://badgen.net/github/checks/wowserhq/client)
[![Join chat](https://badgen.net/badge/gitter/join%20chat/red)](https://gitter.im/wowserhq/wowser)

Web client for Wowser.
World of Warcraft in the browser using JavaScript and WebGL.

This repository contains the web client.

Licensed under the [**MIT** license](LICENSE).

## Background

Wowser is a proof-of-concept of getting a triple-A game to run in a webbrowser.

See the [Wowser] umbrella repository for more information.

## Status

This repository contains the Wowser web client, which currently has support for:

- Loading Blizzard UI files (`.toc`, `.xml` and `.lua`)
- Extremely primitive scene rendering using WebGL 2 (frames and textures mostly)
- GLSL ES 300 shaders and PNG textures (no BLP support yet)

**Note:** Only Wrath of the Lich King (3.3.5a) is currently supported. A copy of
the official client is required.

## Development

Wowser is written in [ES2015+], modularized using [ECMAScript modules] and
developed with [webpack].

1. Clone the repository:

```shell
git clone git://github.com/wowserhq/wowser.git
```

2. Download and install [Node.js] – including `npm` – for your platform.

3. Install dependencies:

```shell
npm install
```

4. Extract interface files from the official Wrath of the Lich King client into
the `public` folder, resulting in the following structure:

```
public
├── Interface
├── Shaders
└── Wowser
```

In addition, convert BLP files to PNGs, using [BLPConverter].

This entire step will be obsolete [soon™].

5. Run the dev server:

```shell
npm run start:dev
```

**Disclaimer:** Wowser 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.

## Contribution

When contributing, please:

- Fork the repository
- Open a pull request (preferably on a separate branch)

[BLPConverter]: https://github.com/wowserhq/blizzardry#blp
[ECMAScript modules]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[ES2015+]: https://babeljs.io/docs/learn-es2015/
[Node.js]: http://nodejs.org/#download
[StormLib]: https://github.com/wowserhq/blizzardry#mpq
[Wowser]: https://github.com/wowserhq/wowser
[soon™]: http://www.wowwiki.com/Soon
[webpack]: http://webpack.github.io/

0 comments on commit 3a114c3

Please sign in to comment.