https://github.com/carriejv/cyborg

A CyTube bot for Discord.
https://github.com/carriejv/cyborg

bot chatbot cytube discord sync youtube

Last synced: about 2 months ago
JSON representation

A CyTube bot for Discord.

• Host: GitHub
• URL: https://github.com/carriejv/cyborg
• Owner: carriejv
• License: mit
• Created: 2019-02-10T02:30:06.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-19T00:32:24.000Z (over 1 year ago)
• Last Synced: 2024-11-22T13:47:49.169Z (2 months ago)
• Topics: bot, chatbot, cytube, discord, sync, youtube
• Language: JavaScript
• Size: 546 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# CyBorg

[![npm version](https://img.shields.io/npm/v/cyborg-bot.svg)](https://www.npmjs.com/package/cyborg-bot)

[![npm license](https://img.shields.io/npm/l/cyborg-bot.svg)](https://www.npmjs.com/package/cyborg-bot)

[![dependencies](https://img.shields.io/david/carriejv/cyborg.svg)](https://david-dm.org/carriejv/cyborg)

[![devDependencies](https://img.shields.io/david/dev/carriejv/cyborg.svg)](https://david-dm.org/carriejv/cyborg#info=devDependencies)

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/carriejv)

CyBorg is a [Discord](https://discordapp.com) bot for [CyTube](https://cytu.be) 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](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 ` to get info about a CyTube channel.

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

Admins can also set a custom command prefix with `!cy 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](https://nodejs.org/en/) `>=10`.

Register your own Discord app [here](https://nodejs.org/en/) 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.