Hey Wiki

Hey Wiki - клиентский мод от сообщества Minecraft Wiki, который решает проблему вечного гугления. Больше не надо выходить из игры, чтобы узнать рецепт крафта или генерацию моба. Просто наведись на блок или существо, нажми H (кнопка настраивается) - и перед тобой откроется нужная страница вики. И неважно, ванильная это штука или из мода.

Фишки

• По дефолту H открывает вики того, на что ты смотришь или наводишь курсор в инвентаре
• Alt+H (на маке Opt+H) сразу открывает вики предмета в основной руке
• B открывает поиск по вики - просто вводи название
• Несколько команд для гиков
• Синтаксис [[ссылка на вики]] работает прямо в чате

Если хочешь смотреть вики прямо в игре, можно подключить MCBrowser или MCEF - оба поддерживаются.

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

1. Скачал мод, не забудь зависимости
2. Наведи прицел на блок/моба или наведи курсор на предмет в инвентаре
3. Нажми H (или как ты переназначил)
4. В появившемся окошке либо подтверди открытие, либо скопируй ссылку

Настройки

Их можно менять в конфиге. Чтобы открыть меню на Fabric, понадобится Mod Menu. Вот что можно настроить:

• Подтверждение перед открытием страницы - по умолчанию да
• Подтверждение при использовании команд - по умолчанию нет
• Язык вики (переопределяет язык игры)
• Для китайцев - вариант китайского языка
• Кнопка открытия - H
• Дистанция, с которой мод видит объекты - по умолчанию 5.2 блока (как в креативе)
• Можно ли смотреть жидкости - по умолчанию нет
• Показывать ли тултип у предметов, которые можно посмотреть - по умолчанию да

Команды

Вот что умеет мод:

• /imfeelinglucky [<namespace>] - открывает рандомную страницу
  • Пример: /imfeelinglucky minecraft -> https://minecraft.wiki/????????
• /wiki <pageName> - открывает вики по названию. Можно указать namespace.
  • Пример: /wiki minecraft:creeper -> https://minecraft.wiki/w/?search=creeper
  • Алиас: /whatis
• /whatbiome - открывает вики биома, в котором ты стоишь
• /whatstructure - открывает вики структуры, в которой ты находишься (только в одиночке)
• /whatcommand <command> - открывает вики команды
  • Пример: /whatcommand give -> https://minecraft.wiki/w/?search=%2Fgive
  • Алиас: /whatcmd
• /whatisthis - открывает вики того, на что смотришь
• /whatisthisitem - открывает вики предмета в основной руке, можно добавить offhand для второй
• /whatversion - открывает страницу текущей версии игры
  • Пример: /whatversion -> https://minecraft.wiki/w/Java_Edition_1.21.5

Если открывать страницу через команду, окно подтверждения не вылезает - сразу кидает в браузер.

[[Вики-ссылки]] в чате

Хочешь кинуть ссылку на вики в чат? Просто пиши [[название страницы]] - Hey Wiki сам превратит это в кликабельную ссылку. Поддерживаются и межвики-ссылки:

• [[aether:lore]] - внешняя ссылка на Aether Wiki
• [[en:enderman]] - ссылка на английскую страницу эндермена
• [[minecraft:en:enderman]] - комбо: внешняя и межъязыковая

Какие вики поддерживает

Сейчас под капотом:

• Minecraft Wiki
• Aether Wiki
• Mekanism Wiki
• The Twilight Forest Wiki
• Applied Energistics 2 Wiki
• Stardust Labs Wiki
• Create Wiki
• Voidscape Wiki
• Advent of Ascension Wiki
• Doggy Talents Next Wiki
• Endertech Infinity Wiki
• Marvel Superheroes Mod Wiki
• BlockFront Wiki
• Cobblemon Wiki

Если хочешь добавить что-то своё - можно через ресурспак, файл в assets/<namespace>/wiki_family/.

Для разработчиков

Кастомные предметы через NBT или data component

Если у тебя сервер с кастомками, можно указать для предмета heywiki:identifier, heywiki:translation_key и heywiki:fallback_title в custom_data. Тогда при наведении на косточку с такими тегами откроется страница, например, "Drill" на "niceserver". Для 1.20.4 данные пишутся напрямую в NBT.

Зависимости

Fabric:

• Fabric API - база
• Architectury API - чтобы работало и на NeoForge
• Cloth Config - для конфигов
• Mod Menu - чтоб зайти в настройки (рекомендуется)
• MCBrowser и MCEF - для браузера в игре (опционально)
• REI/EMI/JEI - интеграция по желанию

NeoForge:

• Architectury API
• Cloth Config
• REI/EMI/JEI - по желанию

Поддержка версий

Мод живёт по семантическому версионированию: мажор.минор.патч. Актуальные ветки:

• master - 1.21.7, Fabric и Neoforge
• mc/1.21.5 и 1.21.4 - уже EOL
• mc/1.21.1 - активная поддержка (LTS)
• mc/1.20.4 - поддержка только исправлений (Maintenance LTS)

Старые снапшоты не поддерживаются. Если хочешь запушить фичу - шли в master, оттуда уже разнесут по активным веткам.