StuxVT / ScryptTunes

Music bot with a GUI (gui-wrapper for TwitchTunes with some bugfixes/changes)
GNU General Public License v3.0
2 stars 2 forks source link

Instructions broken oopsies, will fix soon, contact me if you need help setting up

ScryptTunes

Welcome to ScryptTunes! This application allows you to control your Spotify playlist through Twitch chat commands. This guide will walk you through the installation and setup process, step-by-step.

Dev Announcements:

Table of Contents

  1. Install
  2. Setup
  3. Usage

    Install

  4. Go to the latest release page here: ScrypTunes Latest Release
  5. Download ScryptTunesInstaller.exe and run it
  6. ScryptTunes will now show up in your start menu and as a desktop shortcut

Setup

1. General

  1. Open ScryptTunes and click the "Settings" button.
  2. Fill in the following fields:
    • Nickname: Name of bot account.
      • If you don't use a separate twitch account for your bot, just put your channel name here.
    • (Optional) Prefix: Enter the command indicator for Twitch chat (e.g., !).
    • Channel: Channel to listen for commands from. (Very likely to be your twitch channel name)
    • Token: Get your Twitch OAuth token from Twitch Chat OAuth Password Generator.
      • This is a safe resource that generates the token locally on the browser. Don't share it with anyone.

2. Setting Up Spotify

  1. Visit the Spotify Developer Dashboard.
  2. Click "Create an App" and fill in the necessary details.

  1. Once the app is created, click settings.

  1. You'll see a "Client ID" and "Client Secret". Enter these in the Settings view of ScryptTunes.

3. Setting Up Twitch

  1. Visit the Twitch Developer Console.
  2. Click "Applications" >> "Register Your Application" and fill in the necessary details.

  1. Click on "Manage" for your app

  1. You'll see a "Client ID" and "Client Secret". Enter these in the Settings view as well.

4. App Settings

${\color{red}BE \space SURE \space TO \space CLICK \space SAVE}$

Once finished, your app settings should look like this:

Usage

  1. Start playing music on Spotify
  2. Click "Start" on the main page to start the bot
  3. If you need help with commands see the Commands Guide

Credits

🎶 TwitchTunes


Dev Notes

You can just run main.py, or build locally if necessary. Feel free to ask questions in DMs on my Twitter or Discord but please google first.

Build Locally

python -m nuitka --standalone --enable-plugin=tk-inter --include-data-file=icon.ico=icon.ico --output-dir="build" --output-filename="ScryptTunes.exe" .\main.py

Create Installer

makensis installer.nsi