A twitch-plays style program with extended functionality allowing for usage in almost anything
- Install node.js
- Download this as a zip file and extract it wherever
- Run the "install.bat" file
- That's it!
To start up the program, just run "start.bat". If you make any configuration changes, you have to restart the program.
There is no "kill switch"! Due to technical limitations, this program does not watch for keyboard input, which makes it pretty hard to implement a kill bind or something. I'm sure you can set AHK or something similar to kill it if you are worried. You shouldn't be worried as long as you don't give the twitch chat unnecessary power (alt-tab, alt-f4, etc.). The most that could happen is you may have to fight the mouse a little bit if you have it set to be used and the chat is trying to move it.
All of the base configuration is located in "config.json". In the configs folder you will find some basic key configuration files you can use (or edit using the reference below) by changing the use_config field to the name of the config file.
Feel free to create your own key configurations! If you made one that you think could be useful, feel free to make a pull request with it.
Set this as the name of the Twitch channel to watch the chat of.
"channel":"ClintStevens"Set this as the name of the config file (without the extension) to load that key config on startup
"use_config":"tester"If something isn't working, enable this to see what the problem could be. If you can't figure it out, feel free to make an issue
"debug":trueSet this value to true to allow for the chat to type "random" and have one of the predefined controls selected.
"enable_random":trueSet this value to true to enable the number keys. Useful for games that require them since you don't have to add them manually. Should override predefined number actions, so disable this if you have the number keys set to something else.
"enable_num":trueIf you want users to be able to send more than one command per message, you can limit the amount they can send by setting this value. If you do not set this value, it should automatically set to 1. If a user sends a combination larger than the allowed, then only the commands up to the limit are executed.
"max_combo":3You can probably tell by the examples, but these are formatted in key:value pairs.
The key will be the word that will trigger the key, and the value will be what key is pressed.
You can also string multiple keys together with +, to press them in rapidly and in order.
Examples:
"attack":"a"
// Will press "a" when someone sends "attack""doublejump":"space+space"
// Will press "space" twice when someone sends "doublejump""tabout":"alt-tab"
// Will alt-tab when someone sends "tabout"Works the exact same as keys, except you can apply a time for the key to be held, or for it to be toggled on/off, or for a user-chosen length of time.
Examples:
"forward":"up:2s"
// Will hold the up arrow for two seconds when someone sends "forward""alldirections":"w+a+s+d:50ms"
// Will press each key for 50ms when someone sends "alldirections""enableforward":"w:on"
// Holds w when someone sends "enableforward""disableforward":"w:off"
// Lets go of w when someone sends "disableforward""customhold":"h:any10s"
// Allows user to type "customhold [time]" to hold the button for a custom amount of time,
// eg. "customhold 2s" or "customhold 7s""pasteabunch":"ctrl-v:5s"
// Will paste for 5 seconds when someone sends "pasteabunch"Allows for the movement of the mouse. Uses x/y coordinate offsets, which means you aren't inputting a position, but where it should move from it's current position. You can also string movements together with +
Examples:
"aimup":"0px,200px"
// Moves the mouse 200px up from it's current position when someone sends "aimup""leftright":"-100px,0px+100px,0px"
// Moves the mouse left 100px then right 100px when someone sends "leftright"Clicks the mouse buttons (either left or right). Can be strung together with + as well
Examples:
"shoot":"left"
// Clicks the left mouse button once when someone sends "shoot""double":"left+left"
// Double clicks when someone sends "double"Basically the exact same as key holds. Allows for holding down a mouse button for an amount of time (or a toggle)
Examples:
"magdump":"left:5s"
// Will hold down left mouse button for 5 seconds when someone sends "magdump""enablelmb":"left:on"
// Toggles left mouse button when someone sends "enablelmb""disablelmb":"left:off"
// Disables left mouse button when someone sends "disablelmb""shootcustom":"left:any10s"
// Allows users to type a custom amount of time to hold a mouse click,
// eg. "shootcustom 7s" or "shootcustom 3s"Want to see something added? Put it in the issues section!
- Even more features
- Electron UI maybe?
- Update to https://github.com/nut-tree/nut.js