hullcss-discord-bot

Go to file

Kieran 678ff02b4d Merge branch 'main' of https://github.com/hullcss/hullcss-discord-bot		2022-10-19 19:10:04 +01:00
.github	Merge pull request #20 from hullcss/dependabot/github_actions/docker/login-action-2.1.0	2022-10-17 09:31:59 +01:00
docs	docs: Wrote up Terms of Services	2022-09-21 19:16:17 +01:00
src	fix: Update role id and add disclaimer	2022-10-19 19:10:03 +01:00
.cspell.json	style: Alphabetise .cspell	2022-09-21 19:37:50 +01:00
.dockerignore	chore: Update ignore files	2022-09-21 19:01:50 +01:00
.env.template	Fix env template	2022-08-27 21:30:50 +01:00
.eslintrc.json	style: Eslint changes to get rid of errors	2022-09-21 19:06:13 +01:00
.gitignore	chore: Update ignore files	2022-09-21 19:01:50 +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	add license header and tldr link	2022-10-12 16:34:22 +01:00
dockerfile	build(deps): bump node from 18.11.0 to 19.0.0	2022-10-19 08:15:50 +00:00
package-lock.json	build(deps): bump discord-api-types from 0.37.12 to 0.37.14	2022-10-17 07:46:59 +00:00
package.json	build(deps): bump discord-api-types from 0.37.12 to 0.37.14	2022-10-17 07:46:59 +00: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.

License

hullcss-discord-bot is licensed under the MIT License. The full license text is included in the LICENSE file in this repository. Tldr legal have a great summary of the license if you're interested.