Skip to content

cottongin/splitkit-relay

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Splitkit relay

Simple IRC bot that relays messages from https://thesplitkit.com

splitkit-relay demo

Installation

Requirements:

splitkit-relay was built and tested with the following Python packages:

From your terminal, and in whichever directory you would like to save and run from:

git clone --depth 1 https://github.com/cottongin/splitkit-relay.git

Then copy, move, or rename the sample.env file to .env and open it in your preferred file editor, making sufficient changes to the default values

thesplitkit.com setup

Now head on over to thesplitkit and login to your account.

Once you've created an event click the share button share button Now click the Live Value Link button Live Value Link button Finally, copy the bare Live Value Link or copy button Live Value Link URL

You can either paste this URL into your .env file, or you can tell the bot to connect to it via IRC and the command ​`connect URL

Now run

python main.py

The bot should connect to IRC if you've configured everything in your .env file correctly and join whichever channel(s) you've defined.

If you provided the URL in your .env file the bot should immediately start listening to your splitkit event and emit at least one message if you've already started said event.

Otherwise, as previously mentioned, send the ​`connect command with your copied splitkit websocket URL.

Bot commands

Command Description Admin-only?
​`join #channel This tells the bot to /join #channel Yes
​`part This tells the bot to leave whatever you send it from Yes
​`connect URL This tells the bot to connect to the websocket URL provided Yes
​`disconnect This tells the bot to disconnect from the active websocket Yes
​`reload This tells the bot to reload its configuration (.env) Yes
​`np This emits the last message received from the websocket No
​`quit This tells the bot to shutdown and quit Yes

Troubleshooting

There is minimal error reporting. Most errors are just logged to stdout.


Special thanks to StevenB for creating and maintaining The Split Kit


Like what you see? Send me some sats ⚡️

Releases

No releases published

Packages

No packages published

Languages