LocaleLib - 本地化显示插件

向玩家发送包含任意 Bukkit Material、EntityType 或 Enchantment 的消息，这些内容将被自动翻译成目标客户端使用的语言。从南非荷兰语和阿尔巴尼亚语，到威尔士语和约鲁巴语——打破语言壁垒从未如此简单！

如需使用指南和示例，请访问 Wiki！

❓这是什么？

LanguageUtils 是一个轻量级、无依赖的 Bukkit/Spigot/Paper 插件，它允许服务器向玩家发送包含游戏内物品、实体、附魔等键名的消息，并让这些内容在玩家的客户端上以其本地语言显示。

✨功能特性

• 自动将 Bukkit Material、EntityType、Enchantment 等键名翻译成玩家客户端的语言。
• 支持所有 Minecraft 官方语言（超过 100 种）。
• 无需依赖其他插件或外部 API。
• 轻量高效，对服务器性能影响极小。
• 提供简单的 API，便于开发者集成。

🔧如何使用

基本用法

在您的插件中，使用 LanguageUtils 提供的工具类来包装需要翻译的文本。

命令与权限

插件本身不提供玩家命令，主要面向开发者通过 API 调用。

开发者集成

• 将 LanguageUtils 作为依赖添加到您的插件中。
• 在您的代码中调用 LanguageUtils.getInstance().getComponent(...) 等方法来获取可翻译的文本组件。
• 将生成的组件发送给玩家。

详细 API 文档和代码示例，请参阅 GitHub Wiki。

💡注意事项

• 此插件仅翻译游戏内固有的键名（如 minecraft:stone、minecraft:creeper、minecraft:sharpness）。对于自定义文本、聊天内容或插件消息的翻译，您需要其他解决方案。
• 翻译质量取决于 Minecraft 客户端本身的本地化文件。

🎮推荐搭配

如果您希望翻译服务器中的其他所有文本（如插件消息、菜单、GUI 等），我们推荐搭配使用 Languagy 插件。

要使用此库，请将 LocaleLib 的 jar 文件添加到你的 Java 构建路径中，或通过 CodeMC 将其作为 Maven 依赖引入。

💡添加依赖

通过 Maven 添加

在你的 pom.xml 文件中添加以下仓库和依赖配置：

<repositories>
    <repository>
        <id>codemc-repo</id>
        <url>https://repo.codemc.io/repository/maven-public/</url>
    </repository>
</repositories>

<dependency>
    <groupId>me.pikamug.localelib</groupId>
    <artifactId>LocaleLib</artifactId>
    <version>4.0.0</version>
</dependency>

在 plugin.yml 中声明

接下来，在你的 plugin.yml 文件中将 LocaleLib 添加为依赖（如果插件可以独立运行，也可设为软依赖）：

depend: [LocaleLib]

🔧获取 LocaleManager 实例

方式一：作为外部依赖使用

如果你的插件需要 LocaleLib 作为前置插件，请在 onEnable() 方法中获取 LocaleManager 实例：

private LocaleManager localeManager;

@Override
public void onEnable() {
    LocaleLib localeLib = (LocaleLib) getServer().getPluginManager().getPlugin("LocaleLib");
    if (localeLib != null) {
        localeManager = localeLib.getLocaleManager();
    }
}

方式二：作为内嵌库使用

如果你将 LocaleLib 内嵌（Shading）到你的插件资源中（请注意遵守其许可证），可以直接实例化 LocaleManager：

private LocaleManager localeManager = new LocaleManager();

🎮使用示例

以下是一个向玩家发送消息的简单示例

org.bukkit.entity.Player p = Bukkit.getPlayer("PikaMug");
localeManager.sendMessage(p, "I make " + ChatColor.GREEN + "<item>" + ChatColor.RESET + " look good", Material.DIRT, (short) 0, null);

❓更多信息

• 如需查看更多示例和详细文档，请访问 官方 GitHub Wiki。