Colorful Logger Lib

Добавьте цвета в ваши логи разработки Minecraft модов

Хотите сделать процесс отладки и разработки модов для Minecraft более наглядным и удобным? Эта библиотека позволяет легко добавлять цветное форматирование к вашим лог-сообщениям с использованием стандартных ANSI кодов.

Часто задаваемые вопросы

Вопрос: Это полноценный мод?
Нет, это библиотека для разработчиков. Она используется при создании модов и может потребоваться как зависимость при установке мода на клиенте или сервере, в зависимости от того, как разработчик использует библиотеку.

Вопрос: Можно ли использовать эту библиотеку в своем проекте?
Конечно! Вы можете свободно интегрировать ее в свои разработки.

Вопрос: Требуется ли определенная версия Fabric?
Библиотека работает независимо от версии, главное чтобы ваша платформа моддинга поддерживала org.slf4j.Logger.

Текущая функциональность

На данный момент реализована цветная обработка только для метода Logger.info(). В будущих обновлениях планируется добавить поддержку других методов, таких как Logger.error() и других.

Установка

Добавьте необходимые Maven репозитории в раздел repositories вашего build.gradle:

repositories {
    // Основной репозиторий
    exclusiveContent {
        forRepository {
            maven {
                name = "Handsome Steve's Maven"
                url = "https://maven.handsomesteve.net/releases"
            }
        }
        filter {
            includeGroup "net.handsomesteve"
        }
    }

    // Резервный репозиторий Modrinth
    exclusiveContent {
        forRepository {
            maven {
                name = "Modrinth"
                url = "https://api.modrinth.com/maven"
            }
        }
        filter {
            includeGroup "maven.modrinth"
        }
    }
}

Добавьте зависимость в раздел dependencies вашего build.gradle:

dependencies {
    // Библиотека Colorful Logger
    implementation include("net.handsomesteve:colorfulloggerlib:${project.hs_colorful_logger}")

    // Резервный вариант (раскомментируйте если основной репозиторий недоступен)
    //implementation include ("maven.modrinth:colorfulloggerlib:${project.hs_colorful_logger}")
    // ИСХОДНЫЙ КОД ТРЕБУЕТ РУЧНОЙ ЗАГРУЗКИ ПРИ ИСПОЛЬЗОВАНИИ РЕЗЕРВНОГО РЕПОЗИТОРИЯ
}

Добавьте переменную версии в ваш gradle.properties, заменив {version} на желаемую версию библиотеки:

hs_colorful_logger={version}

Использование

Создайте public static final экземпляр класса ColorfulLogger. Этот экземпляр позволит вам использовать внутреннюю ссылку на org.slf4j.Logger из класса ColorfulLogger во всем вашем проекте.

import net.handsomesteve.api.ColorfulLogger;
import net.handsomesteve.api.ansi.AnsiColorBackground;
import net.handsomesteve.api.ansi.AnsiColorText;

public class FabricMod implements ModInitializer {
    public static final String MOD_ID = "your-mod-id";
    public static final ColorfulLogger LOGGER = ColorfulLogger.getInstance("your-mod-id", false);

   @Override
   public void onInitialize() {
       LOGGER.info(">> Это обычное сообщение без цветов");
       LOGGER.info(">> Я хочу зеленый текст", AnsiColorText.ANSI_BRIGHT_GREEN);
       LOGGER.info(">> Я хочу красный текст с черным фоном", AnsiColorText.ANSI_BRIGHT_RED, AnsiColorBackground.ANSI_BLACK_BACK);
   }
}

При необходимости, с Logger можно работать напрямую:

LOGGER.getLogger(); // Возвращает Logger для прямого взаимодействия

Однако при таком подходе ANSI цветовое кодирование не будет применяться к вашему выводу.

ПРИМЕЧАНИЕ: Переменная ColorfulLogger может быть объявлена в любом месте проекта. Рекомендуется объявлять ее только один раз, так как это синглтон.

Чтобы импортировать объявленную переменную как статический импорт при ссылке на переменную:

import static com.packagename.FabricMod.LOGGER;

АЛЬТЕРНАТИВНО: ColorfulLogger может быть создан в любом месте проекта после объявления синглтона:

public class References {
    private static final ColorfulLogger LOGGER = ColorfulLogger.getInstance();

    public static ColorfulLogger getLogger() {
        return LOGGER;
    }
}

Затем доступ:

import static com.package.References.getLogger;

public class MyClass {
    References.getLogger();
}

Исходный код

[Только при использовании Modrinth Maven как зависимости]

Файл с исходным кодом доступен в загрузках версий.

Это хорошо документированный файл с исходным кодом, где все переменные, методы и конструкторы четко определены, как и сам класс. Вам следует скачать и добавить этот файл по пути:

.gradle/loom-cache/remapped_mods/net_fabricmc_yarn{version}/maven/colorfulloggerlib/{hs_colorful_logger_version}/

Примечание: Замените текст в фигурных скобках на текущие версии и т.д.