Skip to content

Latest commit

 

History

History
145 lines (117 loc) · 4.25 KB

README.md

File metadata and controls

145 lines (117 loc) · 4.25 KB
Raw

Owncast chat bot overlay

What is this?

This is an OBS browser source overlay that checks each chat message for chat commands like: !fart, !wow, !dance. You configure each chat command using the commands.json file. Supports playback of video files, audio clips, images...

Future development can be tracked here: https://github.com/teklynk/owncast_chat_bot/projects/1

comands.json. Add your own custom !action commands and other bot responses.

config.json Contains your OwnCast Access Token and OwnCast server domain url.

Generate an Access Token from your Owncast Admin page > Integrations > Access Token. Create Access Token. Choose the middle option "Can send chat messages on behalf of the owner of this token." The name of your accesstoken will also be used as the chat name. So, you may want to name it something like: "mybot" or "chatbot"

Install and Run

Run this bot from your owncast instance. (recommended method)

On your owncast server create a public directory: owncast/data/public and place the owncast_bot folder and all its files inside like so: owncast/data/public/owncast_bot/.

The browser source url will then be: https://YOUR.OWNCAST.SERVER/public/owncast_bot/bot.html

Run this bot locally

  • Clone or download this repo.
  • npm install
  • npm run server
  • JSON files
    • Rename sample.comands.json to commands.json
    • Rename sample.config.json to config.json
    • Add your domain and access token to config.json
  • Add http://localhost:8000/bot.html as a browser source in OBS with a size of 1920x1080 and a Refresh Rate of 60.
  • Add media files (images, videos, sounds) to the media directory.

If having CORS errors/issues.

Add this to your owncast web server config:

NGINX

add_header Access-Control-Allow-Headers "*" always;

APACHE

Access-Control-Allow-Origin:*

Send a test message

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer YOURAUTHTOKEN" -d '{"body": "I am a system message!"}' http://YOUR.OWNCAST.SERVER/api/integrations/chat/send

Example comands.json file with {username} variable

[
    {
        "command": "!alert",
        "image": "",
        "audio": "",
        "video": "",
        "message": "",
        "say": "",
        "timelimit": "5000",
    	"cooldown": "90000"
    },
    {
        "command": "!hello",
        "image": "",
        "audio": "",
        "video": "",
        "message": "Hello {username}. Welcome in.",
        "say": "",
        "timelimit": "8000",
    	"cooldown": "90000"
    },
    {
        "command": "!fart",
        "image": "",
        "audio": "fart1.mp3",
        "video": "",
        "message": "{username} just farted!",
        "say": "ewww",
        "timelimit": "3000",
    	"cooldown": "90000"
    },
    {
        "command": "!dance",
        "image": "",
        "audio": "",
        "video": "safetydance.webm",
        "message": "DANCE!",
        "say": "",
        "timelimit": "60000",
    	"cooldown": "90000"
    },
    {
        "command": "!socials",
        "image": "",
        "audio": "",
        "video": "",
        "message": "",
        "say": "Here are my social media links: https://discord.com, https://mastodon.social",
        "timelimit": "3000",
    	"cooldown": "90000"
    }
]
  • "command": Your alert command.
  • "image": Show image in the overlay
  • "audio": Plays an audio file
  • "video": Plays a video file
  • "message": Displays a message in the overlay. Can include {username}.
  • "say": Says a message in chat. Can include {username}.
  • "timelimit": (miliseconds) How long the alert runs
  • "cooldown": (miliseconds) How long to wait before the alert can be used again.

Media Support

Place all media (images, sounds, videos) inside the media folder/directory

  • Video : webm, ogg, mp4
  • Audio : mp3, ogg
  • Images : gif, png, jpg, webp

Style Sheet

assets/css/alerts.css

Each command is set as a class name on the alertItem div so that you can add custom css for each alert if needed.

<style>
    .alertItem.hello p.message {
        text-shadow: 2px 2px #990000;
        font-size: 60px;
    }
</style>
<div class='alertItem hello eXyz1Oy9'></div>