Download the PHP package josantonius/minecraft-server-player-stat without Composer
On this page you can find all versions of the php package josantonius/minecraft-server-player-stat. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download josantonius/minecraft-server-player-stat
More information about josantonius/minecraft-server-player-stat
Files in josantonius/minecraft-server-player-stat
Package minecraft-server-player-stat
Short Description PHP library to get live statistics about players on Minecraft servers.
License MIT
Informations about the package minecraft-server-player-stat
PHP Minecraft Server Player Stat library
Translations: Español
PHP library to get live statistics about players on Minecraft servers.
- Requirements
- Relevant details
- Installation
- Available Classes
- MinecraftServer Class
- MinecraftPlayerStat Instance
- Exceptions Used
- Usage
- Tests
- TODO
- Changelog
- Contribution
- Sponsor
- License
Requirements
-
This library is compatible with the PHP versions: 8.1.
-
Minecraft Server: Spigot.
-
Minecraft Versión: 1.17.
- Operating System: Linux | Windows.
Relevant details
-
This library was developed for an application running from the PHP command line (CLI), specifically to power a Twitch bot that displayed live player statistics. I do not recommend using it for a web environment, although it will work.
-
It probably works for recent versions of the Spigot server, but I can't say for sure as it has only been tested with the requirements detailed above. Feel free to add new tests for other servers or Minecraft versions.
- The available terms are set from the minecraft-assets repository of InventivetalentDev.
Installation
The preferred way to install this extension is through Composer.
To install PHP Minecraft Server Player Stat library, simply:
The previous command will only install the necessary files, if you prefer to download the entire source code you can use:
You can also clone the complete repository with Git:
Available Classes
MinecraftServer Class
Josantonius\MinecraftServerPlayerStat\MinecraftServer
Create a new instance for the Minecraft server:
Gets details about certain player statistics:
Get list of available statistics:
Get list of players from the server:
MinecraftPlayerStat Instance
Josantonius\MinecraftServerPlayerStat\MinecraftPlayerStat
Number of broken items or null if there are no statistics:
Number of crafted items or null if there are no statistics:
Number of dropped items or null if there are no statistics:
Number of killed mobs or null if there are no statistics:
Number of killed by mobs or null if there are no statistics:
Number of mined items or null if there are no statistics:
Number of picked up items or null if there are no statistics:
Number of used items or null if there are no statistics:
Custom statistics value or null if there are no statistics:
Sanitized key for the term:
Term expressed in a nice way:
Query term:
Item type:
Unit type:
Username for which the query is being made:
User UUID for which the query is being made:
Exceptions Used
Example of use for this library:
Usage
Gets player statistics about blocks
MinecraftPlayerStat $stat
Gets player statistics about distance
MinecraftPlayerStat $stat
Gets player statistics about entities
MinecraftPlayerStat $stat
Gets player statistics about items
MinecraftPlayerStat $stat
Gets player statistics about time
MinecraftPlayerStat $stat
Get list of available statistics
$terms
Get list of players from the server
$players
Tests
To run composer and to execute the following:
Run unit tests with PHPUnit:
Run code standard tests with PHPCS:
Run PHP Mess Detector tests to detect inconsistencies in code style:
Run all previous tests:
TODO
- [ ] Add new feature
- [ ] Improve tests
- [ ] Improve documentation
- [ ] Improve English translation in the README file
- [ ] Refactor code for disabled code style rules (see phpmd.xml and phpcs.xml)
Changelog
Detailed changes for each release are documented in the release notes.
Contribution
Please make sure to read the Contributing Guide, before making a pull request, start a discussion or report a issue.
Thanks to all contributors! :heart:
Sponsor
If this project helps you to reduce your development time, you can sponsor me to support my open source work :blush:
License
This repository is licensed under the MIT License.
Copyright © 2021-2023, Josantonius