A two-way chat bridge between Hypixel guild chat and a Discord channel. The application utilizes discord.js v14 for communicating with Discord, and Mineflayer for communicating with Hypixel.
⚠️ This application will login to Hypixel using Mineflayer which is not a normal Minecraft client, this could result in your Minecraft account getting banned from Hypixel, so use this application at your own risk. I am not responsible for any bans that may occur.⚠️
- Git
- NodeJS >= 16.9
- A Minecraft account
To get started, clone down the repository using:
git clone https://github.com/DuckySoLucky/hypixel-discord-chat-bridge.git
Next go into the hypixel-discord-chat-bridge folder and install all the dependencies using NPM.
npm install
While the dependencies are being installed you can edit the configuration file. The configuration file is called config.example.json. It is pretty self explanatory, but if you need help with it, you can check out the Configuration section. Once you are done editing, save it and rename it to config.json.
Once edited and the dependencies are installed, you can start the application using:
node index.js
Using the link provided in the console, you sign into the minecraft account that you want to use.
- Git
- Docker >= 20
Older versions may also work, but have not been tested. - A Minecraft account
In here we are going to clone the repository, set up the configuration file, volume directory, build the image, and run the container.
-
Clone the repository and enter the directory:
git clone https://github.com/DuckySoLucky/hypixel-discord-chat-bridge.git cd hypixel-discord-chat-bridge -
Configure the volume directories in /opt/ as
root:mkdir -p /opt/docker/hypixel-discord-chat-bridge/data/ mkdir -p /opt/docker/hypixel-discord-chat-bridge/auth-cache/ -
Move the following files into the directory using:
mv config.example.json /opt/docker/hypixel-discord-chat-bridge/config.json mv messages.json /opt/docker/hypixel-discord-chat-bridge/messages.json mv data/* /opt/docker/hypixel-discord-chat-bridge/data -
Change the ownership of the directory to the user you want to run the container as using:
chown -R 1000:1000 /opt/docker/hypixel-discord-chat-bridge/ -
Edit the configuration file called
config.jsonin/opt/docker/hypixel-discord-chat-bridge/using the Configuration section. -
Build the image using:
docker build . -t hypixel-discord-chat-bridge:latest -
Once the image is built, you can run the container for the first time using:
docker run -it \ -v /opt/docker/hypixel-discord-chat-bridge/data:/usr/src/app/data \ -v /opt/docker/hypixel-discord-chat-bridge/auth-cache:/usr/src/app/auth-cache \ -v /opt/docker/hypixel-discord-chat-bridge/config.json:/usr/src/app/config.json \ -v /opt/docker/hypixel-discord-chat-bridge/messages.json:/usr/src/app/messages.json \ -v /etc/localtime:/etc/localtime:ro \ --restart unless-stopped \ --name hypixel-discord-chat-bridge \ hypixel-discord-chat-bridge:latest -
Using the link provided in the console, sign in to the minecraft account that you want to use.
-
Once you are signed in, you can stop the container using:
Ctrl + C -
Now you can start the container using:
docker start hypixel-discord-chat-bridge
The bot section contains configuration options for the bot, including the prefix, messageFormat, and messageRepeatBypassLength.
The prefix option determines the command prefix used for minecraft commands. By default, this is set to !.
The messageFormat option is a string that will be appended to the beginning of every message sent by the bot. By default, this is set to ».
The messageRepeatBypassLength option is an integer value that determines the length of a string that will be sent after message in case You cannot say the same message twice! occurs.
The fragBot section contains options for the bot's fragBot feature, which manages a whitelist and blacklist of users.
The enabled option determines whether the fragBot is enabled. By default, this is set to true.
The whitelist option determines whether the whitelist feature is enabled. By default, this is set to false.
The whitelisted option is an array of user usernames or UUIDs that will be added to the whitelist which already includes Guild members. By default, this is set to an empty array.
The blacklist option determines whether the blacklist feature is enabled. By default, this is set to false.
The blacklisted option is an array of user usernames or UUIDs, blacklisted played won't be able to use fragBot. By default, this is set to an empty array.
The guild section contains options related to the Hypixel guild.
The guildExp option is an integer value required for the !gexp command, which is used to check how much more guild experience a user needs to collect to meet the guild's requirements. By default, this is set to 50,000.
The API options include information about APIs which are being used, the only values which needs to be changed are hypixelAPIkey and imgurAPIkey.
You can receive Hypixel API key by going to Hypixel Developer Dashboard and creating new application.
Hypixel API is used for most of stats related commands.
Imgur API can be generated Here.
Imgur API is used for rendering commands like
!armor,!pet,!equipmentetc.
The guildRequirements section contains options related to the Hypixel Guild's requirements.
The enabled option determines whether guild requirements are enabled. By default, this is set to false.
The autoAccept option determines whether guild invites should be automatically accepted if the user meets the guild's requirements. By default, this is set to false.
The requirements option is an object containing various requirements for joining the guild, including bedwarsStars, bedwarsStarsWithFKDR, bedwarsFKDR, skywarsStars, skywarsStarsWithKDR, skywarsKDR, duelsWins, duelsWinsWithWLR, duelsWLR, senitherWeight, lilyWeight, and skyblockLevel. By default, all of these requirements are set to 0.
The skyblockEventsNotifications object contains the settings related to Skyblock events notifications.
The enabled property determines whether the feature is enabled or not. If it's set to true, the bot will send a message to the Guild chat 30 and 5 minutes before an event occurs
The notifiers object contains a list of events that the bot will notify for, and whether each event is enabled or not. By default, all events are enabled. You can disable an event by setting its value to false.
Here's a list of the supported events:
- BANK_INTEREST: When bank interest is given to players.
- DARK_AUCTION: When the Dark Auction event starts.
- ELECTION_BOOTH_OPENS: When the election booth opens.
- ELECTION_OVER: When the election is over and the results are announced.
- FALLEN_STAR_CULT: When the Fallen Star Cult event starts.
- FEAR_MONGERER: When the Fear Mongerer event starts.
- JACOBS_CONTEST: When the Jacob's Contest event starts.
- JERRYS_WORKSHOP: When Jerry's Workshop event starts.
- NEW_YEAR_CELEBRATION: When the New Year's Celebration event starts.
- SEASON_OF_JERRY: When the Season of Jerry event starts.
- SPOOKY_FESTIVAL: When the Spooky Festival event starts.
- TRAVELING_ZOO: When the Traveling Zoo event starts.
The bot options include the token, and serverID options.
The token is the Discord application token, if you don't already have a Discord App, you can create a new app, then convert the app to a Discord bot, and then get your Discord bot token on the "Bot" page.
The serverID is same as clientID but it's ID of the server. you can get it by right clicking on server and clicking on Copy ID.
The guildChatChannel is the ID of the text channel the bot should be linked with, the bot will only send and listen to messages in the channel defined in the config.
The officerChannel is the ID of the text channel the bot should be linked with for the Officer Chat, the bot will only send and listen to messages in the channel defined in the config.
The loggingChannel is the ID of the text channel the bot should be linked with for the Logs Chat, the bot will only send and listen to guild managment stuff like kicks, mutes, promotions, demotions etc.
The debugMode is a boolean setting which is an ability to toggle debugChannel
The debugChannel is the ID of text channel the bot should be linked with for the chat, the bot will send every single minecraft message here, anyone can send and execute commands from this channel
The commandRole is the ID of any role on the server the bot is hosted for, any user with the role will be able to run all the Discord commands built into the bot, like /kick and /promote.
The messageMode can either be bot, webhook or minecraft. This selects how the messages should be displayed when sent from Minecraft to Discord. If webhook mode is selected the bot requires the Manage Webhooks permission in the channel it's running in. The bot always requires the Send Messages and View Channel permissions in the channel you're using it in.
-
Webhook Example
-
Bot Example
-
Minecraft Example
Note - The Discord rate limit for webhooks is 30 requests every 60 seconds, where as for bot and minecraft messages it's 5 messages every 5 seconds. Using webhooks effectively halves the number of messages the bot can send per minute which may cause issues in an active guild.
The filterMessage is ability to toggle filtering messages. This should be set to true otherwise bot might get banned.
The joinMessage is ability to toggle join and leave message being sent to the discord channel.
< > = Required arguments, [ ] = Optional arguments
Discord
| Command | Description | Syntax | Example | Response |
|---|---|---|---|---|
| blacklist | Blacklists specified user from using bot. | /blacklist [arg] [player] |
/blacklist add DuckySoSkilled |
 |
| demote | Demotes the given user by one guild rank. | /demote [player] |
/demote DuckySoSkilled |
 |
| guildtop | Top 10 members with the most guild xp. | /guildtop [integer] |
/guildtop 5 |
 |
| help | Shows help menu. | /help |
/help |
 |
| info | Shows information about bot. | /info |
/info |
 |
| invite | Invites the specified user to the guild. | /invite [player] |
/invite DuckySoSkilled |
 |
| kick | Kicks the specified user from the guild. | /kick [player] [reason] |
/kick DuckySoSkilled |
 |
| mute | Mutes the given user for a given amount of time. | /mute [player] [time] |
/mute DuckySoSkilled 1h |
 |
| online | View online player in the guild. | /online |
/online |
 |
| execute | Executes commands as the minecraft bot. | /execute [command] |
/execute /g unmute DuckySoSkilled |
 |
| ping | Shows the latency of the bot. | /ping |
/ping |
 |
| promote | Promotes the specified user by 1 rank. | /promote [player] |
/promote DuckySoSkilled |
 |
| unmute | Unmutes the given user. | /unmute [player] |
/unmute DuckySoSkilled |
 |
| uptime | Shows the uptime of the bot. | /uptime |
/uptime |
 |
Minecraft
| Command | Description | Syntax | Example | Response |
|---|---|---|---|---|
| 8ball | Ask an 8ball a question. | !8ball <question> |
!8ball Is this bot good? |
Yes definitely. |
| accessories | Accessories of specified user. | !accessories [player] |
!accessories Refraction |
Refraction's Accessories » 98 Recombobulated » 97 Enriched » 43 & Refraction's Accessories » Common - 0 Uncommon - 16 Rare - 13 Epic - 26 Legendary - 16 Special - 0 Very Special - 2 |
| armor | Renders armor of specified user. | !armor [player] |
!armor DeathStreeks |
DeathStreeks's armor » https://i.imgur.com/JdijFmo.png https://i.imgur.com/8uBpRrY.png https://i.imgur.com/oVQl6WV.png https://i.imgur.com/x7wlfnk.png |
| auction | Active Auctions of specified user. | !auction [player] |
!auction DuckySoSkilled |
DuckySoSkilled's Active Auctions » https://i.imgur.com/9Jw8zCK.png |
| bedwars | BedWars stats of specified user. | !bedwars [player] |
!bedwars Refraction |
[13✫] Refraction FK: 358 FKDR: 7.31 Wins: 83 WLR: 1.54 BB: 216 BLR: 3.09 WS: 3 |
| catacombs | Skyblock Dungeons Stats of specified user. | !catacombs [player] |
!catacombs DeathStreeks |
DeathStreeks's Catacombs: 62.29 Class Average: 50 Secrets Found: 279,088 (8.50 SPR) Classes: H - 50 M - 50 B - 50 A - 50 T - 50 |
| duels | Duel stats of specified user. | !duels [player] |
!duels DuckySoSkilled |
[Duels] [Godlike II] DuckySoSkilled Wins: 27044 CWS: 6 BWS: 536 WLR: 4.95 |
| equipment | Renders equipment of specified user. | !equipment [name] |
!equipment Refraction |
Refraction's Equipment » https://i.imgur.com/QOU2r0O.png https://i.imgur.com/dUrotYa.png https://i.imgur.com/0Fxnkjd.png https://i.imgur.com/wIEcrZX.png |
| fairysouls | Fairy Souls of specified user. | !fairysouls [player] |
!fairysouls DeathStreeks |
DeathStreeks's Fairy Souls: 238/238 Progress: 100.00% |
| fetchur | Information about an item for Fetchur. | !fetchur [item] |
!fetchur |
Fetchur Requests » 1x Superboom TNT Description: This item can be purchased from the Auction House or found in dungeons |
| guildexp | Guilds experience of specified user. | !guildexp [player] |
!guildexp DuckySoSkilled |
Your Weekly Guild Experience » 1,495 |
| help | Shows help menu. | !help |
!help |
https://imgur.com/BQBQXwN.png |
| kitty | Random image of cute cat. | !kitty |
!kitty |
https://i.imgur.com/jgUI7KO.jpg |
| level | Skyblock Level of specified user. | level [player] |
!level DeathStreeks |
DeathStreek's Skyblock Level » 354.59 |
| math | Calculate any kind of math problem. | !math <calculation> |
!math 6 * 9 + 6 + 9 |
6*9+6+9 = 69 |
| monthly | Get monthly stats of specified user. | !monthly [player] |
!monthly DuckySoSkilled |
DuckySoSkilled has gained 0 karma and gained 0.1 levels in the last month. |
| networth | Networth of specified user. | !networth [player] |
!networth Refraction |
Refraction's Networth is 114 B Unsoulbound Networth: 61.9 B Purse: 3.56 B Bank: 1.07 B |
| pet | Renders active pet of specified user. | !pet [player] |
!pet Refraction |
Refraction's Active Pet » https://i.imgur.com/FVuLQk4.png |
| render | Renders item of specified user. | !render [player] [slot] |
!render DuckySoSkilled |
DuckySoSkilled's item at slot 1 » https://i.imgur.com/U2dIcSc.png |
| skills | Skills and Skill Average of specified user. | !skills [player] |
!skills DuckySoSkilled |
Skill Average » 54.44 Farming - 60.00 Mining - 60.00 Combat - 60.00 Enchanting - 60.00 Fishing - 50.00 Foraging - 50.00 Alchemy - 50.00 Taming - 50.00 Carpentry - 50.00 |
| skywars | Skywars stats of specified user. | !skywars [player] |
!skywars DuckySoSkilled |
[38✫] Refraction KDR: 6.04 WLR: 1.01 WS: 0 |
| skyblock | Skyblock Stats of specified user. | !skyblock [player] |
!skyblock DeathStreeks |
DeathStreeks's Level » 354.59 Senither Weight » 44,455 Lily Weight » 39,268 Skill Average » 54.4 Slayer » 7,918,100 Catacombs » 62 Class Average » 50 Networth » 133 B Accessories » 98 Recombobulated » 97 Enriched » 44 |
| slayer | Slayer of specified user. | !slayer [player] [type] |
!slayer DeathStreeks |
DeathStreeks's Slayer - Zombie: Level: 9 Experience: 3,165,000 Spider: Level: 9 Experience: 1,000,625 Wolf: Level: 9 Experience: 1,002,000 Enderman: Level: 9 Experience: 1,715,475 Blaze: Level: 9 Experience: 1,035,000 |
| UHC | UHC Stats of specified user. | !UHC [player] |
!UHC DuckySoSkilled |
[6✫] Refraction KDR: 2.54 WLR: 69 Heads: 578 |
| weight | Skyblock Stats of specified user. | !weight [player] |
!weight DuckySoSkilled |
Refraction's Senither Weight » 27721.82 Skills: 12991.95 Dungeons: 11353.90 & Refraction's Lily Weight » 28342.24 Skills » 12310.84 Slayer » 4476.85 Dungeons » 11554.55 |
| woolwars | WoolWars stats of specified user. | !woolwars [player] |
!woolwars DuckySoSkilled |
[2✫] DuckySoSkilled » W: 5 WLR: 0.5 KDR: 1.19 BB: 37 WP: 45 |
Bot also supports Soopy V2 commands, prefix is same as mod's prefix.
If you think that message format is boring, you can check out my repository for ChatTriggers module which changes the way messages from Bot look like. Click Here
This CTJS module is currently outdated and doesn't fully supprot all minecraft chat formats and bugs might occur.
The bot also includes event notifier that can be used to send message in guild 30 & 5 minutes before the event starts, by the default all of the events are toggled on. Feel free to disable events which you do not like in config.
Preview
The bot also includes an integrated frag bot that can be used by the guild.
-
!petCommand lore splitting- Lore of pet can sometimes be very long, to solve this issue there should be lore formatter function which will split lore every x characters so it looks better.