purrplingcat/purrplingbot repository overview

⁠PurrplingBot

A customizable discordbot written primary for server PurrplingCat

This project is under development!

⁠Main features

• Extensible and customizable via plugins (plugins can be enabled or disabled optionally)
• Chat bridge betwen Discord and Twitch chat
• Twitch stream checker (Automatically check when you are streaming, or check it via !livenow)
• Announcer (send a message in intervals, announcer can be handled when channel is active. Setup announce via !announce)
• Own cron sheduler for bot actions (send message, change avatar) - You can write your own cron handler
• Funny functions: Give a snack for bot, bot mumbling, cat nature - Yes this bot is cat!
• Itegrates Urbandictionary !urban, Giphy !giphy
• Wordcounter with score table (commands !words, !messages, !fame)
• Create a polls via !poll
• Aliases support - Create your command alias via !alias
• Bot greetings newbies
• Built-in commands: !alias, !alias_remove, !uptime, !version
• and more ...

⁠Features for admins and developers

• Based on Discord.js (version 11.2)
• Event logging to a secret discord channel (Yo can define it in config)
• Event bus - Emit&Handle bot's events
• Easy but sophisticated API for plugin development (WIP)
• Data storage
• Advanced configuration (YAML, file inclusion, config merge (WIP))
• Writing own commands in plugins
• User permissons and roles (ACL)
• Docker ready
• Supported architectures: x86_64, arm64

⁠Get PurrplingBot

⁠Regular download

• Latest stable version 1.3.4: Release v1.3.4 'Carmilla'⁠
• Release candidate version 1.4.0: Release v1.4.0-rc 'Carmilla'⁠
• Develop version: git clone https://github.com/EllenFawkes/PurrplingBot.git

⁠Get image from DockerHub

# x86/x64 images
docker pull purrplingcat/purrplingbot:1.3.4 # Latest stable version 1.3.4 'Carmilla'
docker pull purrplingcat/purrplingbot:latest # Latest development version

# arm64 images
docker pull purrplingcat/purrplingbot-arm64:latest # Latest development version

NOTE: Arm64 images is not always up2date.

Docker Setup/Migrate guide⁠

⁠Install & Run

⁠Install stable (standalone)

1. Rename config/config.example.json to config/config.json mv config/config.example.json config/config.json
2. Edit config/config.json and put your configuration (credentials, prefix, etc)
3. Install NPM dependencies npm install --production
4. Run PurrplingBot npm start or node purrplingbot.js

⁠Install dev

Requires cloned latest master branch

1. Rename config/config.example.json to config/config.json mv config/config.example.yaml config/config.yaml
2. Edit config/config.json and put your configuration (credentials, prefix, etc)
3. Install NPM dependencies npm install
4. Install NPM dependencies for plugins npm depmod
5. Run PurrplingBot npm start or node purrplingbot.js

NOTE: If you run bot via node purrplingbot.js you hasn't availaible autoreload after config was changed!

⁠Run tests (dev)

If you want run tests, then run npm test. It requires installed devDependencies (only for developers)

⁠Docker, Kubelet (x86/x64, arm64)

⁠Docker Quickstart

Docker Setup/Migrate guide⁠

⁠Pull image from DockerHub

docker pull purrplingcat/purrplingbot:<version>
docker run -ti purrplingcat/purrplingbot:<version>

⁠Run via kubelet/static POD for Kubernetes

1. Download extras/purrplingbot-kubernetes.yaml
2. Replace __VERSION__ with desired version
3. Replace __CONFIG_PATH__ with path to configs
4. Replace __LOG_PATH__ with path to logs
5. Deploy to Kubernetes by normal means

⁠Build your own x86/x64 image

1. Create a config file mv config/config.example.json config/config.json
2. Configure your bot vim config/config.json
3. Build your Docker image docker build -t <yourname>/purrplingbot .
4. Run your container docker run -ti <yourname>/purrplingbot

⁠Build your own ARM64 image

1. Same as previous, however you need to docker build --build-arg baseimage=arm64v8/node:8.5.0-slim -t <yourname>/purrlingbot-arm64 . or whichever is relevant for your architecture.

NOTE: At --build-arg you can place your own base image for different architectures or own baseimage. This is not officially supported!

⁠Maintenance

⁠Bug reporting

If you find a bug, then report an issue on my github. REMEBER: PurrplingBot is in BETA!