Hey Wiki

Hey Wiki

Hey Wiki 是由 Minecraft Wiki 制作的客户端模组，允许你按下 H 键（可自定义）打开你所瞄准的方块/物品/实体的 wiki 页面，无论它来自原版还是模组。Hey Wiki 支持 Fabric 和 NeoForge。

功能

• 按下 H 键（可自定义）打开你所瞄准或悬停的方块/物品/实体/状态效果的 wiki 页面（Minecraft Wiki 或对应模组 wiki）。
• 按下 Alt+H 或 Opt+H 打开你主手中物品的 wiki 页面。
• 添加了几个命令。
• 使用 [[wiki link]] 语法在聊天中链接到 wiki 页面。

我之前不知道这个模组有点像 Lexica Botania，但确实如此。

https://github.com/mc-wiki/minecraft-mod-heywiki/assets/45287180/b0650362-1fe9-46ff-83a1-48219d5fcc05

使用方法

1. 安装模组。你可以从 CurseForge 或 Modrinth 下载。别忘了安装依赖项。
2. 用准星瞄准方块/实体，或将指针悬停在物品栏中的物品上。
3. 按下按键绑定（默认：H）。
4. 在弹出的界面中确认操作或将链接复制到剪贴板。

配置

你可以在配置菜单中更改以下行为：

[!TIP] 在 Fabric 上，你需要安装 Mod Menu 才能访问配置菜单。

• 是否需要确认才能打开 wiki 页面：默认为 true
• 你偏好的 wiki 语言，会覆盖你的游戏语言：默认为你的游戏语言
• 打开 wiki 页面的按键绑定：默认为 H
• 触及距离：默认为 5.2 格（与创造模式触及距离相同）
• 是否允许流体：默认为 false

命令

以下命令可用：

• /imfeelinglucky [<namespace>] - 带你去模组决定的任何地方。
  • 示例：/imfeelinglucky minecraft -> https://minecraft.wiki/????????
• /wiki <pageName> - 打开指定页面名称的 Minecraft Wiki 页面。pageName 可以包含命名空间。
  • 示例：/wiki minecraft:creeper -> https://minecraft.wiki/w/?search=creeper
    • 重定向：/whatis
• /whatbiome - 打开你当前所在生物群系的 Minecraft Wiki 页面。
• /whatstructure - 打开你当前所在结构的 Minecraft Wiki 页面。
  • 此命令仅在单人游戏中可用。
• /whatcommand <command> - 打开指定命令的 Minecraft Wiki 页面。
  • 示例：/whatcommand give -> https://minecraft.wiki/w/?search=/give
  • 重定向：/whatcmd
• /whatisthis - 打开你所瞄准的方块/物品/实体的 Minecraft Wiki 页面。
• /whatisthisitem - 打开你主手中所持物品的 Minecraft Wiki 页面。
  • whatisthisitem offhand - 同样，但用于副手。

请注意，如果你通过命令打开页面，将不会出现确认界面。

聊天中的 [[Wiki links]]

Hey Wiki 支持在聊天中使用 [[wiki links]]。当你发送包含 [[wiki link]] 语法的消息时，Hey Wiki 会将其替换为可点击的链接。页面名称可以包含命名空间。

这也支持跨 wiki 链接。例如：

• [[aether:lore]] 将链接到 Aether Wiki 的 "lore" 页面（跨 wiki）
• [[en:enderman]] 将链接到英文 Minecraft Wiki 的 "enderman" 页面（跨语言）
• [[minecraft:en:enderman]] 将链接到英文 Minecraft Wiki 的 "enderman" 页面（跨 wiki 和跨语言）

支持的 wiki

目前，Hey Wiki 支持以下 wiki：

• Minecraft Wiki
• Aether Wiki
• Mekanism Wiki
• The Twilight Forest Wiki
• Applied Energistics 2 Wiki
• Stardust Labs Wiki
• Create Wiki

如果你想添加对其他 wiki 的支持，可以[提交 issue](https://github.com/mc-wiki/minecraft-mod-heywiki/issues/new?labels=new wiki,triage needed&template=new_wiki.yml)。此外，你也可以通过资源包添加对其他 wiki 的支持。

资源包

[!WARNING] 请注意，JSON 模式尚未稳定，也没有按语义化版本管理。我们很可能在次版本中破坏它。

Hey Wiki 支持使用资源包来添加对其他 wiki 的支持。为此，在你的资源包中的 assets/<namespace>/wiki_family/ 文件夹中创建一个 JSON 文件，格式如下：

{
  // wiki 家族的唯一标识符
  "id": "minecraft",
  // 绑定到该 wiki 家族的命名空间
  "namespace": [
    "minecraft"
  ],
  // 不同语言 wiki 的列表
  "wikis": [
    {
      // 文章的 URL 模式。%s 将被替换为查询内容
      "article_url": "https://minecraft.wiki/?search=%s",
      // （可选）如果该 wiki 是 MediaWiki wiki，则为 API URL
      "mw_api_url": "https://minecraft.wiki/api.php",
      // （可选）随机文章使用的页面名称
      "random_article": "Special:RandomRootPage/Main",
      // （可选）Hey Wiki 如何从 wiki 获取摘要。可以是 "text_extracts" 或 "none"。
      // "text_extracts" 仅适用于安装了 TextExtracts 和 PageImages 扩展的 MediaWiki 站点。你可以通过访问该 wiki 的 Special:Version 来检查。
      "excerpt": "text_extracts",
      "language": {
        // wiki 的语言代码
        "wiki_language": "en",
        // 这是否是主要语言。如果为 true，则在没有其他语言匹配时，将使用此语言作为回退
        "main": true,
        // wiki 支持的默认游戏内语言。如果游戏内语言不受该 wiki 支持，则会使用此作为回退
        "default": "en_us",
        // 如果正则表达式匹配游戏内语言，则当配置为自动时，将使用此 wiki
        "regex": "^en_.*",
        // （可选）同上，但用于排除
        "exclude": null,
        // （可选）自定义语言代码，允许你将翻译键覆盖到特定页面。翻译文件应存在于 assets/<namespace>/lang/<lang_override>.json
        "lang_override": "minecraft_en"
      }
    },
    {
      // 另一种语言
      "article_url": "https://de.minecraft.wiki/?search=%s",
      "language": {
        "wiki_language": "de",
        "default": "de_de",
        "regex": "^de_.*",
        "exclude": null
      }
    }
  ]
}

数据包和自定义服务器支持

数据包和自定义服务器作者现在可以在 custom_data 组件中使用 heywiki:identifier 和 heywiki:translation_key 为物品提供自定义命名空间和名称。但这仅适用于自定义物品。对于 1.20.4，你可以直接在 NBT 中填充这些字段。

你需要使用上述方法通过资源包注册一个带有自定义命名空间的新 wiki。如果要求玩家下载资源包不可行，我们也可以将其与模组本身一起分发。

例如，在 "niceserver" 上，要让一个镐子物品解析到 "Drill" 页面，你首先需要按上述方法注册 "niceserver" 命名空间。然后你可以给玩家这个物品：

1.21：

/give @s minecraft:bone[minecraft:custom_data={"heywiki:identifier": "niceserver:drill", "heywiki:translation_key": "item.niceserver.drill"}]

1.20.4：

/give @s minecraft:bone{"heywiki:identifier": "niceserver:drill", "heywiki:translation_key": "item.niceserver.drill"}

依赖项

Fabric：

• （必需）Fabric API：提供基础的模组工具
• （必需）Architectury API：用于多模组加载器兼容性
• （必需）Cloth Config：用于配置
• （推荐）Mod Menu：用于访问配置菜单
• （可选）Roughly Enough Items (REI)：用于 REI 集成
• （可选）EMI：用于 EMI 集成

NeoForge：

• （必需）Architectury API：用于多模组加载器兼容性
• （必需）Cloth Config：用于配置
• （可选）Roughly Enough Items (REI)：用于 REI 集成
• （可选）EMI：用于 EMI 集成

版本支持

Hey Wiki 支持多个 Minecraft 版本。

当前发布版和 master 分支会获得所有新功能和错误修复。拉取请求几乎总是应该提交到 master。如果被接受，它们应该被移植到当前稳定发布分支。

当新的快照版本发布时，master 分支会更新到该快照。快照版本可能只支持一个版本或根本不支持。快照版本仅支持 Fabric。

一些选定的旧 Minecraft 版本会获得 LTS —— 它们可能不一定获得新的错误修复和新功能，但会获得关键错误修复。不支持旧的快照版本。

下表显示了支持的版本：

Git 分支	Minecraft 版本	支持？	是否为 LTS？	模组加载器
master	1.21	是（最新发布版）	待定	Fabric, Neoforge
mc/1.20.6	1.20.6	否	否	Fabric, Neoforge
mc/1.20.5	1.20.5	否	否	Fabric, Neoforge
mc/1.20.4	1.20.4	是（LTS）	是	Fabric, Neoforge
不适用	过时的快照版本	生命周期结束	否	Fabric