Cuttlepus

A pluggable Twitch + PeerTube chat bot. Inspired by Firebot.

This project aims to create a chat bot with bridging Twitch and PeerTube stream in mind. It operates in a client-server model locally, and does not have a UI. You WILL need to use the terminal. Therefore, this program is not for the faint of heart. However, if you managed to plow through whatever I wrote, it should be extremely flexible.

In-Development Warning

Cuttlepus is extremely bare-bone right now. It only supports a limited amount of events and actions, but this will be expanded in the future.

Usage

You need Deno installed on your computer.

1. Clone this repository

git clone https://codeberg.org/NorthWestWind/cuttlepus.git

2. Change directory into it

cd cuttlepus

3. Run the server. Leave it running on a terminal

# Starts the server
deno run -A src/main.ts -d

4. Start another terminal and login to your accounts

# Without -d it's automatically client-side
deno run -A src/main.ts login twitch-streamer # Login to Twitch
deno run -A src/main.ts login peertube-streamer # Login to PeerTube

5. Make Cuttlepus start listening to chats

deno run -A src/main.ts start

Right now, the program should not be doing anything. You will want to import some addons to make it useful.

Chat Bridge

Cuttlepus supports chat bridge between Twitch and PeerTube. It runs automatically when authorizations for twitch-streamer, twitch-bridge and peertube-streamer are found. Simply log in to these accounts and it will start working.

deno run -A src/main.ts login twitch-bridge # Login to Twitch bridge account

There may be configuration in the future that allows this to work without the bridge account.

Overlay

Much like Firebot, Cuttlepus comes with an overlay that can be used as a browser source in OBS Studio. The overlay is served at this link:

http://localhost:3128/overlay

Currently, you can only play videos or show HTML code on it. You can manually trigger these actions by the following command:

deno run -A src/main.ts trigger play-video <src> <x> <y> [width] [height] [align] # Play a video on the overlay, align can be one of topLeft, topRight, bottomLeft, bottomRight
deno run -A src/main.ts trigger show-html <html> <x> <y> <align> <stayDur> [enterAnim] [leaveAnim] [stayAnim] [enterDur] [leaveDur] # Show HTML on the overlay

More actions will come in the future as I need them.

Chat Overlay

Cuttlepus also provides another overlay that bridges both Twitch and PeerTube chat in one. The overlay is served at this link:

http://localhost:3128/chat

Addons

To make Cuttlepus pluggable, it supports addons.
Check out the addons repository, which contains addons that I personally use.

Roadmap

• Hook up all EventSub events to custom events
  • This is doable. It's just annoying
• Add more actions for overlay

Icon

The icon is Sepia on top of Aria. Sepia is the mascot of PeerTube. It is a cuttlefish. Aria is an octoling I made up for my animations.