hullcss-discord-bot/README.md

60 lines
2.1 KiB
Markdown
Raw Normal View History

2022-07-01 18:38:19 +01:00
<div align="center">
2022-07-01 18:34:27 +01:00
2022-08-16 17:37:46 +01:00
<img src="https://user-images.githubusercontent.com/32241933/176943810-d3016868-d91b-49cc-9461-ae01b7ffa44d.png" width="150" height="150">
2022-07-01 18:33:56 +01:00
2022-07-01 18:46:51 +01:00
## HullCSS Discord Bot
2022-07-01 18:33:56 +01:00
This bot is a multipurpose discord bot for The Hull Computer Science Society Discord server.
2022-08-16 17:33:15 +01:00
<img src="https://img.shields.io/github/workflow/status/hullcss/hullcss-discord-bot/Publish%20Docker%20image?style=for-the-badge">
<img src="https://img.shields.io/badge/Discord.JS-13.10.2-blue?style=for-the-badge&logo=DISCORD" />
<img src="https://img.shields.io/badge/Node%20Version-16.16.0-brightgreen?style=for-the-badge&logo=Node.js">
<img src="https://img.shields.io/badge/License-MIT-brightgreen?style=for-the-badge">
2022-07-01 18:38:19 +01:00
</div align="center">
2022-05-11 12:44:44 +01:00
2022-07-01 18:46:51 +01:00
---
2022-05-11 12:44:44 +01:00
This bot features multiple command types from:
* Admin
* Embeds
* Fun
* General
2022-06-27 11:45:43 +01:00
* Slash Commands
Alongside commands, this bot also features:
2022-07-01 18:33:56 +01:00
* Auto threading in `#coursework-help` channel to keep it clean
2022-06-27 11:45:43 +01:00
* Auto embedding of events for information and archiving
2022-07-01 18:33:56 +01:00
* Select menu role system within `#roles`
* Rule agreement button embed with `#code-of-conduct`
2022-06-27 11:45:43 +01:00
2022-06-12 10:57:45 +01:00
---
## Installation
2022-06-12 11:09:58 +01:00
**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.**
2022-06-12 10:57:45 +01:00
2022-06-12 11:09:58 +01:00
### 🐋 Docker
2022-06-12 10:54:11 +01:00
Due to the [Publish.yml](.github/workflows/publish.yml) workflow, the newest build will automatically be pushed to dockerhub.
2022-06-12 11:09:58 +01:00
2022-06-12 10:54:11 +01:00
```docker
docker run -d \
--name=hullcss \
-p 6001:6001 \
-e DISCORD_TOKEN='INSERT DISCORD TOKEN' \
-e PREFIX='!' \
--restart unless-stopped \
2022-08-02 10:14:50 +01:00
kieranr27/hullcss:main
2022-06-12 10:54:11 +01:00
```
2022-06-12 10:57:45 +01:00
Using a tool like [Ouroboros](https://github.com/pyouroboros/ouroboros), you can automatically update containers without the need for restarts.
2022-06-12 11:09:58 +01:00
### 👷 Manual
- Clone the repo
- Remove the `.template` from `.env.template`
2022-08-16 17:47:39 +01:00
- Replace `INSERT DISCORD TOKEN` with your Discord token.
2022-09-04 18:16:02 +01:00
- Run `npm i` to install packages
2022-08-16 17:47:39 +01:00
- Run `node .` to run the bot
2022-06-12 11:09:58 +01:00
2022-06-12 10:57:45 +01:00
---
## Contributions
2022-05-11 12:44:44 +01:00
While this bot is maintained by [Kieran](https://github.com/KieranRobson), contributors are welcome!
2022-06-12 10:57:45 +01:00
- Contribution guidelines are coming soon.