diff --git a/README.md b/README.md new file mode 100644 index 0000000..f75fcb4 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +Bonemeal mod [bonemeal] + +This mod adds two new items into the game, bones which can be dug from normal +dirt and bonemeal which is crafted from bones and player bone blocks. + +Bonemeal can be used on added saplings for a 1 in 2 chance to grow them quickly +as well as specified crops which are grown 1 to 4 steps at a time. Dirt can +also be clicked for random grass, flowers or registered decoration to appear. + +The api.txt document shows how to add your own saplings, crops and grasses to +the list by using one of the 3 commands included and the mod.lua file gives you +many examples by using some of the popular mods available. + +https://forum.minetest.net/viewtopic.php?f=9&t=13284 + +Changelog: + +- 0.1 - Initial release diff --git a/api.txt b/api.txt new file mode 100644 index 0000000..7e51368 --- /dev/null +++ b/api.txt @@ -0,0 +1,60 @@ + +Bonemeal API +============ + +This guide will show you how to add saplings, crops and dirt types for the +bonemeal mod to use from withhin your own mods. Please make sure that bonemeal +appears in the depends.txt file of your mod so everything work properly. + + +Function Usage +============== + + +Adding Crops +------------ + +bonemeal:add_crop({ nodename_start, growing_steps, seed_name }) + +This command is used to add new crops for bonemeal to work on. + +e.g. + +bonemeal:add_crop({ + {"farming:cotton_", 8, "farming:seed_cotton"}, + {"farming:wheat_", 8, "farming:seed_wheat"}, +}) + + +Adding Saplings +--------------- + +bonemeal:add_sapling({ sapling_node, function, soil_type[sand, dirt, nodename] }) + +This command will add new saplings for bonemeal to grow on sand, soil or a +specified node type. + +bonemeal:add_sapling({ + {"ethereal:palm_sapling", ethereal.grow_palm_tree, "soil"}, + {"ethereal:palm_sapling", ethereal.grow_palm_tree, "sand"}, +}) + + +Adding Dirt Decoration +---------------------- + +bonemeal:add_deco({ dirt_node, {grass_node_list}, {decor_node_list} }) + +This command will add grass and decoration to specific dirt types. + +e.g. + +bonemeal:add_deco({"default:dirt_with_dry_grass", {"default:dry_grass_1", "air"}, + {"flowers:rose", "flowers:viola"} }) + + +Final Words +=========== + +I hope this guide helps you add your own plants so you can grow them quickly +with bonemeal. Please check the mods.lua for more examples. diff --git a/description.txt b/description.txt new file mode 100644 index 0000000..f85f0a2 --- /dev/null +++ b/description.txt @@ -0,0 +1 @@ +Adds bone and bonemeal giving the ability to quickly grow plants and saplings. \ No newline at end of file diff --git a/license.txt b/license.txt new file mode 100644 index 0000000..fec6f6a --- /dev/null +++ b/license.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2016 TenPlus1 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/mod.conf b/mod.conf new file mode 100644 index 0000000..fec08dc --- /dev/null +++ b/mod.conf @@ -0,0 +1 @@ +name = bonemeal \ No newline at end of file diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..3b41ff3 Binary files /dev/null and b/screenshot.png differ