https://github.com/richardscull/yoshina-yt
Twitch song request via custom reward's bot for web player with support of YouTube and Spotify!
https://github.com/richardscull/yoshina-yt
awards song-requests spotify twitch-bot twith web-player websockets youtube
Last synced: about 1 month ago
JSON representation
Twitch song request via custom reward's bot for web player with support of YouTube and Spotify!
- Host: GitHub
- URL: https://github.com/richardscull/yoshina-yt
- Owner: richardscull
- License: mit
- Created: 2024-06-18T07:56:56.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-13T09:53:26.000Z (over 1 year ago)
- Last Synced: 2026-03-28T02:39:47.142Z (2 months ago)
- Topics: awards, song-requests, spotify, twitch-bot, twith, web-player, websockets, youtube
- Language: TypeScript
- Homepage:
- Size: 570 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: .github/README.md
- License: LICENSE
Awesome Lists containing this project
README
# yoshina-yt 🍃
#### Twitch song request via custom reward's bot for web player with support of YouTube and Spotify!
# Introduction 📕
It is _a massive_ rewrite of original forked project [yoshina](https://github.com/shysecre/yoshina), which supported only Spotify tracks and played them via Spotify desktop app.
This version supports both YouTube and Spotify tracks and plays them via web player. (Hosted on your local machine)
It also has `/widget` endpoint that you can use to display the current song on your stream.
# Description 📝
Simply putting, it's a bot that listens to twitch chat and reacts to custom rewards.
When someone redeems the reward, it will add the track to the player queue.
Player will play tracks in order they were added.
You as streamer can skip tracks, pause, resume, stop player from browser
Users can use `!current` command in chat to see current track.
# Installation & Setup 🛠️
## Requirements
- Git - [Download](https://git-scm.com/downloads)
- Node v22 or higher. - [Download](https://nodejs.org/en/download/)
- Spotify and Twitch developer accounts. (Don't worry, it's free and easy to create)
## Steps
1. Clone repo using `git clone https://github.com/richardscull/yoshina-yt` in terminal.
2. Create `.env` file in root folder and fill it according to example file `.env.example`.
- For twitch client & secret thing, visit: [dashboard](https://dev.twitch.tv/console/apps) and create new application.
- Full name, OAuth Redirect URLs (http://localhost:8000/twitch-auth), Category (Chat Bot). Copy client ID and secret to `.env` file.
- For Spotify client & secret thing, visit: [dashboard](https://developer.spotify.com/dashboard) and create new application.
- Full name, Description, Redirect URIs (http://localhost:8000/spotify-auth). Copy client ID and secret to `.env` file.
3. Run `Start.bat` or `Start.sh` file depending on your OS to install dependencies and start the server.
4. Follow the instructions in the terminal to authenticate with Spotify and Twitch.
5. Open browser and go to `http://localhost:8000` to see player interface.
# Special Thanks ❤️
- [shysecre - For original project and the idea](https://github.com/shysecre)
