https://github.com/lory24/mpu
Minecraft Pinging Utilities is a project designed to provide an easy and comfortable API to interact with the Server List Ping system of Minecraft.
https://github.com/lory24/mpu
api framework hacktoberfest libs minecraft paper ping protocol spigot status velocity
Last synced: 5 months ago
JSON representation
Minecraft Pinging Utilities is a project designed to provide an easy and comfortable API to interact with the Server List Ping system of Minecraft.
- Host: GitHub
- URL: https://github.com/lory24/mpu
- Owner: LoRy24
- License: bsd-3-clause
- Created: 2025-10-18T14:14:41.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2025-10-26T21:50:34.000Z (5 months ago)
- Last Synced: 2025-10-26T23:26:46.947Z (5 months ago)
- Topics: api, framework, hacktoberfest, libs, minecraft, paper, ping, protocol, spigot, status, velocity
- Language: Java
- Homepage:
- Size: 176 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Minecraft Pinging Utilities (MPU)
A modern, lightweight Java library for interacting with the Minecraft Server List Ping protocol.
## 🎗️ Overview
MPU provides an easy-to-use API to ping Minecraft servers and retrieve their status information — including version, player count, MOTD, favicon, and more — without having to deal with raw protocol details.
## 📦 Features
- Supports the latest Minecraft server ping protocol.
- Parses responses into clean, typed Java objects.
- Handles description (MOTD), version, players, favicon, and enforcesSecureChat.
- Lightweight and easy to integrate with any Java project (Spigot, Paper, Velocity, standalone apps, etc.).
- BSD-3-Clause license.
## ⚒️ Installation
To install this framework, you might import it via Maven or Gradle. For maven, just paste this piece of code inside of the
dependencies section:
```xml
com.github.lory24
mpu-framework
1.0.2
```
If you're using gradle, paste this:
```groovy
implementation 'com.github.lory24:mpu-framework:1.0.2'
```
Otherwise, you have to download the package .jar file and import it manually (unrecommended).
> [!CAUTION]
> In order to include the Gradle or Maven dependency, you'll need to add the GitHub repository as shown in the
> [Official Guide for Maven](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry)
> or [Official Guide for Gradle](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry).
> Remember to create a token and set it in the environment variables or any other method to let maven/gradle use them.
## 🤝 Contributing
Good contributions (including docs) are welcome!
- Fork the repository
- Create a new feature/fix branch
- Commit and push your changes
- Open a Pull Request with a clear description of your changes
If you need more details, check the contributing section.
## ⚠️ Notes
- Some servers return the description field as a rich JSON chat component instead of plain text. MPU parses basic structures, but you may need to handle advanced formatting yourself.
- Ensure compatibility with custom or modified server versions when needed.
## 📄 License
This project is licensed under the *BSD-3-Clause* License. See the [LICENSE](./LICENSE) file for details.