# Interactive Node
[](https://travis-ci.org/mixer/interactive-node)
A TypeScript, Node.js and Browser(JavaScript) compatible client for [Mixer.com's interactive 2 Protocol](https://dev.mixer.com/guides/mixplay/protocol/overview).
For an introduction to interactive2 checkout the [reference docs](https://dev.mixer.com/guides/mixplay/introduction) on the developers site.
## Installation
You can use npm(recommended) or download a zip from the [releases page](https://github.com/mixer/interactive-node/releases).
### Browser
```html
```
### Node
```
npm i --save @mixer/interactive-node
```
## Usage
### Authentication
[OAuth 2.0](https://tools.ietf.org/html/rfc6749) is used for authentication. Valid bearer tokens can be passed in the `Client.open` method.
For more information about Mixer's OAuth visit the [OAuth reference page](https://dev.mixer.com/reference/oauth/index.html) on our developer site.
### Browser
#### index.html
```html
Interactive 2
```
#### app.js
```js
const client = new interactive.GameClient();
client.open({
authToken: '',
versionId: 1234,
});
```
### Node
#### JavaScript
```js
const interactive = require('@mixer/interactive-node');
const ws = require('ws');
interactive.setWebSocket(ws);
const client = new interactive.GameClient();
client.open({
authToken: '',
versionId: 1234,
});
```
#### TypeScript
```ts
import { GameClient, setWebSocket } from '@mixer/interactive-node';
import * as ws from 'ws';
setWebSocket(ws);
const client = new GameClient();
client.open({
authToken: '',
versionId: 1234,
});
```
## Examples
Checkout our [examples](https://github.com/mixer/interactive-node/tree/master/examples/) to get up to speed quickly!
* [basic](https://github.com/mixer/interactive-node/tree/master/examples/basic.ts) - Connects and sets up 5 buttons, when they are clicked the participant is charged 1 spark.
* [dynamicControls](https://github.com/mixer/interactive-node/tree/master/examples/dynamicControls.ts) - Connects and then creates and destroys 5 buttons with random text.
* [joystick](https://github.com/mixer/interactive-node/tree/master/examples/joystick.ts) - Connects and creates a joystick, logs participant coordinate values.
Using Node.js? Clone this repository and run `npm run build` and the examples will be converted to JavaScript for you!
## Documentation
Checkout our reference docs [here](https://mixer.github.io/interactive-node/).
## Development
To get a development environment setup:
1. [Clone this repository](https://help.github.com/articles/cloning-a-repository/)
2. `npm install`
3. `npm run build`
### Contributing
Thanks for your interested in contributing, checkout [TODO.md](https://github.com/mixer/interactive-node/blob/master/TODO.md) for a list of tasks!
Open a [Pull Request](https://github.com/mixer/interactive-node/pulls) we'd love to see your contributions.