Skip to content

Commit 37f6ec8

Browse files
committed
Sync README with MCW
1 parent 9238af9 commit 37f6ec8

1 file changed

Lines changed: 14 additions & 8 deletions

File tree

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010
[<img alt="neoforge" height="56" src="https://github.com/mc-wiki/minecraft-mod-heywiki/blob/master/docs/supports_neoforge.svg?raw=true">](https://neoforged.net/)
1111
[<img alt="crowdin" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/translate/crowdin_vector.svg">](https://crowdin.com/project/hey-wiki)
1212

13-
Hey Wiki is a client mod made by the [the Minecraft Wiki](https://minecraft.wiki) community that allows you to press H (customizable)
13+
Hey Wiki is a client mod made by the [the Minecraft Wiki](https://minecraft.wiki) community that allows you to press H (
14+
customizable)
1415
to open the wiki page of the block, item, or entity you're aiming at, whether it's from vanilla or a mod.
1516
Hey Wiki supports [Fabric](https://fabricmc.net/) and [NeoForge](https://neoforged.net/).
1617

@@ -30,7 +31,8 @@ https://github.com/mc-wiki/minecraft-mod-heywiki/assets/45287180/b0650362-1fe9-4
3031
### How to use
3132

3233
1. Install the mod. You can download it from [Modrinth](https://modrinth.com/mod/hey-wiki)
33-
or [CurseForge](https://curseforge.com/minecraft/mc-mods/hey-wiki). Don't forget to install the [dependencies](#dependencies).
34+
or [CurseForge](https://curseforge.com/minecraft/mc-mods/hey-wiki). Don't forget to install
35+
the [dependencies](#dependencies).
3436
2. Point at a block/entity with your crosshair or hover over an item in your inventory with your cursor.
3537
3. Press the keybind (default is H).
3638
4. Either confirm the action or copy the link to your clipboard in the screen that pops up.
@@ -174,9 +176,9 @@ You also want to include a translation file in `assets/<namespace>/lang/` folder
174176
> [!WARNING]
175177
> This API is an experimental feature and might change at any time.
176178
177-
Data pack and custom server authors can now use `heywiki:identifier` and `heywiki:translation_key` in `custom_data`
178-
component to provide custom namespace and name for an item. However, this only accounts for custom items. For 1.20.4,
179-
you can populate these fields directly in NBT.
179+
Data pack and custom server authors can use `heywiki:identifier`, `heywiki:translation_key` and
180+
`heywiki:fallback_title` in `custom_data` component to provide custom namespace and name for an item. However, this only
181+
accounts for custom items. For 1.20.4, you can populate these fields directly in NBT.
180182

181183
You need to use the method above to register a new wiki with a custom namespace using resource pack. If it is not
182184
feasible to ask your players to download a resource pack, we can also ship it with the mod itself.
@@ -187,7 +189,7 @@ the "niceserver" namespace per above. Then you can give the player this item:
187189
1.21:
188190

189191
```mcfunction
190-
/give @s minecraft:bone[minecraft:custom_data={"heywiki:identifier": "niceserver:drill", "heywiki:translation_key": "item.niceserver.drill"}]
192+
/give @s minecraft:bone[minecraft:custom_data={"heywiki:identifier": "niceserver:drill", "heywiki:fallback_title": "Drill", "heywiki:translation_key": "item.niceserver.drill"}]
191193
```
192194

193195
1.20.4:
@@ -219,6 +221,7 @@ For NeoForge:
219221
## Versioning
220222

221223
### Hey Wiki
224+
222225
Hey Wiki itself follows [Semantic Versioning](https://semver.org/). The version number is in the format of
223226
`<major>.<minor>.<patch>[-<prerelease>]`. The version number is incremented based on the following rules:
224227

@@ -231,14 +234,17 @@ Hey Wiki itself follows [Semantic Versioning](https://semver.org/). The version
231234
Hey Wiki supports multiple versions of Minecraft.
232235

233236
Every Minecraft version is assigned a support status:
234-
- **Active**: This version receives new features and bug fixes. Features will be backported as much as reasonably possible.
237+
238+
- **Active**: This version receives new features and bug fixes. Features will be backported as much as reasonably
239+
possible.
235240
- **Maintenance**: This version receives only bug fixes and security patches. Features are generally not backported.
236241
- **End of Life (EOL)**: No further updates should be expected.
237242

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

241-
When a new snapshot releases, `master` branch is updated to that snapshot. Snapshots might receive only one version or no
246+
When a new snapshot releases, `master` branch is updated to that snapshot. Snapshots might receive only one version or
247+
no
242248
version at all. Only Fabric is supported for snapshots.
243249

244250
Old Minecraft versions are provided with Long Term Support (LTS) based on their popularity and the community's interest.

0 commit comments

Comments
 (0)