HullRS Discord Bot

This bot is a multipurpose discord bot for The Hull Robotics Society Discord server.

---

This bot features multiple command types from:

• Admin
• Embeds
• Fun
• General
• Slash Commands

---

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=hullrs \
-p 6003:6003 \
-e DISCORD_TOKEN='INSERT DISCORD TOKEN' \
-e PREFIX='$' \
--restart unless-stopped \
kieranr27/hurs: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

hullrs-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.