FailureToLog api

FailureToLog api

FailureToLog API Fabric 是 FailureToLog Paper 服务端插件的客户端配套模组。

管理

FailureToLog api预览查看大图

FailureToLog API Fabric

FailureToLog API Fabric 是 FailureToLog Paper 服务器插件的客户端配套模组。

它帮助 FailureToLog 服务器获取更有用的客户端断开连接信息。当玩家断开连接或看到错误画面时，该模组可以保存画面显示的原因，并将其发送到兼容的服务器，以便管理员通过服务器插件的日志查看器进行检查。

功能

  • 通过自定义插件消息握手检测支持 FailureToLog 的服务器。
  • 在客户端捕获 Minecraft 断开连接画面的标题和原因。
  • 在可能的情况下，将客户端断开连接的详细信息发送到服务器插件。
  • 支持延迟发送（在下次连接时发送），这是推荐模式。
  • 添加 Mod Menu 配置界面，用于更改发送时机。
  • 默认用户界面语言为英语。

要求

客户端

  • Minecraft 26.1.2
  • Fabric Loader 0.19.2 或更新版本
  • Fabric API
  • 可选：Mod Menu，用于游戏内配置界面

服务器

要获得完整功能，服务器必须运行：

  • Paper 26.1.2
  • FailureToLog Paper 插件

该模组可以在没有服务器插件的情况下安装，但仅当服务器支持 FailureToLog 插件消息通道时才会发送报告。

安装

客户端安装

  1. 为 Minecraft 26.1.2 安装 Fabric Loader。
  2. 安装 Fabric API。
  3. 将该模组的 jar 文件放入客户端 mods 文件夹。
  4. 可选：安装 Mod Menu 以便从 Mods 菜单打开配置界面。

典型客户端 mods 文件夹：

%APPDATA%\.minecraft\mods

服务器安装

  1. 停止 Paper 服务器。
  2. 将 FailureToLog Paper 插件 jar 文件放入服务器 plugins 文件夹。
  3. 启动服务器。
  4. 服务器插件将自动创建其配置和日志文件。

配置

客户端配置文件位于：

config/failure-to-log-api-fabric/client.properties

典型的完整 Windows 路径：

%APPDATA%\.minecraft\config\failure-to-log-api-fabric\client.properties

发送时机

该模组支持两种错误日志发送时机模式。

下次连接时发送

推荐。

模组将断开连接报告存储在本地，并在玩家下次连接到同一支持 FailureToLog 的服务器时发送。

这是最安全的模式，因为一旦客户端断开连接，网络连接可能已经关闭。

配置值：

send-timing=next_connection

断开连接后立即发送

模组尝试在断开连接后立即发送报告。

这可能会失败，因为当断开连接画面出现时，连接可能已经关闭。如果发送失败，模组会将报告保存下来，在下次连接时发送。

配置值：

send-timing=after_disconnect

待发送报告存储

当使用推荐的"下次连接"模式时，待发送的客户端报告存储于：

config/failure-to-log-api-fabric/pending-client-log.properties

典型的完整 Windows 路径：

%APPDATA%\.minecraft\config\failure-to-log-api-fabric\pending-client-log.properties

该文件在报告成功发送到匹配的服务器后会被删除。

Mod Menu

如果安装了 Mod Menu，打开：

Mods -> FailureToLog API Fabric -> 配置

配置界面允许玩家更改：

  • 错误日志发送时机

界面还会显示警告信息：

推荐：下次连接时发送。断开连接后立即发送可能会失败，因为网络连接可能已经关闭。

服务器插件集成

该模组使用以下自定义负载通道与 FailureToLog Paper 插件通信：

failuretolog:hello
failuretolog:client_log

流程：

  1. 玩家加入服务器。
  2. 服务器发送 failuretolog:hello。
  3. 客户端将该服务器标记为 FailureToLog 兼容。
  4. 客户端在发生错误时捕获断开连接画面信息。
  5. 客户端通过 failuretolog:client_log 发送保存的报告。
  6. 服务器存储报告并广播一条可点击的错误日志消息。

服务器命令

服务器插件提供以下命令：

/failuretolog toggle
/failuretolog savelogs <on|off>
/failuretolog codes
/failuretolog log <id>

别名：

/ftl

重要限制

Minecraft 客户端在网络连接完全关闭后无法向服务器发送数据。

因此，推荐模式是"下次连接时发送"。在此模式下，模组会将错误报告保存在本地，并在玩家重新连接到同一支持 FailureToLog 的服务器时发送。

此模组不会将报告上传到任何外部网络服务。报告仅通过 Minecraft 网络发送到兼容的 FailureToLog 服务器。

隐私说明

客户端报告可能包含：

  • 断开连接画面标题
  • 断开连接原因
  • Minecraft 版本
  • 玩家名称
  • 服务器地址
  • FailureToLog 协议/插件版本
  • 时间戳

此模组不会故意收集完整的本地游戏日志或崩溃报告。

推荐平台描述

简短描述：

FailureToLog 服务器的客户端配套模组。捕获断开连接画面详细信息并发送到服务器插件，以便更轻松地进行错误诊断。

详细描述：

FailureToLog API Fabric 是 FailureToLog Paper 服务器插件的客户端配套模组。

当玩家断开连接或看到错误画面时，模组会捕获断开连接画面的标题和原因。如果服务器支持 FailureToLog，报告可以发送到服务器插件，并通过插件的错误日志命令供管理员查看。

推荐的发送模式是"下次连接时发送"，该模式会将报告存储在本地，并在玩家重新连接到同一服务器时发送。这避免了客户端在连接已关闭后无法再发送数据包的常见问题。

支持 Mod Menu 以更改客户端发送时机。

建议标签

  • Fabric
  • 客户端
  • 实用工具
  • 服务器工具
  • 管理工具
  • 日志记录
  • 调试
  • Paper 集成

构建输出

集成构建产物被复制到：

C:\Users\musek\IdeaProjects\dist

Fabric 模组 jar：

FailureToLog-API-Fabric-1.0.0.jar

Paper 插件 jar：

FailureToLog-Paper-1.0-SNAPSHOT.jar

运行集成构建脚本：

C:\Users\musek\IdeaProjects\build-all-failure-to-log.bat