SMPShield: Your Minecraft Server Monitoring Solution
Overview
SMPShield is an innovative plugin designed for Minecraft servers that provides real-time monitoring of critical server statistics through an easy-to-use API. Whether you're a server owner, developer, or community manager, SMPShield empowers you to gain insights into your server's performance and manage it efficiently.
Key Features
- Real-Time Server Statistics: Access vital information about your server’s performance, including:
- CPU Usage: Monitor how much CPU your server is consuming, helping you identify performance bottlenecks.
- RAM Usage: Track both allocated and used memory, ensuring your server runs smoothly without memory leaks.
- TPS (Ticks Per Second): Get real-time TPS updates to ensure your players experience lag-free gameplay.
- Online Player Information: Retrieve a list of online players, including their usernames and unique IDs.
How It Works
SMPShield creates a local HTTP server on your Minecraft server, which exposes various API endpoints. These endpoints allow you to fetch real-time data in JSON format. The plugin is lightweight and doesn’t add significant overhead to your server’s performance.
API Endpoints
- /status: Returns a JSON object with current server statistics:
{
"tps": 20.14,
"cpu_usage": 3.50,
"total_memory": 12902400000,
"free_memory": 11632963584,
"players_online": 0
}
- /players: Returns a list of currently online players:
[
{"name": "Player1", "uuid": "123e4567-e89b-12d3-a456-426614174000"},
{"name": "Player2", "uuid": "123e4567-e89b-12d3-a456-426614174001"}
]
Installation and Configuration
📜 How to Use SMPShield:
- Download the SMPShield plugin from the provided link (available on our Discord server).
- Upload the JAR file to your Minecraft server's plugins directory.
- Restart your server to activate the plugin.
- Configure the
config.yml
file to set your desired API port. You can specify the port number to suit your server's configuration. - Restart your server twice after configuring
config.yml
.
Accessing the API
Once the plugin is installed and the server is running, you can access the API endpoints using the server’s IP and the specified port. For example:
- To get server status, visit:
http://<your-server-ip>:<port>/status
- To get the list of online players, visit:
http://<your-server-ip>:<port>/players
Integration with Discord and Websites
SMPShield is particularly beneficial for developers looking to create bots for Discord or integrate server stats into their websites. With the available API, you can:
- Build Discord bots that announce server performance metrics to your community.
- Create web dashboards that display live server stats, enhancing your server's engagement and transparency.
Support and Community
For support, feature requests, or to share feedback, join our Discord community: SMPShield Discord
Conclusion
SMPShield is an essential tool for any Minecraft server owner who wants to optimize their server's performance and provide a better experience for players. With its straightforward API and real-time data, you'll have everything you need to monitor and manage your server efficiently.
join discord : CLICK HERE
External resources
Featured versions
See allProject members
magic_plays
Owner