Hey Wiki

Эй, Вики

Hey Wiki — это клиентский мод, созданный сообществом Minecraft Wiki](https://minecraft.wiki), который позволяет нажимать H ( настраиваемый) чтобы открыть вики-страницу блока, предмета или сущности, на которую вы нацеливаетесь, будь то из ванили или мода. Привет, Wiki поддерживает Fabric и NeoForge.

Особенности

• Нажмите H (настраиваемый), чтобы открыть вики-страницу (Minecraft Wiki или соответствующий мод вики) Эффект блока/предмета/сущности/статуса, на который вы целитесь или наводите курсор.
• Нажмите Alt+H или Opt+H, чтобы открыть вики-страницу предмета в вашей основной руке.
• Нажмите B, чтобы открыть экран поиска вики. Вы можете искать вики-страницы, введя в строку поиска.
• Добавляет несколько команд .
• Ссылка на вики-страницу в чате с использованием синтаксиса [[wiki link]].

Также поддерживается использование MCBrowser и MCEF] для просмотра в игре.

~~Я не знал, что этот мод похож на Lexica Botania, но это так.~~

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

Как использовать

1. Установите мод. Вы можете скачать его с Modrinth. Не забудьте установить зависимости.
2. Наведите курсор на блок/объект или наведите курсор на предмет в инвентаре.
3. Нажмите сочетание клавиш (по умолчанию H).
4. Либо подтвердите действие, либо скопируйте ссылку в буфер обмена на появившемся экране.

Конфигурация

При желании вы можете изменить это поведение в меню конфигурации:

[!СОВЕТ] Вам необходимо установить Mod Menu, чтобы получить доступ к меню конфигурации в Fabric.

• Если для открытия вики-страницы требуется подтверждение: по умолчанию установлено значение true.
• Если для открытия вики-страницы требуется подтверждение при использовании команды : по умолчанию — false
• Какой язык вики вы предпочитаете, вместо языка игры: по умолчанию используется язык вашей игры.
• (Для китайских пользователей) Какой вариант китайского языка вы предпочитаете, вместо языка игры: по умолчанию используется язык игры.
• Сочетание клавиш для открытия вики-страницы: по умолчанию — H.
• Расстояние досягаемости: по умолчанию составляет 5,2 блока (так же, как и в творческом режиме).
• Разрешено ли вам искать жидкость: по умолчанию установлено значение false. — Добавлять ли всплывающую подсказку к предметам в инвентаре, которые можно найти: по умолчанию — true.

Команды

Доступны следующие команды:

• /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=%2Fgive
  • Псевдоним: /whatcmd
• /whatisthis - Открывает страницу Minecraft Wiki блока/предмета/объекта, на который вы целитесь.
• /whatisthisitem - Открывает страницу Minecraft Wiki предмета, который вы держите в основной руке.
  • whatisthisitem offhand - То же, но для навскидки.
• /whatversion — Открывает страницу Minecraft Wiki текущей версии игры.
  • Пример: /whatversion -> https://minecraft.wiki/w/Java_Edition_1.21.5.

Обратите внимание: если вы откроете страницу с командой, экран подтверждения не появится.

[[Wiki links]] в чате

Эй, Wiki поддерживает [[wiki links]] в чате. Когда вы отправляете сообщение с синтаксисом [[wiki link]], Hey Wiki заменит это с кликабельной ссылкой. Имя страницы может включать пространство имен.

Это также поддерживает ссылки на интервики. Например:

• [[aether:lore]] будет ссылаться на страницу «знаний» Aether Wiki (интервики)
• [[en:enderman]] будет ссылаться на английскую страницу Minecraft Wiki «Эндермен» (межъязыковая версия)
• [[minecraft:en:enderman]] будет ссылаться на английскую страницу Minecraft Wiki «Эндермена» (интервики и межъязыковый язык)

Поддерживаемые вики

В настоящее время Hey Wiki поддерживает следующие вики:

• Minecraft Wiki
• Эфир Wiki
• Меканизм Wiki
• Сумеречный лес Wiki
• Прикладная энергетика 2 Wiki
• Лаборатории Звездной Пыли Wiki
• Создать Wiki
• Пейзаж Бездны Wiki
• Advent of Ascension Wiki
• Doggy Talents Next Wiki
• Эндертек Бесконечность Wiki
• Marvel Superheroes Mod Wiki
• BlockFront Wiki
• Cobblemon Wiki

Если вы хотите добавить поддержку других вики, вы можете сообщить о проблеме. Кроме того, вы также можете добавить поддержку других вики, используя пакет ресурсов.

API

Ресурсный пакет

[!ПРИМЕЧАНИЕ] Этот API стабилен начиная с версии 1.6.0.

Hey Wiki поддерживает использование пакета ресурсов для добавления поддержки других вики. Для этого создайте файл JSON в папке Папка assets/<namespace>/wiki_family/ в вашем пакете ресурсов следующего формата:

{
  // The namespaces that is bound to the wiki family
  "namespace": [
    "minecraft"
  ],
  // List of different language wikis
  "wikis": [
    {
      // The URL pattern for articles. %s will be replaced with the query
      "article_url": "https://minecraft.wiki/?search=%s",
      // (Optional) If the wiki is a MediaWiki wiki, the API URL
      "mw_api_url": "https://minecraft.wiki/api.php",
      // (Optional) The URL pattern for searching. %s will be replaced with the query.
      "search_url": "https://minecraft.wiki/?search=%s",
      // (Optional) The page name for the random article
      "random_article": "Special:RandomRootPage/Main",
      // (Optional) How Hey Wiki should fetch excerpts from the wiki. Either "text_extracts" or "none".
      // "text_extracts" only works for MediaWiki sites with the TextExtracts and PageImages extension installed. You can check this by visiting Special:Version on the wiki.
      "excerpt": "text_extracts",
      // (Optional) Which provider to use for autocompleted search. Either "mediawiki" or "algolia".
      "search_provider": "mediawiki",
      // (Optional) If you use algolia as search provider, you MUST fill out the following fields
      "algolia": {
        "api_url": "https://example-dsn.algolia.net/",
        "index_name": "example",
        "api_key": "efcc14a8c70a1489d18cfd565cce53ca",
        "app_id": "9957A67102"
      },
      "language": {
        // The language code of the wiki
        "wiki_language": "en",
        // Whether this is the main language. If true, this language will be fallback if no other language matches
        "main": true,
        // The default in-game language that the wiki supports. This will be fallback if the in-game language is not supported by the wiki
        "default": "en_us",
        // If the regex matches the in-game language, this wiki will be used when config is auto
        "regex": "^en_.*",
        // (Optional) Ditto, but for exclusion
        "exclude": null,
        // (Optional) A custom language code that allows you to override translation keys to specific pages. A translation file should exist at assets/<namespace>/lang/<lang_override>.json
        "lang_override": "minecraft_en"
      }
    },
    {
      // Another language
      "article_url": "https://de.minecraft.wiki/?search=%s",
      "language": {
        "wiki_language": "de",
        "default": "de_de",
        "regex": "^de_.*",
        "exclude": null
      }
    }
  ]
}

Вы также хотите включить файл перевода в папку assets/<namespace>/lang/ в следующем формате:

{
  // Assuming the definition is located at `assets/heywiki/wiki_family/minecraft.json`
  "wiki_family.heywiki.minecraft": "Minecraft Wiki"
}

Пользовательский элемент через компонент данных или NBT

[!ВНИМАНИЕ] Этот API является экспериментальной функцией и может измениться в любое время.

Авторы пакетов данных и пользовательских серверов могут использовать heywiki:identifier, heywiki:translation_key и heywiki:fallback_title в компоненте custom_data, чтобы предоставить собственное пространство имен и имя для элемента. Однако это только счета для пользовательских элементов. В версии 1.20.4 вы можете заполнить эти поля непосредственно в NBT.

Вам необходимо использовать описанный выше метод, чтобы зарегистрировать новую вики с собственным пространством имен с использованием пакета ресурсов. Если это не Если вы можете попросить своих игроков загрузить пакет ресурсов, мы также можем отправить его вместе с самим модом.

Например, на «niceserver», чтобы костный элемент можно было разрешить на странице «Детализация», вам сначала необходимо зарегистрироваться. пространство имен «niceserver», как указано выше. Затем вы можете дать игроку этот предмет:

1.21:

/give @s minecraft:bone[minecraft:custom_data={"heywiki:identifier": "niceserver:drill", "heywiki:fallback_title": "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 API: предоставляет базовые утилиты для моддинга.
• (Обязательно) Архитектурный API: для совместимости с несколькими модлоадерами.
• (Обязательно) Cloth Config: для настройки
• (Рекомендуется) Mod Menu: для доступа к меню конфигурации.
• (Необязательно) MCBrowser и MCEF: для внутриигрового браузера.
• (Необязательно) REI/EMI/JEI: поддерживается интеграция)

Для НеоФорджа:

• (Обязательно) Архитектурный API: для совместимости с несколькими модлоадерами.
• (Обязательно) Cloth Config: для настройки
• (Необязательно) REI/EMI/JEI: поддерживается интеграция)

Управление версиями

Эй, Вики

Эй, Wiki сама следует за Semantic Versioning. Номер версии имеет формат <major>.<minor>.<patch>[-<prerelease>]. Номер версии увеличивается на основе следующих правил:

• Основной: увеличивается при внесении критических изменений в стабильный общедоступный API.
• Незначительное: увеличивается, когда в стабильный общедоступный API добавляются новые функции с обратной совместимостью.
• Патч: увеличивается при исправлении ошибок.

Майнкрафт

Hey Wiki поддерживает несколько версий Minecraft.

Каждой версии Minecraft присвоен статус поддержки:

• Активно: в этой версии добавлены новые функции и исправлены ошибки. Функции будут перенесены настолько, насколько это разумно. возможно.
• Обслуживание: в эту версию включены только исправления ошибок и исправления безопасности. Функции обычно не передаются обратно.
• Конец жизни (EOL): дальнейших обновлений ожидать не следует.

Текущая версия Minecraft и основные ветки всегда активны. Запросы на извлечение почти всегда должны идите в master. Если они приняты, их следует отобрать в другие активные ветки.

При выпуске нового снимка ветка master обновляется до этого снимка. Снимки могут иметь только одну версию или нет версия вообще. Для снимков поддерживается только Fabric.

Старым версиям Minecraft предоставляется долгосрочная поддержка (LTS) в зависимости от их популярности и интереса сообщества. Версии LTS сначала получают активную поддержку. Через некоторое время они будут переведены в статус «Техническое обслуживание». Старые снимки не поддерживаются.

В следующей таблице показано, какие версии поддерживаются:

| Ветка Git | Версия Майнкрафта | Поддерживается? | ЛТС? | Модлоадер | |-------------|----------------------|-------------------|---------|------------------| | master | 1.21.7 | Активный (Последний) | ? | Ткань, Неофорж | | mc/1.21.5 | 1.21.5 | ЭОЛ | Нет | Ткань, Неофорж | | mc/1.21.4 | 1.21.4 | ЭОЛ | Нет | Ткань, Неофорж | | mc/1.21.3 | 1.21.2, 1.21.3 | ЭОЛ | Нет | Ткань, Неофорж | | mc/1.21.1 | 1.21, 1.21.1 | Активный (LTS) | Да | Ткань, Неофорж | | mc/1.20.6 | 1.20.6 | ЭОЛ | Нет | Ткань, Неофорж | | mc/1.20.5 | 1.20.5 | ЭОЛ | Нет | Ткань, Неофорж | | mc/1.20.4 | 1.20.4 | Техническое обслуживание (LTS) | Да | Ткань, Неофорж | | Н/Д | Устаревшие снимки | ЭОЛ | Нет | Ткань |