Module:Item/doc: Difference between revisions
(Adding more items) |
(Adding images for items) |
||
| Line 5: | Line 5: | ||
Contains utilities for working with in-game items. | Contains utilities for working with in-game items. | ||
== Adding | == Adding items == | ||
To add more items, go to [[Module:Item/item names by item id.json]]. | To add more items, go to [[Module:Item/item names by item id.json]]. | ||
It is a | It is a JSON file containing an object with keys being the item in-game IDs, but also allows custom IDs for displaying items such as coil variations. | ||
Each item has a list of names. These are used for various lookups. | Each item has a list of names. These are used for various lookups. | ||
An item can have as many names as you wish, but it must have at least one. | An item can have as many names as you wish, but it must have at least one. | ||
The first name listed will be used as a «main» name in various lookups, so it's generally should be the name used by the game. | The first name listed will be used as a «main» name in various lookups, so it's generally should be the name used by the game. | ||
== Adding images for items == | |||
To add images for items, go to [[Module:Item/item image files by item id.json]]. | |||
It is a JSON file containing an object with keys being the item in-game IDs, but also allows custom IDs for displaying items such as coil variations. | |||
{{callout|Warning|For items to show up, they must also be added as items.}} | |||
The value of an item is its icon filename. | |||
To see if icons do work, look at newly-added items in the list of items in {{t|item}}. | |||
Revision as of 12:25, 17 August 2024
Module documentation
|
|---|
| View or edit this documentation • (about module documentation) |
Contains utilities for working with in-game items.
Adding items
To add more items, go to Module:Item/item names by item id.json.
It is a JSON file containing an object with keys being the item in-game IDs, but also allows custom IDs for displaying items such as coil variations.
Each item has a list of names. These are used for various lookups. An item can have as many names as you wish, but it must have at least one. The first name listed will be used as a «main» name in various lookups, so it's generally should be the name used by the game.
Adding images for items
To add images for items, go to Module:Item/item image files by item id.json.
It is a JSON file containing an object with keys being the item in-game IDs, but also allows custom IDs for displaying items such as coil variations.
The value of an item is its icon filename.
To see if icons do work, look at newly-added items in the list of items in {{item}}.
