A TwitchPlays API
Project description
Twitch Plays hackRU
twitch_plays_hackru is a Python library for twitch chatters to be able to vote on commands in a game.
Installation
pip3 install twitch_plays_hackru.
Usage
Importing the classes:
from twitch_plays_hackru import TwitchPlaysOnline, TwitchPlaysOffline
Initializing the TwitchPlaysOnline or TwitchPlaysOffline object:
twitch_options = {
"PASS": "oauth:YOUR_OATH_CODE_HERE",
"BOT": "TwitchPlaysBot",
"CHANNEL": "YOUR_CHANNEL_NAME_HERE",
"OWNER": "YOUR_CHANNEL_NAME_HERE",
"OPTIONS": ["1","2","3","hi","bye"],
"VOTE_INTERVAL": 5
}
tPlays = TwitchPlaysOnline(**twitch_options)
# or
tPlays = TwitchPlaysOnline(
PASS="oauth:YOUR_OATH_CODE_HERE",
BOT="TwitchPlaysBot",
CHANNEL="YOUR_CHANNEL_NAME_HERE",
OWNER="YOUR_CHANNEL_NAME_HERE",
OPTIONS=["1","2","3","hi","bye"],
VOTE_INTERVAL=5)
The object will take in 7 parameters:
only VOTE_INTERVAL and OPTIONS are needed for the offline version
SERVER: the server that the bot will be interacting with. In this case it will always be "irc.twitch.tv" (the default)
PORT: the port you would like use. defaults to 6667
PASS: the OAuth code for the twitch channel you would like this bot to listen on. Use twitchapp.com/tmi/ to generate the OAuth code for your twitch channel.
BOT: the nickname of the bot.
CHANNEL: the name of the channel you would like this bot to listen on.
OWNER: the username of the owner of the channel you would like this bot to listen on.
OPTIONS = []: an array of options that you would like the bot to keep track of.
VOTE_INTERVAL: how often you want to count up the votes. defaults to every 5 seconds
Chatters voting:
The initialization of the bot will also startup the bot. This means that the bot will send a "Hello World" message in the chat and then begin to listen to all of the chat responses.
Chatters will preface their vote option by using play_
. For example, a vote for hi from the code above must be typed play_hi. It is not case sensitive.
Functions:
vote_results():
result = tPlays.vote_results()
vote_results() returns the majority vote since the last count. if a count has not been completed it will return null the whole idea behind this library is that vote_results acts like pygame.key.get_pressed() which makes it easy to develop a game with
License
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
Hashes for twitch_plays_hackru-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c7eba54838d9aeea90d67393ad0f9ebd722f2bdd779bd39c91bb39a9a477531d |
|
MD5 | 303242945e58eb3aa7d79f2720d91877 |
|
BLAKE2b-256 | 2be83a931030ce21102b7467f41e3fc79def5b26005748bd55ea651a54bc59a1 |