Go to file
KieranRobson a3f1282d32 Typos 2022-06-27 14:34:43 +01:00
.github/workflows Fix Action 2022-06-27 12:30:09 +01:00
SlashCommands Typos 2022-06-27 14:34:43 +01:00
commands 🔨 Added missing commands to help 2022-06-27 07:06:44 +01:00
events Added rotating status 2022-06-27 11:42:38 +01:00
handler Fixed Dupe Slash Commands 2022-06-27 11:59:30 +01:00
images Added gorblarge 2022-05-24 10:02:24 +01:00
.env.template ✏ Added .env.template for ease of manual install 2022-06-27 07:16:13 +01:00
.gitignore File cleanup 2022-06-12 11:21:25 +01:00
README.md Formatting 2022-06-27 11:46:19 +01:00
dockerfile Update dockerfile 2022-06-26 17:36:47 +01:00
index.js Refactor files and dependicies 2022-06-25 19:26:23 +01:00
package-lock.json Refactor files and dependicies 2022-06-25 19:26:23 +01:00
package.json Refactor files and dependicies 2022-06-25 19:26:23 +01:00

README.md

HullCSS Discord Bot

This bot is a multipurpose discord bot for The Hull Computer Science Society Discord server.

This bot features multiple command types from:

  • Admin
  • Embeds
  • Fun
  • General
  • Slash Commands

Alongside commands, this bot also features:

  • Auto threading in help channel to keep it clean
  • Auto embedding of events for information and archiving
  • Select menu role system
  • Rule agreement button embed

Installation

This is a private bot used for a specific purpose within a specific discord server however if you do want to run the bot for testing purposes or deploy it to a new location. Follow the instructions below.

🐋 Docker

Due to the Publish.yml workflow, the newest build will automatically be pushed to dockerhub.

docker run -d \
--name=hullcss \
-p 6001:6001 \
-e DISCORD_TOKEN='INSERT DISCORD TOKEN' \
-e PREFIX='!' \
--restart unless-stopped \
kieranr27/hullcss:latest

Using a tool like Ouroboros, you can automatically update containers without the need for restarts.

👷 Manual

  • Clone the repo
  • Remove the .template from .env.template
  • Add Discord Bot Token where DISCORD_TOKEN is within the .env file
  • Run npm i
  • Run node .

Contributions

While this bot is maintained by Kieran, contributors are welcome!

  • Contribution guidelines are coming soon.