Minecraft Wiki:Hey Wiki

{
 "title": "Hey Wiki",
 "rows": [
 {
 "field": "(link to MCW:About article, displayed as Minecraft Wiki)\n\n'''Main contributors'''\n* <span class=\"plainlinks\">[https://minecraft.wiki/w/User:Dianliang233 Dianliang233]</span>",
 "label": "Author(s)"
 },
 {
 "field": "\n* [https://fabricmc.net/ Fabric]\n* [https://neoforged.net/ NeoForge]",
 "label": "Platform(s)"
 },
 {
 "field": "(link to wikipedia:Java (programming language) article, displayed as Java)",
 "label": "Written in"
 },
 {
 "field": "1.9.0",
 "label": "Latest version"
 },
 {
 "field": "June 1, 2024",
 "label": "Release date"
 },
 {
 "field": "~228 KiB",
 "label": "Size"
 },
 {
 "field": "[https://www.gnu.org/licenses/lgpl-3.0.en.html LGPL-3.0]",
 "label": "License"
 },
 {
 "field": "Yes ([https://github.com/mc-wiki/minecraft-mod-heywiki GitHub])",
 "label": "<span style=\"white-space:normal\">Source available</span>"
 }
 ],
 "invimages": [],
 "images": [
 "Hey Wiki logo.png"
 ]
}

Hey Wiki is a client mod for Java Edition made by the Minecraft Wiki community. It allows players to quickly open the wiki page of the block, item, or entity that the camera is aimed at, whether it is from the vanilla game or another mod.

Download on Modrinth Download on CurseForge

• Press (customizable) to open the wiki (Minecraft Wiki or the respective mod wiki) page of the block/item/entity the crosshair/pointer is over.
• Press  +  or  +  to open the wiki page of the item in the main hand.
• Press to open the wiki search screen. The search bar can be used to search for wiki pages.
• Adds several commands.
• Link to a wiki page in chat using [[wiki link]] syntax.

1. Install the mod from GitHub or Modrinth. Don't forget to also install the dependencies!
2. Point at a block/entity with your crosshair or hover over an item in your inventory with your cursor.
3. Press the keybind (default is ).
4. Either confirm the action or copy the link to your clipboard in the screen that pops up.

It is also supported to use MCBrowser and MCEF for in-game browsing.

Optionally, the following behaviors in the config menu can be changed:

• If confirmation is required to open the wiki page: default is true
• Preferred wiki language, default is the current game language unless overridden
• Toggle between Simplified and Traditional Chinese, default is the current game language unless overridden
• The keybind to open a wiki page, default is
• Reach distance, default is 5.2 blocks (same as creative mode reach)
• Whether fluid blocks can be targeted, default is false

These commands are available:

• /imfeelinglucky [<namespace>] – Opens a random Minecraft Wiki page in the designated namespace.
  • Example: /imfeelinglucky minecraft → https://minecraft.wiki/w/Special:Random
• /wiki <pageName> – Opens the Minecraft Wiki page of the specified page name.
  • Example: /wiki creeper → https://minecraft.wiki/w/?search=creeper
  • Alias: /whatis
• /whatbiome – Opens the Minecraft Wiki page of the biome the player is currently in.
• /whatstructure – Opens the Minecraft Wiki page of the structure the player is currently in.
  • This command is only available in singleplayer.
• /whatcommand <command> – Opens the Minecraft Wiki page of the specified command.
  • Example: /whatcommand give → https://minecraft.wiki/w/?search=%2Fgive
  • Alias: /whatcmd
• /whatisthis – Opens the Minecraft Wiki page of the block/item/entity that the player is aiming at.
• /whatisthisitem – Opens the Minecraft Wiki page of the item being held in the main hand.
  • /whatisthisitem offhand – Same, but for the offhand.

Opening a page with a command does not cause the confirmation screen to appear.

Hey Wiki supports [[wiki links]] in chat. When a message is sent with [[wiki link]] syntax, it will automatically be replaced with a clickable link.

Interwiki links and other namespaces are supported. For example:

• [[aether:The Aether]] will link to the Aether Wiki page of "The Aether" (interwiki)
• [[en:enderman]] will link to the English Minecraft Wiki page of "enderman" (interlanguage)
• [[minecraft:en:enderman]] will link to the English Minecraft Wiki page of "enderman" (interwiki and interlanguage)

The latest version of Hey Wiki supports the following wikis:

• 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
• Arthropod Phobia Expansions Wiki

Resource packs can be used to add support for other wikis. An issue can be filed in case a wiki should be added to the default list.

Hey Wiki provides several ways mod, mod pack, data pack, and custom server developers can leverage to support their creation.

Hey Wiki supports using resource pack to add support for other wikis. To do so, create a JSON file in the assets/<namespace>/wiki_family/ folder in your resource pack with the following format:

{
// 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
}
}
]
}

You also want to include a translation file in assets/<namespace>/lang/ folder with the following format:

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

Data pack and custom server authors can use heywiki:identifier, heywiki:translation_key and heywiki:fallback_title in custom_data data component to provide custom namespace and name for an item. However, this only accounts for custom items. For 1.20.4, you can populate these fields directly in NBT.

You need to use the method above to register a new wiki with a custom namespace using resource pack. If it is not feasible to ask your players to download a resource pack, we can also ship it with the mod itself.

For example, on "niceserver", to have a bone item to resolve to the "Drill" page, you will first need to register the "niceserver" namespace per above. Then you can give the player this item:

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

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

For Fabric:

• (Required) Fabric API
• (Required until 26.1) Architectury API: for multi-modloader compatibility
• (Required) Cloth Config: for configuration
• (Recommended) Mod Menu: to access the config menu
• (Optional) MCBrowser and MCEF: for in-game browser
• (Optional) REI/EMI/JEI: integration supported

For NeoForge:

• (Required until 26.1) Architectury API: for multi-modloader compatibility
• (Required) Cloth Config: for configuration
• (Optional) REI/EMI/JEI: integration supported

Hey Wiki uses Semantic Versioning in the format <major>.<minor>.<patch>[-<prerelease>]. The version number is incremented based on the following rules:

• Major: Incremented when breaking changes are made to stable, public API.
• Minor: Incremented when new features to stable, public API are added in a backwards-compatible manner.
• Patch: Incremented when bug fixes are made.

Changelogs for Hey Wiki can be seen at MCW:Hey Wiki/Releases.

Hey Wiki supports multiple versions of Minecraft.

Every Minecraft version is assigned a support status:

• Active: This version receives new features and bug fixes. Features will be backported as much as reasonably possible.
• Maintenance: This version receives only bug fixes and security patches. Features are generally not backported.
• End of Life (EOL): No further updates should be expected.

The current Minecraft release and the master branches are always Active. Pull requests should almost always go to master. If they're accepted, they should be cherry-picked to other Active branches.

When a new snapshot releases, master branch is updated to that snapshot. Snapshots might receive only one version or no version at all. Only Fabric is supported for snapshots.

Old Minecraft versions are provided with Long Term Support (LTS) based on their popularity and the community's interest. LTS versions receive Active support at first. After some time, they will be downgraded to Maintenance. Old snapshots are not supported.

The following table shows which versions are supported:

Hey Wiki is available in multiple languages.

It is translated by the community on Crowdin. It currently supports the following languages:

• German - Germany (de_de)
• English - US (en_us)
• Spanish - Spain (es_es)
• Persian - Iran (fa_ir)
• Finnish - Finland (fi_fi)
• French - France (fr_fr)
• Hebrew - Israel (he_il)
• Italian - Italy (it_it)
• Japanese - Japan (ja_jp)
• Korean - South Korea (ko_kr)
• Classical Chinese (lzh)
• Dutch - Netherlands (nl_nl)
• Portuguese - Brazil (pt_br)
• Portuguese - Portugal (pt_pt)
• Russian - Russia (ru_ru)
• Thai - Thailand (th_th)
• Ukrainian - Ukraine (uk_ua)
• Chinese Simplified - Chinese Mainland (zh_cn)
• Chinese Traditional - Hong Kong (zh_hk)
• Chinese Traditional - Taiwan (zh_tw)