Log Sifter

Log Sifter — отфильтруй надоедливые, но безобидные логи

Ⅰ. Введение

Log Sifter — это мод, созданный специально для серверов и клиентов Minecraft на NeoForge (внутреннее кодовое имя: Arona-02), который фильтрует и блокирует лишнюю информацию в логах, генерируемую игрой. Этот модуль основан на платформе NeoForge и помогает пользователям снизить уровень шума в лог-файлах с помощью настраиваемых правил конфигурации, делая важную информацию более заметной и видимой.

II. Основные возможности

• Фильтрация логов: задавайте правила через файлы конфигурации, чтобы блокировать определённые записи в логах
• Поддержка регулярных выражений: точное сопоставление содержимого логов с помощью регулярных выражений
• Динамическая конфигурация: поддержка загрузки и применения правил фильтрации во время работы
• Лёгкий дизайн: не изменяет основные функции игры, занимается только управлением логами

III. Руководство по установке

3-1: Предварительные требования

• Установлена поддерживаемая версия Minecraft (1.21.1)
• Установлена соответствующая версия NeoForge (21.1.200 или выше)

3-2: Шаги установки

1. Скачайте последнюю версию со страницы Release проекта
2. Поместите файл мода в папку mods клиента (или сервера)
3. Запустите игру — мод автоматически создаст файл конфигурации по умолчанию в директории config
4. Отредактируйте файл конфигурации по необходимости
5. Перезапустите сервер, чтобы применить изменения
6. Наслаждайтесь чистым консольным выводом и логами, которые дарит Log Sifter

IⅤ. Сборка из исходного кода

Если вы хотите собрать плагин из исходного кода, вам понадобится Java Development Kit (JDK) 21 или выше.

4-1: Шаги сборки

1. Клонируйте репозиторий: git clone https://github.com/MC-Nirvana/log-sifter.git
2. Перейдите в директорию репозитория: cd log-sifter
3. Выполните команду сборки: ./gradlew build
4. Найдите сгенерированный JAR-файл в директории build/libs/

4-2: Настройка среды разработки

• Рекомендуется использовать IntelliJ IDEA для разработки
• После импорта проекта убедитесь, что зависимости Gradle загружаются корректно

V. Вклад и поддержка

Приветствуются сообщения об ошибках и предложения по функционалу через GitHub Issues

5-1: Способы внести вклад

• Отправляйте улучшения кода и реализации новых функций
• Улучшайте документацию и переводы
• Сообщайте об ошибках и проблемах безопасности
• Участвуйте в обсуждениях и делитесь отзывами об использовании

5-2: Лучшие практики для отправки Pull Request

1. Сделайте форк проекта и создайте ветку для новой функции
2. Пишите понятные сообщения коммитов
3. Убедитесь, что код соответствует стандартам проекта
4. Добавьте соответствующие тестовые случаи
5. Держите Pull Request сфокусированным на одной функции или исправлении

5-3: Ресурсы для разработчиков

• Проект следует стандартному рабочему процессу Git
• Перед отправкой Pull Request убедитесь, что код проходит все тесты
• Поддерживайте единый стиль кода, ориентируйтесь на существующую структуру кода

VI. Лицензия

Этот проект использует открытую лицензию MIT

VII. Поддержка и обратная связь

Если вам нравится этот проект, пожалуйста, подумайте о том, чтобы:

• Поставить проекту звезду ⭐
• Поделиться проектом в социальных сетях
• Участвовать в обсуждениях проекта и оставлять ценные отзывы

VIII. Поддержка спонсоров

Если вы хотите поддержать дальнейшую разработку и поддержку этого проекта, вы можете стать спонсором следующими способами:

• ifdian — поддержать через ifdian (подходит для пользователей из материкового Китая)
• PayPal — поддержать через PayPal (подходит для зарубежных пользователей)

Ваша поддержка пойдёт на:

• Поддержание инфраструктуры проекта
• Покупку картошки фри для автора в доке :)

IX. Официальное сообщество

• QQ
• Discord