Skip to content

Commit

Permalink
Refactoring of the bot.
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric Lakatos committed May 16, 2018
1 parent c7371e9 commit 55cc7eb
Show file tree
Hide file tree
Showing 192 changed files with 845 additions and 1,915 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ node_modules

# client files
client/docs/build/
dist/
client/tracker/dist/
30 changes: 15 additions & 15 deletions DOCS.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
# Windfish.io


## Settings

The tracker comes with a range of features, all of which can be activated via options drawer which is shown when you click the `Toggle settings menu` button at the top right of the screen.

Your settings will be cleared on page refresh unless you enable the `Keep settings` option. Any option you have selected while this option is enabled will make your settings persistent after page refresh/page bookmark.


## Tracking

All trackers are activated with click events that will cycle the different sprites available to that container. The overworld has a replacement context menu that enables you to place/remove markers on each overworld screen.

- The timer works by clicking to start and clicking again to stop. Stoping the stop activates a `save` button that saves your current time for later.
* The timer works by clicking to start and clicking again to stop. Stoping the stop activates a `save` button that saves your current time for later.

- The overworld can have markers placed on any location. Use the context click to select a marker. Using primary click with activate/deactivate the `cleared` state that will cover other markers but does not replace previously placed markers. Only the `reset` option in the context menu will remove all markers and states.
* The overworld can have markers placed on any location. Use the context click to select a marker. Using primary click with activate/deactivate the `cleared` state that will cover other markers but does not replace previously placed markers. Only the `reset` option in the context menu will remove all markers and states. Clicking the same marker twice will remove it from the screen.

- The item tracker activates by a simple primary click.
* The item tracker activates by a simple primary click.

## Broadcast Mode

## Twitch.tv Integration
In broadcast mode, you connect to the server via a unique seed. Once joined, you can share this seed onother clients and they can join the same session. When clients are connected under the same seed any changes to the item tracker will trigger on all clients.

The page will do most of the work - all you need to do is enter your channel name. If you want a custom tracker command you can enter one too. Keep in mind that if you are not the channel broadcaster that you connect to then you will not be able to control the tracker.
## Twitch Bot Tracking

The bot will join the channel silently. To activate it use `!tracker (or your custom command) activate`. You can then use `!tracker add [username]` to add that chat user to the whitelist to be able to run commands. A quick rundown of the commands are:
**Only available in Broadcast Mode** Type in a channel for a bot to join the Twitch channel. To activate the use `!tracker activate`. You can then use `!tracker add [username]` to add that chat user to the whitelist to be able to run commands. A quick rundown of the commands are:

- !tracker, !tracker commands - Essentially pings the bot to see if it is available and returns the list of commands for general users.
- !tracker activate - Activates the tracker so commands can be performed
- !tracker deactivate - Stops the tracker from taking commands
- !tracker add [username] - Adds a user to the whitelist. Broadcaster and Mods are automatically whitelisted
- !tracker remove [username] - Removes a user from the whitelist.
- !tracker disable whitelist - Disables the whitelist so anyone can use commands
- !tracker enable whitelist - Enables the whitelist so anyone can use commands
* !tracker, !tracker commands - Essentially pings the bot to see if it is available and returns the list of commands for general users.
* !tracker activate - Activates the tracker so commands can be performed
* !tracker deactivate - Stops the tracker from taking commands
* !tracker add [username] - Adds a user to the whitelist. Broadcaster and Mods are automatically whitelisted
* !tracker remove [username] - Removes a user from the whitelist.
* !tracker disable whitelist - Disables the whitelist so anyone can use commands
* !tracker enable whitelist - Enables the whitelist so anyone can use commands
* !tracker [item name]
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ $ npm install
$ npm start
```

Your app should now be running on [localhost:5000](http://localhost:5000/).
Your app should now be running on [localhost:3000](http://localhost:3000/).

## Deploying to Heroku

Expand All @@ -24,6 +24,7 @@ $ heroku create
$ git push heroku master
$ heroku open
```

or

[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
Expand All @@ -32,8 +33,8 @@ or

For more information about using Node.js on Heroku, see these Dev Center articles:

- [Getting Started with Node.js on Heroku](https://devcenter.heroku.com/articles/getting-started-with-nodejs)
- [Heroku Node.js Support](https://devcenter.heroku.com/articles/nodejs-support)
- [Node.js on Heroku](https://devcenter.heroku.com/categories/nodejs)
- [Best Practices for Node.js Development](https://devcenter.heroku.com/articles/node-best-practices)
- [Using WebSockets on Heroku with Node.js](https://devcenter.heroku.com/articles/node-websockets)
* [Getting Started with Node.js on Heroku](https://devcenter.heroku.com/articles/getting-started-with-nodejs)
* [Heroku Node.js Support](https://devcenter.heroku.com/articles/nodejs-support)
* [Node.js on Heroku](https://devcenter.heroku.com/categories/nodejs)
* [Best Practices for Node.js Development](https://devcenter.heroku.com/articles/node-best-practices)
* [Using WebSockets on Heroku with Node.js](https://devcenter.heroku.com/articles/node-websockets)
39 changes: 39 additions & 0 deletions ascii-art.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
console.log(`
██╗ ██╗ ██╗ ███╗ ██╗ ██████╗ ███████╗██╗ ███████╗ ██╗ ██╗ ██╗ ██████╗
██║ ██║ ██║ ████╗ ██║ ██╔══██╗ ██╔════╝██║ ██╔════╝ ██║ ██║ ██║ ██╔═══██╗
██║ █╗ ██║ ██║ ██╔██╗ ██║ ██║ ██║ █████╗ ██║ ███████╗ ███████║ ██║ ██║ ██║
██║███╗██║ ██║ ██║╚██╗██║ ██║ ██║ ██╔══╝ ██║ ╚════██║ ██╔══██║ ██║ ██║ ██║
╚███╔███╔╝ ██║ ██║ ╚████║ ██████╔╝ ██║ ██║ ███████║ ██║ ██║ ██╗ ██║ ╚██████╔╝
╚══╝╚══╝ ╚═╝ ╚═╝ ╚═══╝ ╚═════╝ ╚═╝ ╚═╝ ╚══════╝ ╚═╝ ╚═╝ ╚═╝ ╚═╝ ╚═════╝`)

console.log(`
██╗ ██╗ ██╗ ███╗ ██╗ ███████╗
██║ ██║ ██║ ████╗ ██║ ██╔═══██╗
██║ █╗ ██║ ██║ ██╔██╗ ██║ ██║ ██║
██║███╗██║ ██║ ██║╚██╗██║ ██║ ██║
╚███╔███╔╝ ██║ ██║ ╚████║ ███████╔╝
╚══╝╚══╝ ╚═╝ ╚═╝ ╚═══╝ ╚═════╝
█████████╗ ██╗ █████████╗ ██╗ ██╗
██╔══════╝ ██║ ██╔══════╝ ██║ ██║
██████╗ ██║ █████████╗ ████████║
██╔═══╝ ██║ ╚══════██║ ██╔═══██║
██║ ██║ █████████║ ██║ ██║
╚═╝ ╚═╝ ╚════════╝ ╚═╝ ╚═╝`)

console.log(`
██╗ ██╗ ██╗ ███╗ ██╗ ████████╗ ████████╗
██║ ██║ ██║ ████╗ ██║ ██╔════██╗ ██ ██╗
██║ █╗ ██║ ██║ ██╔██╗ ██║ ██║ ██║ ██ ██║
██║███╗██║ ██║ ██║╚██╗██║ ██║ ██║ ██ ██╗ ██║
╚███╔███╔╝ ██║ ██║ ╚████║ ████████╔╝ ██ ╚═╝ ██║
╚══╝╚══╝ ╚═╝ ╚═╝ ╚═══╝ ╚═══════╝ ██ ██╗ ██║
██ ╚═╝ ██║
Server v0.0.1 ██ ██╗ ██║
██ ╚═╝ ██╔═╝
█████████╗ ██╗ █████████╗ ██╗ ██╗ ██ ██╗ ██║
██╔══════╝ ██║ ██╔══════╝ ██║ ██║ ██ ╚═╝ ██╔═╝
██████╗ ██║ █████████╗ █████████║ ██ ██╔═╝
██╔═══╝ ██║ ╚══════██║ ██╔════██║ ╚████████████╗
██║ ██║ █████████║ ██║ ██║ ╚═══════██████╗
╚═╝ ╚═╝ ╚════════╝ ╚═╝ ╚═╝ ╚═════╝
`)
Loading

0 comments on commit 55cc7eb

Please sign in to comment.