Skip to content

Latest commit

 

History

History
78 lines (60 loc) · 3.72 KB

README.md

File metadata and controls

78 lines (60 loc) · 3.72 KB
Raw

Discord Push Notification OBS Tool

Preview OBS Widget Preview Discord Message

Introduction

This project is a simple Sveltekit webapp designed to integrate Discord push notifications with OBS (Open Broadcaster Software). It aims to enhance live streaming experiences by seamlessly displaying Discord notifications.

Features

  • Manual Discord notifications right from OBS
  • Easy integration with existing OBS setups
  • Customizable notification display

QUICK GUIDE

Add this Custom Browser Dock in OBS Vercel Deploy.

Setting Up a Discord Bot, Enabling Developer Mode, and adding the OBS dock

1. Creating a Discord Bot

  1. Go to the Discord Developer Portal.
  2. Create a new application and give it a name.
  3. Go to the "Bot" tab and click "Add Bot".
  4. Customize your bot (name, profile picture).
  5. Copy the bot token (keep this secure).

2. Inviting Your Bot to a Server

After setting up your bot on Discord, you'll need to invite it to the server where you want to send notifications:

  1. Replace {YOUR BOT ID HERE} in the following URL with your actual bot's client ID:
    https://discord.com/oauth2/authorize?client_id={YOUR BOT ID HERE}&permissions=2048&scope=bot
  2. Paste the modified URL into your web browser and hit enter.
  3. Select the server you want to invite the bot to from the dropdown menu.
  4. Click the 'Authorize' button to add the bot to your server.

Ensure that you have the 'Manage Server' permissions on the Discord server you want to invite the bot to.

3. Enabling Developer Mode in Discord

  1. Open Discord settings.
  2. Navigate to 'Advanced' settings.
  3. Toggle 'Developer Mode' to enabled.

4. Getting Channel IDs

  1. Right-click on the text channel in Discord with Developer Mode enabled.
  2. Click 'Copy ID' to get the channel's unique identifier.

5. Configuring the Bot in Your Project

  • Use the bot token and channel IDs in your project configuration as needed in the settings panel of the widget

Using the Deployed Frontend in Your OBS Project

6. Adding as a Custom Browser Source

  1. Open OBS (Open Broadcaster Software).
  2. Navigate to the scene where you want to display Discord notifications.
  3. Click on the 'Docks' > 'Custom Browser Docks...' menu option.
  4. Create a new source. Give it a name.
  5. In the 'URL' field, enter the following URL: Vercel Deploy.
  6. Click 'OK' to add the browser source.
  7. Click on the gear icon in the dock panel titled to open the settings.
  8. Fill in the 'Bot Secret' field with your Discord bot's token.
  9. Enter the desired 'Text Channel ID' where you want the notifications to appear.
  10. Type your notification 'Message' which might include custom text or commands like @everyone.
  11. Include a 'Twitch URL' if you want to send a link with your notifications.
  12. Click 'Save' to store your settings.

!! DISCLAIMER !! your bot secret is only stored locally!

Privacy Notice

⚠️ Important: All information entered in the Discord Push Notification OBS Tool is stored locally on your device and is not stored externally. It's your responsibility to keep your bot secret secure, as they can be used to access and control your Discord bot.

Preview Settings Blank Preview Settings Filled

Contributing

Contributions to enhance or expand the functionality of this project are welcome. Please follow the standard fork-pull request workflow.

License

This project is licensed under the MIT License.

Acknowledgements