PHP Minecraft Query 技术文档

1. 安装指南

使用 Composer 安装

要安装 PHP Minecraft Query 库，您可以使用 Composer，这是 PHP 的依赖管理工具。在您的项目根目录下运行以下命令：

composer require xpaw/php-minecraft-query

手动安装

如果您不想使用 Composer，也可以手动下载库文件并将其放置在您的项目目录中。您可以从 GitHub 下载最新版本的库文件。

2. 项目的使用说明

Ping 方法

Ping 方法用于查询 Minecraft 服务器的基本信息，如主机名、MOTD、图标和玩家样本。这种方法适用于 Minecraft 1.7 及以上版本的服务器。

示例代码

<?php
require __DIR__ . '/vendor/autoload.php';

use xPaw\MinecraftPing;
use xPaw\MinecraftPingException;

try {
    $Query = new MinecraftPing('localhost', 25565);
    print_r($Query->Query());
} catch (MinecraftPingException $e) {
    echo $e->getMessage();
} finally {
    if ($Query) {
        $Query->Close();
    }
}
?>

Query 方法

Query 方法使用 GameSpy4 协议，可以获取服务器的完整插件列表和玩家列表。但这种方法更容易出错，因此如果不需要这些详细信息，建议使用 Ping 方法。

示例代码

<?php
require __DIR__ . '/vendor/autoload.php';

use xPaw\MinecraftQuery;
use xPaw\MinecraftQueryException;

$Query = new MinecraftQuery();

try {
    $Query->Connect('localhost', 25565);
    print_r($Query->GetInfo());
    print_r($Query->GetPlayers());
} catch (MinecraftQueryException $e) {
    echo $e->getMessage();
}
?>

旧版本服务器（1.6 及以下）

对于 Minecraft 1.6 及以下版本的服务器，使用 QueryOldPre17 方法：

$Query = new MinecraftPing('localhost', 25565);
print_r($Query->QueryOldPre17());

Bedrock 服务器（MCPE）

对于 Bedrock 服务器，使用 ConnectBedrock 方法：

$Query->ConnectBedrock('localhost', 19132);
print_r($Query->GetInfo());

3. 项目 API 使用文档

MinecraftPing 类

• __construct(string $host, int $port = 25565, int $timeout = 2, bool $resolveSRV = true)

  • 构造函数，初始化 MinecraftPing 对象。
  • $host：服务器地址。
  • $port：服务器端口，默认为 25565。
  • $timeout：超时时间，默认为 2 秒。
  • $resolveSRV：是否解析 SRV 记录，默认为 true。

• Query(): array

  • 查询服务器的基本信息。

• QueryOldPre17(): array

  • 查询 Minecraft 1.6 及以下版本服务器的基本信息。

• Close(): void

  • 关闭连接。

MinecraftQuery 类

• Connect(string $host, int $port = 25565, int $timeout = 2): void

  • 连接到 Minecraft 服务器。

• ConnectBedrock(string $host, int $port = 19132, int $timeout = 2): void

  • 连接到 Bedrock 服务器。

• GetInfo(): array

  • 获取服务器的详细信息。

• GetPlayers(): array

  • 获取服务器上的玩家列表。

4. 项目安装方式

使用 Composer

composer require xpaw/php-minecraft-query

手动安装

1. 下载库文件。
2. 将库文件放置在您的项目目录中。
3. 在您的 PHP 文件中包含库文件：

require __DIR__ . '/path/to/library/src/MinecraftPing.php';
require __DIR__ . '/path/to/library/src/MinecraftPingException.php';

通过以上步骤，您可以成功安装并使用 PHP Minecraft Query 库来查询 Minecraft 服务器的信息。