https://github.com/evilfreelancer/socket-yrslf

Bot for Twitch <-> Discord chats messaging
https://github.com/evilfreelancer/socket-yrslf

api bot chat discord docker messaging socket twitch

Last synced: about 1 month ago
JSON representation

Bot for Twitch <-> Discord chats messaging

• Host: GitHub
• URL: https://github.com/evilfreelancer/socket-yrslf
• Owner: EvilFreelancer
• Created: 2018-12-12T22:07:47.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T07:51:43.000Z (about 2 years ago)
• Last Synced: 2024-10-29T20:07:58.413Z (3 months ago)
• Topics: api, bot, chat, discord, docker, messaging, socket, twitch
• Language: TypeScript
• Homepage: https://hub.docker.com/r/evilfreelancer/socket-yrslf/
• Size: 224 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Twitch <-> Discord messaging

Bot created for crossplatform messaging between Twitch and Discord

## Set the parameters

You need change settings inside `.env` file to what you need. Example

of this file (`.env.example`) you can find in same folder as project.

And if settings is correct you will see messages in chats after server started.

### Available environment variables

|Environment        |Default value |

|-------------------|--------------|

|DISCORD_TOKEN      |xxxx          |

|DISCORD_CHANNEL_ID |1234          |

|DISCORD_USER_ID    |123456        |

|DISCORD_HOOK_URL   |hook_url      |

|TWITCH_USERNAME    |MyBot         |

|TWITCH_CHANNEL     |#mychannel    |

|TWITCH_TOKEN       |oauth:xxxxxxx |

  How to obtain tokens, IDs, etc

#### TWITCH_TOKEN

You need [generate OAuth token](https://twitchapps.com/tmi/) for your Twitch account.

Please create separated twitch account for bot if you do not wanna lose your primary account.

#### TWITCH_CHANNEL

This is the part of your channel's URL, for example in `https://www.twitch.tv/evilfreelancer`

path `evilfreelancer` is channel name. 

#### TWITCH_USERNAME

Name of your Bot user, should be the same as you used for authorization on Twitch.

#### DISCORD_USER_ID

You need login to [Discord Developers](https://discordapp.com/developers/)

portal and create new application.

After you done need login the application to your Discord server.

#### DISCORD_TOKEN

From Bots page of Discord Developers portal you can find the token. 

`https://discordapp.com/developers/applications/{application_id}/bots`

#### DISCORD_CHANNEL_ID

Then you need enable debug mode of your Discord client, for this go to

your "User Settings", then to "Appearance" and on this page in "Advanced" block

will be a "Developer Mode", you need switch this to ON.

Then close the settings page and click MRB on any text chat room what you

want, then select "Copy ID" from list and ID and `DISCORD_CHANNEL_ID``

will saved to your clipboard. 

#### DISCORD_HOOK_URL

URL of Discord webhook, can be found on Webhooks tab of Discord server settings. 

## How to use via NPM

    npm install

    npm run server 

## How to use via Docker

    docker pull evilfreelancer/socket-yrslf

    docker run -e DISCORD_TOKEN=xxxx -e DISCORD_CHANNEL_ID=.... ..cuted.. -d evilfreelancer/socket-yrslf

## How to use via Docker Compose

    cp docker-compose.yml.dist docker-compose.yml

    docker-compose up -d

## Get Support!

* [Discord](https://discord.gg/KzHGXKp) - Here you can talk with author of this project directly

* [GitHub Issues](https://github.com/EvilFreelancer/socket-yrslf/issues) - Got issues? Please to me!