taterubot-dc

command module
v0.0.0-...-b6b6a87 Latest Latest
Warning

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

Go to latest
Published: Nov 11, 2022 License: MIT Imports: 2 Imported by: 0

README

taterubot logo

Taterubot

Record audio messages and share them with your friends without leaving Discord! Whatsapp style


Taterubot is a Discord bot that allows recording voice messages and sending them on your server.

Language Build status License

Showcase

showcase

How to use it

  1. Enter on the chosen channel. The bot will enter automatically.
  2. Start speaking.
  3. When you are done, leave the channel.
  4. The bot will upload your voice message on the general channel.

Requirements

  • Discord application bot: create yours here.
  • ffmepg installed in the host machine. It is needed to convert and manipulate audio files.
  • Docker and docker-compose (only needed if running locally)

Run Taterubot on your own machine (minimal setup)

  • Rename .env.example to .env
  • Put your discord token on BOT_TOKEN env variable.
  • (Optionally) change LANGUAGE to 🇬🇧 or 🇪🇸
  • Run go mod download
  • Run make local-infra
  • Run go run main.go

Configuration settings (advanced setup)

You can modify the config.json file and adapt it to your needs.

  • CHANNEL_NAME: Name of the voice channel where you want your audios to get recorded.
  • BASE_PATH: Base path where the audio files are stored temporarily.
  • CLOUDAMQP_URL: Url that points to your AMQP broker.
  • DATABASE_URL: Url that points to your Postgres DB.

Guide: Deploy it in heroku for free

  1. Create a worker dyno in heroku.
  2. Add CloudAMPQ addon
  3. Add Heroku postgres
  4. Set correct config vars for the bot token, AMPQ, postgres...
  5. Add ffmepg buildpack. howto
  6. Deploy your code.

Known bugs and limitations

  • Cant really scale horizontally; There is an internal state using channels to manage the recording, cant handle the start and end of recording in different instances.
  • Not meant for unstable connections: if you are outside with the phone and trying to record an audio and you have low signal, you most likely will lose that audio.

Thanks to

WIP 👷

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

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