🤖 MineRank

MineRank is a Discord bot built with TypeScript, discord.js & uses DKRCommands Command Handler
It attaches your discord account to a minecraft account.

Requirements

1. Discord Bot Token Guide
2. Node.js 17.0.0 or newer

🚀 Getting Started

git clone https://github.com/dgudim/Discord-minerank-bot
cd Discord-minerank-bot
npm install

After installation finishes follow configuration instructions then run npm run start to start the bot.

⚙️ Configuration

Create a .env file in the same directory as the bot, fill in required variables

⚠️ Note: Never commit or share your token or api keys publicly ⚠️

.env

TEST_SERVERS=<server1>,<server2>,<server3>,...
OWNERS=<owner1>,<owner2>,...

RANK_UPDATE_INTERVAL_MINUTES=<update interval (default is every 10 minutes)>
LOOKUP_SERVER=<your minecraft server address>

RANK_PLUGIN_CONFIG_PATH=<RankSystem config path (config.yml)>
CLAN_PLUGIN_CONFIG_PATH=<ClansLite config file path (clans.yml)>

TOKEN=<discord bot token>

CLAN_CHANNELS_CATEGORY=<Category name for autocreated clan channels>

📝 Features

1. Integrates with ClansLite plugin and syncs clans with discord, creates personal voice and text channel per clan
2. Integrates with RankSystem minecraft plugin and syncs ranks with discord
3. /leaderboard and /clan_leaderboard commands to view the leaderbords
4. /status command to see basic information about your minecraft server
5. Displays player count in it's status