tripbot

module
v1.9.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 2, 2022 License: MIT

README

Tripbot loves you 🤖 ❤

GoDoc Go Report Card GitHub Super-Linter Version Build Status License

This is the source code to whereisdana.today, a 24/7 interactive slow-tv art project.

If you like it, please consider subscribing to my channel on Twitch.tv. Thanks for watching!

-Dana (dana.lol)

How it all works

There are two main components: the chatbot itself, which listens for user commands, and a VLC-based video server, which manages the currently-playing video. They can be run on separate computers.

The general flow of information looks like this:

A diagram showing the different components

For more detail, check out Tripbot, the Adventure Robot.

Running tripbot locally

You can use docker-compose to run tripbot on your own machine. It is configured to spin up all of the dependencies for the project. A helper script (bin/devenv) has been created to make the process a little easier. For example:

# (optional) create alias for devenv script
alias devenv="$(pwd)/bin/devenv"

# spin up tripbot stack on current machine
devenv up --daemon
# see running containers
devenv ps

# see logs for a specific container
devenv logs tripbot

# shut down everything
devenv down

Other Useful Docs

Infra

See infra/README.md for infra setup instructions.

Database

See db/README.md for database instructions.

Directories

Path Synopsis
cmd
pkg
database
TODO: this would be better as just 'db'
TODO: this would be better as just 'db'
script

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL