彩色日志库

彩色日志库

该库旨在简化Minecraft模组开发工作流中的特定环节,使为Logger调用添加ANSI颜色变得简便。

基础库

banner





是否曾希望在开发 Minecraft 模组期间,以一种简单而实用的方式为你的 LOGGER 增添一些色彩?

无需再寻找,Handsome Steve 已经为你准备好了!这个简单的库通过利用大量预定义的 ANSI 代码,让你能够实现这一目标。

编辑:请优先使用 Handsome Steve Maven,因为该仓库同时提供 Jar 的源码文件。 或者,下方的安装代码已更新为反映 Modrinth Maven,以防该 Maven 仓库偶尔离线,为此带来的任何不便敬请谅解。

常见问题

问:这是一个模组吗?
严格来说,不是。这是一个库,因此它实际上只在开发模组时使用。不过,根据依赖模组所面向的平台以及模组开发者使用该库的方式,当依赖模组安装到客户端/服务器时,它可能会被要求作为依赖项。

问:我可以在我的项目中将此库用作依赖项吗?
当然可以,尽情使用吧!

问:此库需要特定的 Fabric 版本吗?
不需要,它现在是独立的,因此只要你的模组平台使用 org.slf4j.Logger,无论版本如何都能正常工作。

当前版本

请注意,当前版本仅对 Logger.info() 方法进行了着色,其余方法(如 Logger.error() 等)将在未来更新中添加。

安装

将所需的 Maven 仓库添加到 build.gradle 的 repositories 部分:

    repositories {
        // 初始 Maven 仓库
        // 优先
        exclusiveContent {
            forRepository {
                maven {
                    name = "Handsome Steve's Maven"
                    url = "https://maven.handsomesteve.net/releases"
                }
            }
            filter {
                includeGroup "net.handsomesteve"
            }
        }
        
        // Modrinth 备用 Maven
        // 可选,但强烈推荐
        exclusiveContent {
            forRepository {
                maven {
                    name = "Modrinth"
                    url = "https://api.modrinth.com/maven"
                }
            }
            filter {
                includeGroup "maven.modrinth"
            }
        }
    }


在 build.gradle 的 dependencies 部分添加一个 implementation:

    dependencies {
        //Handsome Steve's Colorful Logger // 这会自动下载源码文件。
        implementation include("net.handsomesteve:colorfulloggerlib:${project.hs_colorful_logger}")
        
        // Modrinth 备用(如果首选 maven 不可用,请取消注释)。
        //implementation include ("maven.modrinth:colorfulloggerlib:${project.hs_colorful_logger}")
        // 源码文件需要手动下载,请参阅页面底部(如果使用备用 maven)。
    }


将版本变量添加到 gradle.properties,并将 {version} 替换为你选择的可用库版本:

    hs_colorful_logger={version}

实现

创建一个 public static final 的 ColorfulLogger 类实例。该实例允许你在整个项目中使用 ColorfulLogger 类内部对 org.slf4j.Logger 的引用。

    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(">>> This is a plain message without any colouring");
           LOGGER.info(">>> I want some green text", AnsiColorText.ANSI_BRIGHT_GREEN);
           LOGGER.info(">>> I want some red text with a black background", 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}/

注意: 将花括号中的文本替换为当前版本等。