https://github.com/aidn3/hypixel-guild-discord-bridge
Service connects multiple guilds and discord server together
https://github.com/aidn3/hypixel-guild-discord-bridge
bridge chat discord discord-bot hypixel
Last synced: 2 months ago
JSON representation
Service connects multiple guilds and discord server together
- Host: GitHub
- URL: https://github.com/aidn3/hypixel-guild-discord-bridge
- Owner: aidn3
- License: mit
- Created: 2022-03-14T18:30:12.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2026-02-25T03:56:33.000Z (4 months ago)
- Last Synced: 2026-02-25T07:38:49.816Z (4 months ago)
- Topics: bridge, chat, discord, discord-bot, hypixel
- Language: TypeScript
- Homepage:
- Size: 7.14 MB
- Stars: 28
- Watchers: 5
- Forks: 9
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](docs/FAQ.md)
- [All Commands And Interactions](docs/COMMANDS.md)
- [Compatibility and future support](docs/COMPATIBILITY.md)
- [Migrating to newer version](docs/MIGRATION.md)
- [Tracking metrics via Prometheus](docs/PROMETHEUS.md)
- [How to create plugins](docs/PLUGIN-TUTORIAL.md)
- [Contribute](CONTRIBUTING.md)
- [Development Documentation](./docs/DEVELOPMENT.md)
## 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](https://nodejs.dev/download)
- [npm](https://nodejs.org/en/download/) (usually installed by default with `Nodejs`)
- [Git](https://git-scm.com/downloads)
- Minecraft alt account
### Download
Clone and download the complete project by using `Git` tool:
```shell
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:
```shell
./start.sh
```
If you are running the application on Windows operating system:
```shell
npm install
npm start
```
### Run Via Docker
Alternatively, Docker image is available to use at [GitHub Container Service](https://github.com/aidn3/hypixel-guild-discord-bridge/pkgs/container/hypixel-guild-discord-bridge).
Image is usually up to date.
To start, first prepare the configuration as instructed in [this section](#configure). Then execute:
```shell
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:
```shell
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](docs/FAQ.md#how-to-prepare-a-minecraft-account-to-be-added).
## Credits
- The Project is inspired by [hypixel-discord-chat-bridge by Senither](https://github.com/Senither/hypixel-discord-chat-bridge).
- [Soopyboo32](https://github.com/Soopyboo32) for providing [an awesome command API](https://soopy.dev/commands)
- Aura#5051 for in-game commands: Calculate, 8ball, IQ, Networth, Weight, Bitches
- [WildWolfsblut](https://github.com/WildWolfsblut) for helping with various designs and structures
- [SkyCryptWebsite](https://github.com/SkyCryptWebsite) for providing [Senither weight](https://github.com/SkyCryptWebsite/SkyCrypt/blob/e2f421dec3a8afdd4830a26d206ec439e933266f/src/constants/weight/senither-weight.js)
- [Elite Skyblock](https://api.eliteskyblock.com) for providing the farming weight API
- All contributors whether by code, ideas/suggestions or testing