Miscellaneous Guild Bridge

A bot used to Bridge between Discord and Hypixel guild chats.

Warning

This application will log into Minecraft using Mineflayer, a JavaScript API for Minecraft. This may be against the rules of some servers and could result in punishment. All contributors to this repository are not liable for damages, and no warranty is provided under the MIT License.

Note

This application will no longer receive updates that contain new features or QOL improvements. Updates, where necessary, will only contain patches for security vulnerabilities and bugs.

• Features
• Installation
  • Prerequisites
  • Setup
  • Process Management
• Contributing
  • Issues and Bug Reports
• Acknowledgements
• License

Features

• Bridges between Discord and Hypixel guild chats.
• Sends all guild related messages, including chat, guild announcements and more to Discord.
• Automatic restarts and reconnections.
• Privileged slash commands to control bot behaviour in-game.
• Toggleable slowmode to control member usage.
• Basic filtering of extreme profanity to protect bot accounts from abuse.
• Configurable in-game reminders to spread the word about news and upcoming events.

Installation

Prerequisites

• Git
• NodeJS >=18.20.4 and npm
• A full access Minecraft Java Edition account

Setup

1. ⭐ Star this repository!
2. Install pnpm via one of their installation methods, or the following command:

$ npm install -g pnpm

3. Clone the repository into a directory of your choice.

$ git clone https://github.com/MiscGuild/bridge.git

4. Enter the new directory and install packages.

$ cd bridge
$ pnpm install

5. Make a new Discord bot account on the Discord Developer Portal and retrieve the bot token.

6. Under the Bot tab, grant the bot the Message Content Intent.

7. Generate an invite URL by going to the OAuth2 tab and clicking on the URL Generator. Add the bot and application.commands scopes, before opening the link to invite the bot to your server.

8. Setup the project config files.

$ pnpm run setup-files

9. Fill out the .env file with your credentials.

10. Promote the Minecraft account used by the bot to Officer in-game in order for it to view the Officer chat and run privileged commands.

11. Build and run the bot.

$ pnpm run build
$ pnpm start

Process Management

If you are self-hosting or your process manager does not automatically restart the bot in the event of a crash, you may use PM2, a process manager for Node.js applications.

Use the pm2:start script instead of the start script to launch the bot. To stop the process, use the pm2:kill script.

$ pnpm run pm2:start
$ pnpm run pm2:kill

Please refer to the PM2 documentation for more configuration options and information about PM2.

Contributing

Pull requests are welcome. If you would like to chat with other developers please join our Discord and go to #programming-talk.

Before submitting your changes for review, please ensure:

• The application is fully functional, and all your code has been thoroughly tested to avoid potential bugs or security vulnerabilities.
• Your commit messages adhere to the Conventional Commits specification.

Issues and Bug Reports

To raise an issue or bug report, please contact a developer or open an issue.

Acknowledgements

Parts of this project use code from the following repositories:

• Hychat Self-Host under the MIT License.
• Hypixel API TypeScript under the MIT License.

License

This is an open-source project licensed under the MIT License.