README

PHP 库，用于获取 Minecraft 服务器上玩家的实时统计数据。

需求
相关细节
安装
可用类
- MinecraftServer 类
- MinecraftPlayerStat 实例
使用的异常
用法
测试
待办事项
更新日志
贡献
赞助商
许可证

需求

此库与 PHP 版本 8.1 兼容。
Minecraft 服务器: Spigot。
Minecraft 版本: 1.17。
操作系统: Linux | Windows。

安装

安装此扩展的首选方式是通过 Composer。

要安装 PHP Minecraft 服务器玩家统计库，请按以下步骤操作

composer require josantonius/minecraft-server-player-stat

前面的命令只会安装必要的文件，如果您想 下载整个源代码，可以使用

composer require josantonius/minecraft-server-player-stat --prefer-source

您还可以使用 Git 克隆整个仓库

git clone https://github.com/josantonius/php-minecraft-server-player-stat.git

可用类

MinecraftServer 类

Josantonius\MinecraftServerPlayerStat\MinecraftServer

为 Minecraft 服务器创建一个新的实例

/**
 * @param string $version     Server version.
 * @param string $language    Server language.
 * @param string $logsPath    Server logs directory path.
 * @param string $statsPath   Server stats directory path.
 * @param string $storagePath Directory path where available terms and players will be stored.
 *
 * @throws MinecraftServerException      if the Minecraft version or language is not valid.
 * @throws UnreadableDirectoryException  if the logs or stats path is not valid.
 * @throws UnwriteableDirectoryException if the storage path is not valid.
 *
 * @see https://mcasset.cloud/1.19.2/assets/minecraft/lang to see available languages.
 */
public function __construct(
    private string $version,
    private string $language,
    private string $logsPath,
    private string $statsPath,
    private string $storagePath,
);

获取特定玩家统计信息的详细信息

/**
 * @param string $username Username in case insensitive.
 * @param string $term     Literal Minecraft term in case insensitive.
 *                         In Spanish, a term with accents can be written without them. 
 *                         For another languages accents are required.
 *
 * @throws WrongTermException       if the term is not valid.
 * @throws StatsNotFoundException   if the stats file is not found.
 * @throws UnknownUsernameException if the username is not valid.
 */
public function getPlayerStat(string $username, string $term): MinecraftPlayerStat;

获取可用统计信息的列表

public function getAvailableStats(): array;

从服务器获取玩家列表

public function getPlayerList(): array;

MinecraftPlayerStat 实例

Josantonius\MinecraftServerPlayerStat\MinecraftPlayerStat

损坏的物品数量，如果没有统计数据则为 null

public readonly int|null $broken;

制作的物品数量，如果没有统计数据则为 null

public readonly int|null $crafted;

掉落的物品数量，如果没有统计数据则为 null

public readonly int|null $dropped;

被怪物击杀的怪物数量，如果没有统计数据则为 null

public readonly int|null $killed;

被怪物击杀的数量，如果没有统计数据则为 null

public readonly int|null $killedBy;

挖掘的物品数量，如果没有统计数据则为 null

public readonly int|null $mined;

捡起的物品数量，如果没有统计数据则为 null

public readonly int|null $pickedUp;

使用的物品数量，如果没有统计数据则为 null

public readonly int|null $used;

自定义统计值，如果没有统计数据则为 null

/**
 * If the unit type is distance, this value is given in centimeters.
 * If the unit type is time, this value is given in ticks.
 * 
 * @see https://minecraft.fandom.com/wiki/Tutorials/Units_of_measure to see the unit conversions.
 */
public readonly int|null $custom;

术语的清洁键

public readonly string $key;

以优雅的方式表达的术语

public readonly string $prettyTerm;

查询术语

public readonly string $term;

项目类型

/**
 * Available types: block, entity, item, stat.
 */
public readonly string $type;

单位类型

/**
 * Available types: amount, distance, time.
 */
public readonly string $unitType;

查询的账户名

public readonly string $username;

查询的账户UUID

public readonly string $uuid;

使用的异常

此库的用法示例

use Josantonius\MinecraftServerPlayerStat\Exceptions\WrongTermException;
use Josantonius\MinecraftServerPlayerStat\Exceptions\StatsNotFoundException;
use Josantonius\MinecraftServerPlayerStat\Exceptions\UnknownUsernameException;
use Josantonius\MinecraftServerPlayerStat\Exceptions\MinecraftServerException;
use Josantonius\MinecraftServerPlayerStat\Exceptions\UnreadableDirectoryException;
use Josantonius\MinecraftServerPlayerStat\Exceptions\UnwriteableDirectoryException;