witch Plays application for RetroArch/FBNeo, with input queue and chat control toggle shortcut.
Project description
twitchplays-retroarch
Twitch Plays application for RetroArch/FBNeo, with input queue and chat control toggle shortcut.
Commissioned by twitch.tv/LastTimeLord.
Made with twitchio and PyAutoGUI (PyDirectInput when on Windows).
Informed by controlmypc and DougDoug's Twitch Plays projects.
Features:
- Input queue - commands are processed with a queue system and always executed in the order they're sent.
- Hotkeys - add global hotkeys (will work when not focused on the program window) for pausing chat control. Powered by keyboard.
- Scalable - can use a thread pool to execute multiple inputs simultaneously.
- Customisable - change settings and commands in
config.toml
. - Bot commands - try
!help
- Automatically locate RetroArch's config file and use your controls settings to make command templates for this program.
Installation and Usage:
Download as an exe
If you want the easiest way to use this on Windows without knowing about or installing Python, you can go to the releases page on GitHub, select the latest one, and download the twitchplays-retroarch.exe
file from the Assets section.
You can then run it from where ever you downloaded it.
Install with pip from PyPI
This project is on PyPI: https://pypi.org/project/twitchplays-retroarch/
Just use pip install twitchplays-retroarch
.
After it's installed you can run it python -m twitchplays_retroarch
or just twitchplays-retroarch
.
You can also access its classes and functions with import twitchplays_retroarch.
Clone from GitHub
The usual:
git clone https://github.com/JMcB17/twitchplays-retroarch
cd twitchplays-retroarch
pip install -r requirements.txt
Then you can usepython -m twitchplays_retroarch
(from within this folder only).
General Usage
Run the program for the first time, and it will prompt you to allow it to automatically create a new template config.toml
file.
Open the file in a text editor. It's annotated with what each setting means.
The most important settings are at the start of the file under the [twitch]
header. You'll need to set them in order to run the bot successfully.
After that, you can read and edit the other settings if you want more customisation.
You can also run the program with the -h
command line flag for info.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file twitchplays-retroarch-0.7.0.tar.gz
.
File metadata
- Download URL: twitchplays-retroarch-0.7.0.tar.gz
- Upload date:
- Size: 23.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 98f7c2a6ca4bee88d33018aca6c0ab398e94777134f102926ab0c1b56054cbe5 |
|
MD5 | 5146397e37b6aa286cc585895f780ab8 |
|
BLAKE2b-256 | bd100116367737b6c6beb4b3996d1f171b548b08f643722115a66c54fcafe02c |
File details
Details for the file twitchplays_retroarch-0.7.0-py3-none-any.whl
.
File metadata
- Download URL: twitchplays_retroarch-0.7.0-py3-none-any.whl
- Upload date:
- Size: 23.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e22114a7e489422e892c18a7e559c3a6db047c67a993bec60cf7296826198ad |
|
MD5 | d9ef63cd575bd30b6637ee34950a3bc4 |
|
BLAKE2b-256 | 1fc8bdb01ee7e2e36548f224bf4a6d9692b187bc46480c33185e0701f1214e36 |