Go to file

Kieran 2be15aa0f9 Update dockerfile		2022-06-26 17:36:47 +01:00
.github/workflows	Refactor files and dependicies	2022-06-25 19:26:23 +01:00
SlashCommands	Added links slash command	2022-05-13 10:58:21 +01:00
commands	Refactor files and dependicies	2022-06-25 19:26:23 +01:00
events	Refactor files and dependicies	2022-06-25 19:26:23 +01:00
handler	Update ids	2022-06-08 13:55:38 +01:00
images	Added gorblarge	2022-05-24 10:02:24 +01:00
.gitignore	File cleanup	2022-06-12 11:21:25 +01:00
README.md	File cleanup	2022-06-12 11:21:25 +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

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
Create a .env file with the following lines:

DISCORD_TOKEN = <Discord Token>
PREFIX = !

Run npm i
Run node .

Contributions

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

Contribution guidelines are coming soon.