craftingguide/wiki
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated Mod Version Data Format (markdown)

Browse Source
This commit is contained in:
Andrew Miner
2015-02-03 09:47:32 -08:00
parent 8a8beff0f3
commit cb56d4d6ac
1 changed files with 36 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Mod-Version-Data-Format.md
+36 -38
View File
@@ -1,40 +1,43 @@
Version 2 of the Crafting Guide file format is a very simple command-based language which is very similar to [YAML](http://www.yaml.org). There are commands for entering all various kinds of data needed to describe a mod, its items, and the recipes for those items. Most commands are optional, and can be entered in any order. Anywhere this isn't true will be called out below.
The ModVersion file format is a very simple command-based language which is very similar to [YAML](http://www.yaml.org). There are commands for entering all various kinds of data needed to describe a mod's items and the recipes for those items. Most commands are optional, and can be entered in any order. Anywhere this isn't true will be called out below.
## Example
```yaml
schema: 2
name: Applied Energistics 2
version: rv1-stable-1
description: Crafting recipes from Applied Energistics, by AlgorithmX2
# This is a comment.
item: 128³ Spatial Component
recipe:
input: Glowstone Dust, 16³ Spatial Component, Engineering Processor
pattern: 010 121 010
tools: Crafting Table
group: Storage
item: Cable Anchor
recipe:
input: Iron Ingot
pattern: ... .0. ...
quantity: 3
tools: Nether Quartz Cutting Knife
recipe:
input: Tin Ingot
pattern: ... .0. ...
quantity: 3
tools: Nether Quartz Cutting Knife
# This is a comment.
item: 128³ Spatial Component
recipe:
input: Glowstone Dust, 16³ Spatial Component, Engineering Processor
pattern: 010 121 010
tools: Crafting Table
item: Certus Quartz Crystal; gatherable: yes
group: Cables
item: Printed Calculation Circuit
recipe:
input: Inscriber Calculation Press, Pure Certus Quartz Crystal
pattern: 0.. .1. ...
extras: Inscriber Calculation Press
tools: Inscriber
item: Cable Anchor
recipe:
input: Iron Ingot
pattern: ... .0. ...
quantity: 3
tools: Nether Quartz Cutting Knife
recipe:
input: Tin Ingot
pattern: ... .0. ...
quantity: 3
tools: Nether Quartz Cutting Knife
group: Circuits
item: Certus Quartz Crystal; gatherable: yes
item: Printed Calculation Circuit
recipe:
input: Inscriber Calculation Press, Pure Certus Quartz Crystal
pattern: 0.. .1. ...
extras: Inscriber Calculation Press
tools: Inscriber
```
## Basics
@@ -52,18 +55,13 @@ Please be sure to use these two commands prior to submitting a pull request for
* `schema: <version>` _(required)_
The data schema used by the file. The current version is: 2.
The data schema used by the file. The current version is: 1.
* `name: <mod name>` _(required)_
* `group: <group>`
The name of the mod described in the file. This should be the full name of the mod as referred to in
its own documentation; only use abbreviations if they are as commonly used as the full name itself
(e.g., "IC2").
* `version: <mod version>` _(required)_
The version of the mod being described by the file. This should use whatever version scheme is used
by the mod itself, and should match whatever is shown in the in-game "Mods" screen.
Starts an item group. Groups are used simply to organize items on the mod detail page, and don't need
to correspond to anything in-game. Any items declared before the first group declaration are not part
of any group.
* `item: <item name>`