• 简体中文版
• 繁體中文版
• English version

Log Sifter - 过滤掉烦人且无害的日志

一、简介

Log Sifter 是一个为 Minecraft 设计的模组（内部开发代号：Plana-01），专门用于过滤和屏蔽游戏运行过程中产生的冗余日志信息。该模组基于 NeoForge 平台开发，通过自定义配置规则，帮助用户减少日志文件中的噪音，使重要信息更加清晰可见。

二、主要特性

• 日志过滤：通过配置文件定义规则来屏蔽特定的日志输出
• 正则表达式支持：支持使用正则表达式精确匹配日志内容
• 动态配置：支持在运行时加载和应用过滤规则
• 轻量级设计：不修改游戏核心功能，仅专注于日志管理

三、安装指南

3-1：前提条件

• 已安装支持的 Minecraft 版本（1.21.1）
• 已安装对应版本的 NeoForge（21.1.200或更高版本）

3-2：安装步骤

1. 从项目的 Release 页面 下载最新版本
2. 将模组文件放入客户端（或者服务器）的 mods 文件夹中
3. 启动游戏，模组会在 config 目录下自动生成默认配置文件
4. 根据需要编辑配置文件
5. 重启服务器使更改生效
6. 享受 Log Sifter 带来的干净的控制台和日志

四、配置文件

配置文件位于 config 目录下，名称为 log_sifter.toml。该文件使用 TOML 格式进行配置，以下是一个示例配置文件：

# Log Sifter 默认配置文件（Log Sifter Default Configuration）

# 屏蔽规则 - 完全阻止匹配的日志输出（Suppress Rules - Completely prevent matching log output）
# 每一条[[suppress.rule]]表示一条屏蔽规则（Each [[suppress.rule]] represents one suppress rule）
# 格式:（Format:）
# logger: 日志来源（logger: Log source）
# message: 消息匹配，可以是文本或正则表达式（message: Message, can be text or regex）
# is_regex: 是否为正则表达式，默认为false（is_regex: Whether it is a regular expression, default is false）
[suppress]

[[suppress.rule]]
logger = "net.minecraft.world.item.crafting.RecipeManager"
message = "Parsing error loading recipe .*"
is_regex = true

[[suppress.rule]]
logger = "net.minecraft.advancements.AdvancementTree"
message = "Couldn't load advancements: .*"
is_regex = true

五、从源代码构建

如果你想从源代码构建插件，你需要 Java Development Kit (JDK) 21 或更高版本。

5-1：构建步骤

1. 克隆仓库：git clone https://github.com/MC-Nirvana/Log-Sifter.git
2. 进入仓库目录：cd Log-Sifter
3. 执行构建命令：./gradlew build
4. 在 build/libs/ 目录下找到生成的 JAR 文件

5-2：开发环境设置

• 推荐使用 IntelliJ IDEA 进行开发
• 导入项目后，确保 Gradle 依赖能够正确下载

六、贡献与支持

欢迎通过 GitHub Issues 提交 Bug 报告和功能建议

6-1：贡献方式

• 提交代码改进和新功能实现
• 完善文档和翻译
• 报告 Bug 和安全问题
• 参与讨论和提供使用反馈

6-2：提交 Pull Request 的最佳实践

1. Fork 项目并创建功能分支
2. 编写清晰的提交信息
3. 确保代码符合项目编码规范
4. 添加相应的测试用例
5. 保持 Pull Request 聚焦于单一功能或修复

6-3：开发者资源

• 项目遵循标准的 Git 工作流
• 请在提交 Pull Request 前确保代码通过所有测试
• 保持代码风格一致，参考现有代码结构

七、项目路线图

• 添加修改日志级别功能

八、许可证

本项目采用 GPL-3.0 license 开源许可证

九、支持与反馈

如果你喜欢这个项目，请考虑：

• 给项目点个 Star ⭐
• 在社交媒体上分享这个项目
• 参与项目讨论，提供宝贵意见

十：赞助支持

如果你希望支持本项目的持续开发和维护，可以通过以下方式赞助：

• 面包多 - 通过面包多赞助（适用于中国大陆地区用户）
• PayPal - 通过 PayPal 赞助（适用于海外用户）

您的赞助将用于：

• 维护项目基础设施
• 请作者去码头整点薯条:)

十一：官方社区

• QQ
• Discord