ctome
/
hullcss-discord-bot
mirror of https://github.com/CrimsonTome/hullcss-discord-bot.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
212 Commits
2 Branches
0 Tags
25 MiB
JavaScript 100%
 
Go to file
Kieran 49239fae01 ESLint and spelling 2022-09-10 09:32:54 +01:00
.github/workflows RM Latest Tag 2022-06-27 12:31:35 +01:00
docs Add tos and priv policy 2022-08-16 20:35:34 +01:00
src ESLint and spelling 2022-09-10 09:32:54 +01:00
.dockerignore Added .dockerignore 2022-09-01 21:45:53 +01:00
.env.template Fix env template 2022-08-27 21:30:50 +01:00
.eslintrc.json ESLint and spelling 2022-09-10 09:32:54 +01:00
.gitignore File cleanup 2022-06-12 11:21:25 +01:00
.prettierrc ESLint and spelling 2022-09-10 09:32:54 +01:00
LICENSE Change License from Apache to MIT 2022-07-02 11:56:20 +01:00
README.md Typo 2022-09-04 18:16:02 +01:00
cspell.json ESLint and spelling 2022-09-10 09:32:54 +01:00
dockerfile Move to src folder 2022-09-09 22:07:00 +01:00
package-lock.json ESLint and spelling 2022-09-10 09:32:54 +01:00
package.json ESLint and spelling 2022-09-10 09:32:54 +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 #coursework-help channel to keep it clean
  • Auto embedding of events for information and archiving
  • Select menu role system within #roles
  • Rule agreement button embed with #code-of-conduct

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:main

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
  • Replace INSERT DISCORD TOKEN with your Discord token.
  • Run npm i to install packages
  • Run node . to run the bot

Contributions

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

  • Contribution guidelines are coming soon.