Giter Club home page Giter Club logo

discord-obs-overlay's Introduction

Discord / OBS Chat Overlay

Bringing a channel's messages into a nice looking chat overlay for OBS browser capture!

Concept

Basically, OBS can accept any URL as a browser source, including localhost addresses. I'm taking advantage of this by running two Node.js instances: 1 for a Discord bot to watch for new messages and post them to the chat server, and another instance as a chat server to receive new messages and update the DOM.

The basic flow of information is: New Message Event > Discord bot > HTTP POST > server > socket > client-side javascript.

Running the Overlay

After cloning this repo, create a file named .env, and insert the following:

TOKEN=<YOUR_SECRET_GOES_HERE>
WATCH_CHANNEL=<YOUR_CHANNEL_GOES_HERE>

To get the token, you'll need to create a Discord bot with the Read Messages permission. You can follow just Step 1 here: How To Build a Discord Bot with Node.js

The channel value can be retrieved by enabling Discord developer mode, then right-clicking the channel you'd like to watch and clicking "Copy ID".

Finally, you'll want to do:

npm install

Open two terminal instances. In one, run:

node client.js

Expect to see a message like listening on *:8080 You can now view the client by visiting http://localhost:8080. USE THIS URL AS YOUR BROWSER SOURCE in OBS.

And in the other terminal, run:

node bot.js

Expect to see a message like Logged in as <BOTNAME>#0000! With the bot watching your channel for new messages, AND the client running on http://localhost:8080, you should be all set up and good to go!

discord-obs-overlay's People

Contributors

fletchmakes avatar

Stargazers

 avatar Sachi avatar Asher Gomez avatar

Watchers

 avatar

Forkers

salayna

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.