README.md

MinehutUtils

Open-source community made discord bot for discord.gg/Minehut

Report Bug — Request Feature

Table Of Contents

• Introduction
• Getting Started
  • Installation
• Setup
  • Marketplace
  • Logs
• Environment Variables
• Contributing

Introduction

MinehutUtils is a community made discord bot for discord.gg/Minehut. It is made with Kotlin, JDA and Iron. For the full list of dependencies check out the dependency graph.

MinehutUtils is what's currently being used in the Minehut Official Discord and provides users with the functionality to view server information, network information, and advertise both their servers and services.

The following is a full list of commands that MinehutUtils provides:

Command	Description	Public
server	Displays information about a Minehut Server	✅
network	Displays information about the Minehut Network	✅
status	Calculates the status of core Minehut services	✅
marketplace	Either request or offer your services	✅
skript	Search for syntax from SkriptHub	✅
cooldown view	View server and your cooldown	✅
cooldown	Manage user's cooldowns	❌
settings	Change the bot settings or behaviour	❌

Getting Started

Installation

This guide assumes you've already made a Discord Bot and retrieved your bot token.

Docker

Running the bot with docker is the easiest way to get started and recommended for most users.

1. Pull the docker image from github packages

   docker pull ghcr.io/santiomc/minehututils:master

2. Run the docker image

   docker run -d --rm \
   -e TOKEN=<your bot token> \
   ghcr.io/santiomc/minehututils:master

Note: Since the bot uses a database to store cooldowns and settings, you'll need to mount a volume to store the database. You can do this by adding a mount for /data to the docker container.

Docker Compose

If you want to run the bot with docker-compose, you can use the predefined docker-compose.yml file (or create your own).

1. Download the docker-compose.yml file

   curl -O https://raw.githubusercontent.com/SantioMC/MinehutUtils/master/docker-compose.yml

2. Create a .env and attach your bot token.

   TOKEN=your bot token

3. Run the docker-compose.yml file

   docker compose up -d

Manual Installation

If you want to run the bot without a container, you can do so by following these steps:

1. Clone the repository

   git clone https://github.com/SantioMC/MinehutUtils

2. Build the project

   ./gradlew shadowJar

3. Run the jar file

   java -jar build/libs/MinehutUtils-<version>.jar

Setup

Marketplace

The bot by default should now have most things working, however a bit of configuration is needed to get both the marketplace setup. You can use the settings command to configure how the marketplace works. Start with using /settings channel marketplace channel: to configure which channel marketplace postings are sent to. You can then use /settings cooldown marketplace cooldown: to configure the cooldown for the marketplace command. The cooldown is applied per listing kind per user.

Logs

The bot no longer uses environment variables to configure the log channel, instead you can use the /settings log channel: command to configure the log channel. This allows for per-guild log channels.

SkriptHub Documentation

To configure the SkriptHub documentation command, you must set the SKRIPTHUB_KEY environment variable to your SkriptHub API key. You can make a free API key at SkriptHub, the bot will attempt to reduce the amount of requests made heavily to reduce rate limits and slow performing requests. Some requests will take multiple seconds to complete and therefore these results are cached for a long period of time.

If no SkriptHub key is provided, the command will return an error to the user mentioning that it is not yet configured.

Environment Variables

Below are a list of all possible environment variables that can be set to configure the bot.

Variable	Description	Default
DB_FILE	Where the sqlite file is located	data/minehut.db
SKRIPTHUB_KEY	The token to use from SkriptHub
TOKEN	The bot token

Contributing

Thanks for everyone who has already contributed, and anyone willing to. This is a community bot and your contributions are what makes it great. If you aren't able to make a pull request, you can always open an issue with a bug report or feature request here on github

Creating a pull request

1. Fork the repository
2. Clone your fork

   git clone https://github.com/YOUR_USERNAME/MinehutUtils

3. Create the changes you want to make
4. Commit and push your changes

   git add .
   git commit -m "Your commit message"
   git push

5. Create a pull request at https://github.com/SantioMC/MinehutUtils/pulls