events | ||
modules | ||
.dockerignore | ||
.gitignore | ||
cmdsplit.js | ||
config.example.toml | ||
Dockerfile | ||
Dockerfile.base | ||
index.js | ||
LICENSE | ||
package.json | ||
Radio.js | ||
README.md | ||
RedditRadio.js | ||
Startup.js |
Radiobot
Radio Bot based on codecat/reddit-radio
Features
- Live radio re-streaming to voice channels (using multiple bot users), automatically turned on/off when someone joins/leaves the bound channel.
- Other cool things.
Modules
A module is a class in the modules
folder. It accepts the following methods:
constructor(config, client, bot)
whereconfig
is the object directly from the config file,client
is the Discord client, andbot
is theRedditRadio
object.onCmdXxxx(msg, ...)
whereXxxx
is a command name like.xxxx
.onTick()
is called every second.onMessage(msg)
is called whenever a message is sent in any channel. Returnfalse
if the message can pass through to other commands and handlers, ortrue
to stop that from happening.
(Optional) How to run using Docker
You can use Docker and a mounted volume to easily run Reddit Radio.
The Reddit Radio Docker image is publically available on Docker Hub and can be found here and are automatically built each time a change is made to the master branch.
How to run using built image
- Create a folder where you'd like to run the docker image
- Create a folder called
config
or similiar to keep your configuration in - Make a copy of
config.example.toml
calledconfig.toml
and place it in yourconfig
folder - Edit the config file
- Run the following command
docker run -d --name reddit-radio -v $(pwd)/config:/app/config codecatt/reddit-radio:latest
Running using Docker from the repo
- Clone this repo
git clone https://github.com/codecat/reddit-radio.git
- Build the Docker image
docker build . -t reddit-radio
- Create a folder called
config
or similiar to keep your configuration in - Make a copy of
config.example.toml
calledconfig.toml
and place it in yourconfig
folder - Edit the config file
- Run the following command
docker run -d --name reddit-radio -v $(pwd)/config:/app/config reddit-radio
Note: For development you could map your whole code directory as follows:
docker run -d --name reddit-radio -v $(pwd):/app reddit-radio