Colorful Logger Lib

模组

· 作者 handsome-steve

本库旨在简化 Minecraft 模组开发工作流中的特定环节,让你能轻松在 Logger 调用中添加 ANSI 颜色。

0 本站下载 0 关注 更新于 2 年前

最新 2.2.1 · 1.21.6 · Fabric

一键开服(送7天)

banner

是否希望在开发 Minecraft 模组时,以简单且实用的方式为你的 LOGGER 增添色彩?

那就无需再寻找了,Handsome Steve 为你准备好了!这个简单的库通过利用一系列预定义的 ANSI 代码,让你轻松实现这一功能。

编辑说明:请优先使用 Handsome Steve Maven,因为它同时也提供 JAR 包的源码文件。 另外,为了以防 Maven 服务不可用,下面的安装代码已更新为反映 Modrinth Maven,对此带来的任何不便深表歉意。

常见问题 (FAQ)

问:这是一个模组吗?
严格来说不是。这是一个库(Library),因此它主要是在开发模组时使用;但是,当依赖此库的模组安装在客户端或服务器上时,根据该模组针对的平台以及开发者如何使用该库,它可能会作为依赖项被需要。

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

问:这个库是否需要特定的 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}/

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

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源