hypixel-guild-discord-bridge

Introduction

A service that connects multiple Hypixel guilds and Discord servers together. This project is made to be fully flexible and customisable, offering a high quality user experience while keeping it simple.

DISCLAIMER: This project interacts with Hypixel in an unintended way by simulating a minecraft client and by processing packets which might get you banned if over-abused too much.
Just like any other modification and service that interacts with Hypixel servers, this goes without saying: "Use at your own risk"

Documentation And Tutorials

• Frequently asked questions
• All Commands And Interactions
• Compatibility and future support
• Migrating to newer version
• Tracking metrics via Prometheus
• How to create plugins
• Contribute
• Development Documentation

Features

• Connect multiple guilds chats together
• Bind hypixel guild chats to Discord channels
• Supports public, officer and private chat
• Supports in-game moderation commands from Discord
• Fully synchronize in-game chat and interactions with Discord including guild events such as online/offline/join/leave/mute notification/etc
• Support many commands from fun ones to management ones
• Logs all chats/events/etc as records for staff to view
• Provides detailed metrics per user and per guild (by Prometheus or by leaderboard)
• Supports custom plugins with fully fleshed out public API
• Supports proxies for Minecraft instances

Installing and Running

Prerequisites

• Nodejs version 1.20 or later
• npm (usually installed by default with Nodejs)
• Git
• Minecraft alt account

Download

Clone and download the complete project by using Git tool:

git clone https://github.com/aidn3/hypixel-guild-discord-bridge

Configure

• Explore the project files and copy the contents of config_example.yaml into config.yaml
• Open config.yaml and fill in the information (Security: config.yaml contains sensitive information. Keep it safe!)
• In config.yaml fill out general.hypixelApiKey and discord.key and discord.adminIds
• (Optional) for Advanced users only: Edit other options in config.yaml to fine tune the bridge

Install And Run

If you are on linux, execute this command to auto download all libraries and start the application. It will also keep the application up to date:

./start.sh

If you are running the application on Windows operating system:

npm install
npm start

Run Via Docker

Alternatively, Docker image is available to use at GitHub Container Service. Image is usually up to date.

To start, first prepare the configuration as instructed in this section. Then execute:

sudo docker container run -it --rm -v ./config.yaml:/app/config.yaml ghcr.io/aidn3/hypixel-guild-discord-bridge:latest

Note that the path of the configuration source file must either be relative (with the ./) or absolute.

Alternatively, providing the path as an argument to the docker container is also possible:

sudo docker container run -it --rm -v ./config.yaml:/config/config.yaml ghcr.io/aidn3/hypixel-guild-discord-bridge:latest /config/config.yaml

Setup Via Discord

After installing and running the application, basic setup needs to be done to integrate the application.

Use Discord slash command /settings to configure the application:

• Set up the public and officer channels
• Check How to prepare and add Minecraft account.

Credits

• The Project is inspired by hypixel-discord-chat-bridge by Senither.
• Soopyboo32 for providing an awesome command API
• Aura#5051 for in-game commands: Calculate, 8ball, IQ, Networth, Weight, Bitches
• WildWolfsblut for helping with various designs and structures
• All contributors whether by code, ideas/suggestions or testing