Module:Item/doc: Difference between revisions

Revision as of 11:49, 17 September 2024

Module documentation
View or edit this documentation • (about module documentation)

Uses JSON data

This module uses JSON data pages:

Implements {{Item}}.

JSON files that are updated automatically, syncing with the upstream:

Module:Item/item names by item ids.json - contains 1 to 1 mapping of item IDs to their names.
Module:Item/item ids by item lowercase names.json - contains 1 to 1 mapping of item names (lowercase) to their IDs. If a name repeats for multiple items, only a single item ID will be defined here.

Warning

Do not make changes to the above JSON files - any changes made will be erased on next update.

JSON files that are filled manually:

Module:Item/item ids by item lowercase names overrides.json - a 1 to 1 mapping of item names (lowercase) to their IDs. This one has a higher priority than the other one, so it can be used to override existing name → ID mappings or create new ones.
Module:Item/item image files by item id.json - a mapping for item IDs to image files for these items. Can be a simple 1 to 1 mapping of item name to file name, or can have a whole config that allows to define multiple images per single ID (see sections below for more info). Used to add icons to items.
Module:Item/item page links by item ids.json - a 1 to 1 mapping of item IDs to page names. Used to turn items into links to their pages (or any other page on the wiki).

Ores are currently hardcoded into names overrides. Figure out a way to pull them from game resources. This is for Module:Item recipe.

@@ Line 8: / Line 8: @@
 }}
-Contains utilities for working with in-game items.
+Implements {{t|Item}}.
+== JSON files ==
+'''JSON files that are updated automatically, syncing with the upstream:'''
+* [[Module:Item/item names by item ids.json]] - contains 1 to 1 mapping of item IDs to their names.
+* [[Module:Item/item ids by item lowercase names.json]] - contains 1 to 1 mapping of item names (lowercase) to their IDs. If a name repeats for multiple items, only a single item ID will be defined here.
+{{Callout|Warning|Do not make changes to the above JSON files - any changes made will be erased on next update.}}
+'''JSON files that are filled manually:'''
+* [[Module:Item/item ids by item lowercase names overrides.json]] - a 1 to 1 mapping of item names (lowercase) to their IDs. This one has a higher priority than the other one, so it can be used to override existing name → ID mappings or create new ones.
+* [[Module:Item/item image files by item id.json]] - a mapping for item IDs to image files for these items. Can be a simple 1 to 1 mapping of item name to file name, or can have a whole config that allows to define multiple images per single ID (see sections below for more info). Used to add icons to items.
+* [[Module:Item/item page links by item ids.json]] - a 1 to 1 mapping of item IDs to page names. Used to turn items into links to their pages (or any other page on the wiki).
 == TODO ==