AccurateReadings aims to provide accurate resource utilization statistics by communicating with a Pterodactyl panel using the Pterodactyl4J wrapper made by mattmalec, and of course using the Pterodactyl panel API. Furthermore, if PlaceholderAPI is present, the plugin will also register a few placeholders that you can use to display your resource usage statistics on any other plugin that supports PAPI placeholders: want to display RAM usage in your server's playerlist/tab using TitleManager? No problem!
- A Pterodactyl panel. If you're using a shared hosting plan and the panel is powered by Pterodactyl, then you are able to use this plugin. If you're self-hosting your server (home server, your PC, a VPS or dedicated server...), make sure you use Pterodactyl, not only is it really easy to install, but it is an excellent panel software. Please read the wiki for instructions on how to check if the panel you're using is powered by Pterodactyl.
- A Spigot server. This plugin has been coded against Spigot 1.12.2, but it has been tested on Pufferfish 1.17.1 and the latest Purpur 1.19.3 build. It should work on any server running Spigot, or one of its forks: Paper, Purpur... Therefore, this plugin is expected to work on versions as old as 1.8.8 (tested on Paper 1.8.8 build 445).
- Go to your Pterodactyl panel and, on the left sidebar, click on 'Account API'. If you're using a Sparked Host server, click here.
- In the top right corner, click on Create New. Add a description (e.g. "AccurateReadings") and leave the 'Allowed Connection IPs' empty unless you're 100% sure what IP will your server be using to connect to the API (this is hard to determine on shared hosting environments as it may use the node's main IP address to communicate, which is not always obvious).
- Copy the API key for later. You won't be able to see it again, so make sure you save it!
- Upload the plugin JAR (you can grab it from the releases page) to the plugins directory on your server.
- Restart your server in order to generate the config file. The plugin will then disable itself, please stop the server
after it has fully loaded and navigate to
plugins/AccurateReadings, then open the config.yml file. - Then fill in the rest of the options:
panel-urlis the URL of your Pterodactyl panel;server-idis your server ID and you can find it under 'Settings' in your server, but it is not necessary;api-keyis the API key we copied earlier. Make sure you don't remove the quotation marks from any of the options. - Save the changes and start the server.
/stats: Shows current resource usage. Aliases:/perf,/performance,/lag
This may override Essentials' /lag command, but you can fix this in the commands.yml file on your server, or you can
just use /elag.
/arc: Main control command. This contains a few subcommands that allow you to control different aspects of the plugin and your server.
This plugin also registers a few PlaceholderAPI placeholders, you can find the complete list in the wiki.
- CPU normalization might not work.
- OkHttp by Square (provided by P4J)
- Okio by Square (provided by P4J)
- Pterodactyl4J by mattmalec
- Thanks to the Sparked Host LLC community for providing feedback, suggestions and bug reports during initial development.
- 1.0.0-pre1. First public version of the plugin
- 1.1.0. Removed Sparked Host lock, added proper configuration checks and cooldown, and fixed a few bugs.
- 1.2.0. Tons of code quality and performance improvements, restructured the config file, added PlaceholderAPI support, switched to a better API wrapper.
As this project has been officially released by Sparked Host, our support team may provide assistance with this plugin. For any other inquiries, you may reach out to Raúl via email: raul.m@sparkedhost.com