hullcss-discord-bot

Go to file

Kieran 93ea1b9313 Merge pull request #69 from hullcss/dependabot/npm_and_yarn/eslint-8.31.0		2023-01-03 18:34:05 +00:00
.github	build(deps): bump streetsidesoftware/cspell-action from 2.15.0 to 2.15.1	2023-01-03 11:48:15 +00:00
docs	chore: Run format	2022-12-05 22:44:54 +00:00
src	chore: Run ci	2022-12-05 22:39:03 +00:00
.cspell.json	fix: Add Changelog to spell ignore	2022-12-19 12:58:04 +00: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	chore: Run format	2022-12-05 22:44:54 +00:00
.gitignore	chore: Update ignore files	2022-09-21 19:01:50 +01:00
.prettierrc	chore: Run format	2022-12-05 22:44:54 +00:00
CHANGELOG.md	chore: Run format	2022-12-19 12:56:49 +00:00
LICENSE	Change License from Apache to MIT	2022-07-02 11:56:20 +01:00
README.md	chore: Run format	2022-12-05 22:44:54 +00:00
dockerfile	build(deps): bump node from 19.2.0 to 19.3.0	2022-12-15 07:11:14 +00:00
package.json	build(deps-dev): bump eslint from 8.30.0 to 8.31.0	2023-01-03 11:38:37 +00:00
release-please-config.json	chore: Run format	2022-12-13 11:18:08 +00:00
yarn.lock	build(deps-dev): bump eslint from 8.30.0 to 8.31.0	2023-01-03 11:38:37 +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.