MinehutUtils

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

Report Bug — Request Feature

Table Of Contents

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

Introduction

MinehutUtils is a community made discord bot for discord.gg/Minehut. It is made with Kotlin, JDA and Coffee. 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	✅
advertise	Advertises a Minehut server	✅
marketplace	Either request or offer your services	✅
cooldown info	View server and your cooldown	✅
cooldown	Manage user's cooldowns	❌

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 /app 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

The bot by default should now have most things working, however a bit of configuration is needed to get both the marketplace and advertisement commands setup. By default, if the environment variables are not setup for MARKET_CHANNEL or ADVERT_CHANNEL their respective commands won't work and will be disabled.

Marketplace

To get the marketplace working, you should first create a channel for it if you haven't already. Once you have a channel created, set MARKET_CHANNEL to the ID of the channel.

After that, users should be able to post both offers and requests in the channel.

Advertise

To get advertisements working, you should first create a channel for it if you haven't already. Once you have a channel created, set ADVERT_CHANNEL to the ID of the channel.

After that, users should be able to post advertisements in the channel.

Cooldowns

Cooldowns are pretty simple to set up and by default will fall back to 24 hours if they aren't specified. Setting a custom duration can be done by setting MARKET_COOLDOWN or ADVERT_COOLDOWN to a duration. Durations follow the format shown below.

Valid Examples: 10s, 10m, 10h, 10d

Logs

By default, the bot will log to any channel appropriately named #logs, however this channel can be overridden by setting the LOG_CHANNEL environment variable. Logging can be disabled by setting this to any non-existent channel, a good example of this is LOG_CHANNEL=. (Channels can not contain a dot).

Environment Variables

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

Variable	Description	Default
DB_FILE	What should the database file be named	data.db
TOKEN	The bot token
LOG_CHANNEL	The channel to post logs to (without the #)	logs
MARKET_CHANNEL	The channel to where marketplace postings are sent
ADVERT_CHANNEL	The channel to where advertisements are sent
MARKET_COOLDOWN	The cooldown for the marketplace command	24h
ADVERT_COOLDOWN	The cooldown for the advertisement command	24h

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