Skip to content
This repository has been archived by the owner on Sep 27, 2024. It is now read-only.

Commit

Permalink
Kick Support
Browse files Browse the repository at this point in the history
Update the downloader (and readme) to reference the new Kick plugin!
  • Loading branch information
doxy-ai committed Oct 28, 2023
1 parent c1324dd commit 82c49ce
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,24 @@ Currently I provide first party support for the following platforms
* Twitch: (plugin can be downloaded here: https://gist.github.com/doxy-ai/8fae7aeb8890f5bed3e2fa7843af9084)
* Youtube: (plugin: https://gist.github.com/doxy-ai/f567236fd6320e721cbd127b11ca7cb0)
* Vstream: (plugin: https://gist.github.com/doxy-ai/364d9804d97c8d37285e7b8671d274d4)
* Kick: (plugin: https://gist.github.com/doxy-ai/f605f31922051151dc044494d1d9af56)

There is also an example of a profanity filter and a pinger which will play a sound notification when you recieve a new message after a break in the `plugins/disabled` folder, moving them up into the `plugins` folder should enable them with no extra configuration necessary!

If you have made a plugin for another platform (or a better version of one of these platforms) feel free to open a pull request!

## Quick Start (Windows Only)

1) Download the latest version of Python 3.10 https://www.python.org/downloads/ (When installing it make sure to check the checkbox on the first page to add python to the path)
1) Download the latest version of Python 3.12 https://www.python.org/downloads/ (When installing it make sure to check the checkbox on the first page to add python to the path)
2) Download an installer from the latest release: https://github.com/doxy-ai/ZatsuDachi/releases
3) Run the installer selecting the platform plugins you would like to download
4) Sit back and relax as everything is done for you!
5) Run ZatsuDachi from the windows start menu (a terminal window and a GUI should appear)
6) (optional) A URL (something along the lines of http://127.0.0.1:8080) should have been printed in the terminal window shown by step 4. You can paste that URL into a web browser or an OBS browser source to view your chat!

## Quick Start (Other Platforms [Windows too if you're feeling fancy])
## Quick Start (Other Platforms [Windows too if you're feeling advanced])

1) Download the latest version of Python 3.10 https://www.python.org/downloads/ (When installing it make sure to check the checkbox on the first page to add python to the path)
1) Download the latest version of Python 3.12 https://www.python.org/downloads/ (When installing it make sure to check the checkbox on the first page to add python to the path)
2) Click the green "Code" button in the top right and select "Download as Zip"
3) Unzip ZatsuDachi somewhere and note where
4) Open a terminal (this can be done by opening the start window on windows and typing cmd)
Expand All @@ -51,6 +52,10 @@ Q) The app launches but disappears immediately!
A) This usually means that when you installed python you forgot to check the box on the first page to add it to the path... go ahead and try to install it again making sure to check that box!
![Example of where the Python Path box is.](https://github.com/doxy-ai/ZatsuDachi/blob/master/resources/pythonInstall.png)

Q) How do I combine multiple streams from the same platform.

A) One each plugin only supports a single stream... that means you would need to go into the plugin folder and duplicate the appropriate plugin for each additional stream you want to view.

## Setup

General setup guides can be found above!
Expand Down
7 changes: 5 additions & 2 deletions downloadPlugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ def install_package(package):
# Check if the correct number of arguments is provided
if len(sys.argv) != 2:
print("Usage: python downloadPlugin.py [option]")
print("Options: twitch, youtube, or vstream")
print("Options: twitch, youtube, vstream, or kick")
sys.exit(1)

# Retrieve the option from the command line argument
Expand All @@ -25,7 +25,8 @@ def install_package(package):
file_urls = {
"twitch": "https://gist.github.com/doxy-ai/8fae7aeb8890f5bed3e2fa7843af9084",
"youtube": "https://gist.github.com/doxy-ai/f567236fd6320e721cbd127b11ca7cb0",
"vstream": "https://gist.github.com/doxy-ai/364d9804d97c8d37285e7b8671d274d4"
"vstream": "https://gist.github.com/doxy-ai/364d9804d97c8d37285e7b8671d274d4",
"kick": "https://gist.github.com/doxy-ai/f605f31922051151dc044494d1d9af56"
}

# Scrape the latest version of the plugin from the link
Expand Down Expand Up @@ -60,6 +61,8 @@ def install_package(package):
case "vstream":
install_package("websocket-client")
install_package("cbor2")
case "kick":
install_package("tls_client")

except requests.exceptions.RequestException as e:
print(f"Error occurred while downloading the file: {e}")
Expand Down

0 comments on commit 82c49ce

Please sign in to comment.