From e44b0b85e30ef54af2ac12416033e1dcd4d26483 Mon Sep 17 00:00:00 2001 From: Wuzzy Date: Wed, 11 Jan 2017 13:34:08 +0100 Subject: [PATCH] Change API.txt to API.md format --- API.md | 31 ++++++++++++++++++++++++++++ API.txt | 59 ------------------------------------------------------ README.txt | 2 +- 3 files changed, 32 insertions(+), 60 deletions(-) create mode 100644 API.md delete mode 100644 API.txt diff --git a/API.md b/API.md new file mode 100644 index 0000000000..ac91d0573a --- /dev/null +++ b/API.md @@ -0,0 +1,31 @@ +# API + +This document is a WORK IN PROGRESS. Currently, it only contains some information about the used groups. + +## Groups +This section explains all the used groups in this subgame. + +### Groups for interactions + +* `dig_by_water=1`: Blocks with this group will drop when they are near flowing water +* `cultivatable=2`: Block will be turned into Farmland by using a hoe on it +* `cultivatable=1`: Block will be turned into Dirt by using a hoe on it + +### Groups (mostly) used for crafting recipes + +* `sand=1`: Sand (any color) +* `sandstone=1`: (Yellow) sandstone and related nodes (chiseled and the like) (only full blocks) +* `redsandstone=1`: Red sandstone and related nodes (chiseled and the like) (only full blocks) +* `quartz_block=1`: Quartz Block and variants (chiseled, pillar, etc.) (only full blocks) +* `stonebrick=1`: Stone Bricks and related nodes (only full blocks) +* `tree=1`: Oak Wood, Birch Wood, etc. (tree trunks) +* `wood=1`: Oak Wood Planks, Birch Wood Planks, etc. (only full blocks) +* `wood_slab=1`: Slabs made out of a kind of wooden planks +* `wood_stairs=1`: Stairs made out of a kind of wooden planks +* `coal=1`: Coal of any kind (coal lump) +* `boat=1`: Boat + +### Other groups + +* `water=1`: Water +* `lava=1`: Lava diff --git a/API.txt b/API.txt deleted file mode 100644 index e5704e5156..0000000000 --- a/API.txt +++ /dev/null @@ -1,59 +0,0 @@ -# API - -This document is a WORK IN PROGRESS. - -Currently, it only contains some information about the used groups. - - -Groups for interactions - - dig_by_water=1 - Blocks with this group will drop when they are near flowing water - - cultivatable=2 - Block will be turned into Farmland by using a hoe on it - cultivatable=1 - Block will be turned into Dirt by using a hoe on it - - -Groups (mostly) used for crafting recipes - - sand=1 - Sand (any color) - - sandstone=1 - (Yellow) sandstone and related nodes (chiseled and the like) (only full blocks) - - redsandstone=1 - Red sandstone and related nodes (chiseled and the like) (only full blocks) - - quartz_block=1 - Quartz Block and variants (chiseled, pillar, etc.) (only full blocks) - - stonebrick=1 - Stone Bricks and related nodes (only full blocks) - - tree=1 - Oak Wood, Birch Wood, etc. (tree trunks) - - wood=1 - Oak Wood Planks, Birch Wood Planks, etc. (only full blocks) - - wood_slab=1 - Slabs made out of a kind of wooden planks - - wood_stiars=1 - Stairs made out of a kind of wooden planks - - coal=1 - Coal of any kind (coal lump) - - boat=1 - Boat - -Other groups - water=1 - Water - - lava=1 - Lava diff --git a/README.txt b/README.txt index a2991971cc..3e11124385 100644 --- a/README.txt +++ b/README.txt @@ -32,7 +32,7 @@ Bob Lennon because it's a pyro-barbare Info for programmers -------------------- -You find interesting and useful infos in API.txt. +You find interesting and useful infos in API.md. License of media (textures and sounds) --------------------------------------