https://github.com/Ueaj-Kerman/Minecraft-Recipe-Format
An enhanced format for recipes
https://github.com/Ueaj-Kerman/Minecraft-Recipe-Format
Last synced: 8 months ago
JSON representation
An enhanced format for recipes
- Host: GitHub
- URL: https://github.com/Ueaj-Kerman/Minecraft-Recipe-Format
- Owner: Devan-Kerman
- License: mpl-2.0
- Created: 2020-06-25T19:52:56.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-10T17:15:03.000Z (almost 6 years ago)
- Last Synced: 2024-12-27T05:25:04.184Z (over 1 year ago)
- Language: Java
- Size: 82 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Minecraft-Recipe-Format
An enhanced format for recipes
# Maven
```
repositories {
maven {
url = 'https://raw.githubusercontent.com/Devan-Kerman/Devan-Repo/master/'
}
}
dependencies {
modImplementation group: 'net.devtech', name: 'Minecraft-Recipe-Format', version: '1.1.4'
}
```
# MCRF developer documentation
net.devtech.mcrf.util.RefreshingRecipe
and net.devtech.mcrf.recipes.RecipeSchema and it's inner classes
# MCRF user documentation
## Format
`(input 1) + (input 2) + (input 3)... --[machine:id]-> (output 1) + (output 2) + (output 3)`
different parsers have different specifications.
an exception to remember, the string `--[`, may have different implications depending on the code of ther parser,
so it is important for devs to remember to state they are using a retroactive parser or not. If you are a user:
retroactive parsing requires you to escape `--[`, by using `\--[` instead.
That's the entire format, I'll go over the default supported parsers here:
## Comments
```
% this is a comment
% it can start anywhere in the line
% from the start of the percent sign to the end of the line is considered a comment
% comments can be escaped with '\', so for example
This mod is written 100\% in java
```
## Floating Point Numbers
these all come in decimal format, so 1.4, and negatives are supported, no fractions.
## Integers
Binary is supported via the "0b" prefix, ex. 0b011010
Hexadecimal is also supported via the "0x" prefix, ex. 0xFFFFFF
and of course decimal numbers are supported too, but no prefix is needed, ex. 142221
negatives are supported as well.
## Lists
lists are enclosed with a '[]', all elements inside are comma separated.
ex. [stone, iron, lead]
there are also list or singleton parsers, which, in the absence of a '[' character at the beginning of the element, will
instead just parse one element.
so for example, both of the following are still valid:
```
stone --[test:test]-> ...
[stone, air] --[test:test]-> ...
```
# Strings
strings are unquoted but require heavy escaping
newlines, commas, pluses, and dashes all need escaping
they can all be escaped with '\', ex. a '\' that does not
escape anything is a '\', if you want to end with a '\' simply
put "\\".
```
1\+2=3
/o\ help, I my head hurts
```
## Wildcards
some recipes (anvil smashing result) will accept a wildcard, this can mean a variety of things and should be outlined by the mod maker
they are described with the '*' character
```
\*
hello
```
# Minecraft Specific Parsers
## Blocks:
MCRF blocks allow for adjusting properties and blockentity data.
```
namespace:id
namespace:id[optional=blockstate, property=0]
namespace:id{optional:"nbt_data"}
namespace:id[optional=blockstate, property=0]{optional:"nbt_data"}
```
## Counted Tags:
counted tags are a list of tags with an amount
```
tag:id x3
tag:id
[tag:id, tag:id0]
```
however they're usually prefixed with a '#' to differentiate between tags and the other element
```
#tag:id
```
## Entities
MCRF supports NBT in entities
```
entity:id
entity:id{nbt:"data"}
```
## Identifiers
identifiers are just namespaced ids
```
namespace:id
```
## Ingredients
supports arrays/singletons of tags and items
```
#[tag:id, tag2:id]
#tag:id
item:id
[item:id, item2:id]
```
## Items
same as identifiers but only for items
## ItemStacks
an identifier, nbt data and an amount
```
item:id
item:id{nbt:"data"}
item:id{nbt:"data"} x4
item:id x5
```
## MCRF Ingredients
Minecraft ingredients suck ass so I made my own
```
#tag:id
item:id
item:id{nbt:support}
item:id x10
#[tag:id, multi:tags]
```
# Default recipes:
## Anvils (Retroactive)
`mcrf/falling_anvil`
has support for normal anvil recipes, and falling anvil recipes
for normal anvils, the format is
```
(ingredient) + (ingredient) + (int xp) --[minecraft:anvil]-> mcrf:ingredient
```
or for falling anvils
```
% surface (air for any)+ ingredients + require onFire = result surface + result itemstacks
(block id | block tag) + list of mcrf ingredients + boolean --[mcrf:falling_anvil]-> (* | block) + list of itemstacks
```
## Minecraft recipes (Retroactive)
mcrf/minecraft
all recipe's first ingredient is the identifier of the recipe, and yes, you can override vanilla recipes with this
## crafting recipes
shapeless recipes can be made with a single, non nested array, these only support vanilla ingredients.
```
(identifier) + (list of ingredient) --[minecraft:crafting_table]-> (itemstack)
recipe:id + [stone, stone, iron_ingot] --[minecraft:crafting_table]-> stone
```
shaped recipes are made with nested arays
```
(identifier) + (list of list of ingredient) --[minecraft:crafting_table]-> (itemstack)
recipe:id + [[stone, stone, stone], [stone, air, stone], [stone, stone, stone]] --[minecraft:crafting_table]-> stone x9
```
## stone cutting
```
(identifier) + (ingredient) --[minecraft:stone_cutter] -> (itemstack)
recipe:id + stone --[minecraft:stone_cutter]-> iron_ingot
```
## smithing table
```
(identifier) + (ingredient) + (ingredient) --[minecraft:smithing_table]-> (itemstack)
```
## campfire, smoker, blast_furnace, furnace
```
(identifier) + (ingredient) + (int : time) --[minecraft:%MACHINE_ID%]-> (itemstack) + (exp)
```