Hearthsail:Manual of style: Difference between revisions

Latest revision as of 12:27, 31 July 2026

This wiki grows alongside the game. These are the rules that keep it from drifting apart from the build.

Language

English is the reference language, exactly as in the game's own translation layer (src/i18n/en.ts). German articles live as subpages: Anchor and Anchor/de. Put {{Languages}} at the top of both.

Page titles use the item's English display name, not its internal id. The id belongs in the infobox, where the generator can find it.

Page types

Type	Infobox	Category
Item	`{{Infobox item}}`	one of `Resources`, `Food`, `Equipment`, `Tools`
Creature, enemy	`{{Infobox creature}}`	`Creatures`
Villager	`{{Infobox villager}}`	`Villagers`
Island, region	`{{Infobox island}}`	`Islands`
Everything else	—	by topic

Recipes are not their own page type — put {{Recipe}} on the page of the thing that comes out of the recipe.

Every article ends with {{Nav}} above its categories, so the navigation box is edited in one place instead of on every page.

Images

File name matches the page name: File:Oak Log.png for Oak Log.
Sprites are uploaded at native pixel size and scaled up in the article — the wiki renders them with image-rendering: pixelated, so no smoothing.
Screenshots: PNG, unscaled.

Status banners

{{Stub}} — in the game, article still empty.
{{Planned}} — not in the game yet.

Both are normal here. An honest empty page beats a page that quietly lies about what the build does.

Items are generated, not typed

Item pages are meant to be written by a generator that reads the item tables and src/i18n/en.ts straight from the repository, uploads the icons and fills the infobox. Anything a script can derive — name, id, stack size, icon — is not worth typing by hand and would only drift. Prose, tips and screenshots are what people add.

@@ Line 16: / Line 16: @@
 ! Type !! Infobox !! Category
 |-
-| Item || {{Tl|Infobox item}} || <code>Items</code>
+| Item || {{Tl|Infobox item}} || one of <code>Resources</code>, <code>Food</code>, <code>Equipment</code>, <code>Tools</code>
 |-
 | Creature, enemy || {{Tl|Infobox creature}} || <code>Creatures</code>
+|-
+| Villager || {{Tl|Infobox villager}} || <code>Villagers</code>
+|-
+| Island, region || {{Tl|Infobox island}} || <code>Islands</code>
 |-
 | Everything else || — || by topic
 |}
+Recipes are not their own page type — put {{Tl|Recipe}} on the page of the thing that
+comes out of the recipe.
+Every article ends with {{Tl|Nav}} above its categories, so the navigation box is
+edited in one place instead of on every page.
 == Images ==
 * File name matches the page name: <code>File:Oak Log.png</code> for [[Oak Log]].
-* Sprites are uploaded at native pixel size and scaled up in the article — the wiki
+* Sprites are uploaded at native pixel size and scaled up in the article — the wiki renders them with <code>image-rendering: pixelated</code>, so no smoothing.
-  renders them with <code>image-rendering: pixelated</code>, so no smoothing.
 * Screenshots: PNG, unscaled.