ChostPulse - Bukkit/Spigot Plugin

ChostPulse is a lightweight telemetry bridge for Bukkit and Spigot-based servers, designed to synchronize real-time performance metrics with the ChostPulse monitoring network. It utilizes an asynchronous architecture to ensure that data collection and transmission never interfere with the server's main tick loop or player experience.

Features

• Non-Blocking Telemetry Engine: Leverages asynchronous scheduling to transmit heartbeats, ensuring zero impact on server TPS even during network latency or API spikes.
• Automated Identity Handshake: Automatically generates a unique cryptographic token and public ID upon the first launch, establishing a secure and permanent link with the monitoring edge.
• Granular Server Insights: Captures essential performance data, including real-time player counts, Tick-Per-Second (TPS) metrics, and detailed software versioning for precise analytics.
• Instant Badge Deployment: Provides ready-to-use SVG badge URLs via the server console, enabling developers to embed live status and performance indicators directly into GitHub or website documentation.
• Optimized Resource Footprint: Built with performance in mind, the plugin uses minimal memory and CPU cycles, making it suitable for both small community servers and high-traffic networks.
• Plug-and-Play Simplicity: Requires zero manual configuration to get started; simply drop the plugin in, and it will begin reporting metrics using sane, pre-defined defaults.

Installation

Follow these steps to integrate the telemetry bridge into your server environment:

1. Download the latest ChostPulse-Bukkit.jar file from the official releases page.
2. Place the JAR file into your server's plugins/ directory.
3. Restart or reload your server to initialize the plugin.
4. On the first run, check the console for your unique Public ID and generated badge URLs to verify the connection.

Configuration

api_url: "https://your-domain.com/api/heartbeat"
token: "" # Generated automatically
interval: 60 # Seconds
send-software: true
debug: false

Badges

Use your Public ID (found in server logs on startup) to display badges:

• Status: https://your-domain.com/api/badge?id=YOUR_ID&type=status
• TPS: https://your-domain.com/api/badge?id=YOUR_ID&type=tps
• Players: https://your-domain.com/api/badge?id=YOUR_ID&type=players
• Software: https://your-domain.com/api/badge?id=YOUR_ID&type=software
• Version: https://your-domain.com/api/badge?id=YOUR_ID&type=version

Contributing

Contributions are welcome and appreciated! Here's how you can contribute:

1. Fork the project
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Please make sure to update tests as appropriate and adhere to the existing coding style.

License

This project is licensed under the CSSM Unlimited License v2.0 (CSSM-ULv2). Please note that this is a custom license. See the LICENSE file for details.