Skip to content

Developer Guide

Aridro Chatterjee edited this page Nov 15, 2026 · 2 revisions

Developer Guide

Welcome to the MineBridge Developer Guide!

This page is for developers who want to understand, modify, extend, or contribute to MineBridge.

Project Overview

MineBridge is a Java-based Minecraft plugin that connects Minecraft servers with Discord.

The project uses:

  • Java 21 — Primary programming language
  • Gradle — Build automation
  • JDA 5.6.1 — Discord API integration
  • Spigot API 1.20.6 — Minecraft server API

Development Requirements

Before working on MineBridge, make sure you have:

  • JDK 21 or compatible Java development environment
  • Git
  • Gradle (or use the included Gradle Wrapper)
  • An IDE such as IntelliJ IDEA or Eclipse
  • A Minecraft server for testing
  • A Discord bot for testing Discord integration

Getting the Source Code

Clone the repository:

git clone https://github.com/aridrochatterjee/Minebridge.git


Move into the project directory:
cd Minebridge


Building the Project
On Linux or macOS:
./gradlew build


On Windows:
gradlew.bat build


The generated plugin JAR can be found inside:
build/libs/


Use the generated JAR in a test Minecraft server.
Development Guidelines
When modifying MineBridge:
1. Keep the existing code structure consistent.
2. Follow Java naming conventions.
3. Avoid unnecessary dependencies.
4. Handle Discord and Minecraft API errors properly.
5. Keep configuration options documented.
6. Add or update tests when introducing functionality.
7. Test changes on a Minecraft server before submitting them.
Testing
Before submitting changes, run:
./gradlew test


Then build the project:
./gradlew build


Make sure both commands complete successfully.
Debugging
When investigating an issue:
- Check the Minecraft server console.
- Look for exceptions and stack traces.
- Verify the configuration.
- Check Discord bot permissions and connectivity.
- Reproduce the issue using a test server.
Never publish bot tokens, credentials, or other secrets in logs or issue reports.
Contributing
Want to improve MineBridge?

You can contribute by:
- Fixing bugs
- Improving existing features
- Adding new functionality
- Improving documentation
- Reporting compatibility issues
- Suggesting improvements
Before starting a major change, open a GitHub issue to discuss the idea.
Useful Links
- [GitHub Repository](https://github.com/aridrochatterjee/Minebridge?utm_source=chatgpt.com)
- [GitHub Issues](https://github.com/aridrochatterjee/Minebridge/issues?utm_source=chatgpt.com)
- [Modrinth Page](https://modrinth.com/plugin/minebridge?utm_source=chatgpt.com)

Happy coding!

Clone this wiki locally