Module:Item recipe/doc: Difference between revisions

From Space Station 14 Wiki
(basic docs)
(→‎JSON files: wording)
 
(One intermediate revision by the same user not shown)
Line 14: Line 14:
'''JSON files that are updated automatically, syncing with the upstream:'''
'''JSON files that are updated automatically, syncing with the upstream:'''
* [[Module:Item recipe/recipes by recipe IDs.json]] - contains 1 to 1 mapping of recipe IDs to recipes.
* [[Module:Item recipe/recipes by recipe IDs.json]] - contains 1 to 1 mapping of recipe IDs to recipes.
* [[Module:Item recipe/recipe IDs by product IDs.json]] - contains mapping of recipe products to recipe IDs that produce these...products. Can 1 to 1, or 1 to many.
* [[Module:Item recipe/recipe IDs by product IDs.json]] - contains mapping of recipe products to recipe IDs that produce these...products. Can be 1 to 1, or 1 to many.
* [[Module:Item recipe/recipe IDs by method and availability.json]] - contains a mapping of recipe production methods (e.g. {{kbd|Autolathe}}) to → availability (condition under which a recipe is available for this production method) to → recipe IDs.
* [[Module:Item recipe/recipe IDs by method and availability.json]] - contains a mapping of recipe production methods (e.g. {{kbd|Autolathe}}) to → availability (condition under which a recipe is available for this production method) to → recipe IDs.


Line 21: Line 21:
'''JSON files that are filled manually:'''
'''JSON files that are filled manually:'''
* [[Module:Item recipe/order of materials.json]] - a 1 to 1 mapping of recipe materials to order at which they appear in recipes. Less number = higher order. Materials that do not have an order defined here, will appear after those that do.
* [[Module:Item recipe/order of materials.json]] - a 1 to 1 mapping of recipe materials to order at which they appear in recipes. Less number = higher order. Materials that do not have an order defined here, will appear after those that do.
* [[Module:Item recipe/product overrides.json]] - a 1 to 1 mapping of recipe products to item IDs. Not all products are the same as item IDs they "represent", so sometimes a connection needs to be established.
* [[Module:Item recipe/product overrides.json]] - a 1 to 1 mapping of recipe products to item IDs. Not all products are the same as item IDs they "represent", so sometimes a connection needs to be established explicitly.

Latest revision as of 12:40, 17 September 2024

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

Implements {{item recipe}}.

JSON files

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

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 recipe/order of materials.json - a 1 to 1 mapping of recipe materials to order at which they appear in recipes. Less number = higher order. Materials that do not have an order defined here, will appear after those that do.
  • Module:Item recipe/product overrides.json - a 1 to 1 mapping of recipe products to item IDs. Not all products are the same as item IDs they "represent", so sometimes a connection needs to be established explicitly.