Skip to content
This repository was archived by the owner on Oct 24, 2018. It is now read-only.

Commit 30519bf

Browse files
committed
Update README.md
1 parent ccfb59e commit 30519bf

File tree

1 file changed

+49
-1
lines changed

1 file changed

+49
-1
lines changed

README.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,49 @@
1-
Twitch Plays Light Simulator 2015
1+
# node-prettylights
2+
3+
Twitch Plays Light Simulator 2015
4+
5+
## Installing
6+
7+
Absolutely no clue. I guess download this repository...
8+
9+
```bash
10+
$ git clone https://github.com/synth3tk/node-prettylights.git
11+
```
12+
13+
...then bash your head on the keyboard in the following sequence:
14+
15+
```bash
16+
$ npm install
17+
```
18+
19+
Tell me if it doesn't work. Because I definitely didn't test installing this thing from scratch. The only other thing I made with Node was a website, so I'm not sure how to make this distribution-friendly. Feel free to tell me how wrong I am on [Twitter](https://twitter.com/synth3tk).
20+
21+
## Configuration
22+
23+
Create the file `config/.env` (good luck, Windows users!) with the following three lines:
24+
25+
* `TWITCH_USER=<bot_name_username>`
26+
* Create a new account for the bot if you haven't already
27+
* `TWITCH_OAUTH=<bot_oauth_password>`
28+
* Visit http://twitchapps.com/tmi/ to generate an OAuth password
29+
* `TWITCH_CHANNELS=<channels>`
30+
* A comma-separated value of channels for the bot to enter (ideally, your channel).
31+
32+
While giving the bot mod powers is completely optional at this time, you can go ahead and do it anyway. I don't care, it's your channel!
33+
34+
## Start it up
35+
36+
```bash
37+
$ node server.js
38+
```
39+
40+
The bot will now search for a Hue bridge, register itself (first run), collects information about the Hue setup and stores it in a file (first run), then it finally joins Twitch chat, waiting for your users to abuse it!
41+
42+
## TO-DO
43+
44+
* Organize the code better
45+
* Proper error handling
46+
* Option to flash lights on events (follower, subscription, etc)
47+
* Blacklist/whitelist ability
48+
* Flood control (holy crap, why's that not in the 1.0 release?)
49+
* Buy more body wash

0 commit comments

Comments
 (0)