Skip to content

carriejv/CyBorg

Repository files navigation

CyBorg

npm version npm license dependencies devDependencies

Donate

CyBorg is a Discord bot for CyTube channels.

It is still early in development, so many features are messy and incomplete. You have been warned.

Add CyBorg to your Discord server!

To invite the bot to your server, click this link: https://discordapp.com/api/oauth2/authorize?client_id=422496569489752064&permissions=199680&scope=bot

Once the bot is in your server, you can use !cy cytube <cytube channel> to get info about a CyTube channel.

The server owner (and other users promoted with !cy admin <user mention>) can also use !cy announce <cytube channel> to create automatic announcements for a channel and !cy channel <channel mention> to set the Discord channel they appear in.

Admins can also set a custom command prefix with !cy prefix <prefix>.

Other commands include:

!cy help
!cy info
!cy booyah
!cy chuck

Host your own copy!

With Docker

Build your own Docker image with docker build . -t cyborg.

Deploy with docker run -v $PWD/secret:/cyborg/secret -v $PWD/config:/cyborg/config cyborg.

Optionally, keep the container running with --restart=always.

The secret and config volume must be mounted to run. The secret directory should contain a discord.json as described below. The config directory may optionally contain a global.json file, but will also be used to store autogenerated server-specific config files.

With Node

If you prefer to locally host your own copy of CyBorg, you can do that too. CyBorg requires Node.js >=10.

Register your own Discord app here and fill the appropriate information into ./secrets/discord.json. An example file is provided.

Then, install dependencies with npm i and use npm start to start the bot. The bot will print your invite link to the console.