summaryrefslogtreecommitdiff
path: root/biome_lib/README.md
diff options
context:
space:
mode:
authorVanessa Ezekowitz <vanessaezekowitz@gmail.com>2016-04-01 20:02:19 -0400
committerVanessa Ezekowitz <vanessaezekowitz@gmail.com>2016-04-01 21:09:33 -0400
commitda66780a569712c23ae4f2996cfb4608a9f9d69d (patch)
tree217556029a78bc23ad4564720afc86de97228a04 /biome_lib/README.md
parent615b22df4d423aded3613db7716943a2f389b047 (diff)
downloaddreambuilder_modpack-da66780a569712c23ae4f2996cfb4608a9f9d69d.tar
dreambuilder_modpack-da66780a569712c23ae4f2996cfb4608a9f9d69d.tar.gz
dreambuilder_modpack-da66780a569712c23ae4f2996cfb4608a9f9d69d.tar.bz2
dreambuilder_modpack-da66780a569712c23ae4f2996cfb4608a9f9d69d.tar.xz
dreambuilder_modpack-da66780a569712c23ae4f2996cfb4608a9f9d69d.zip
copy all standard Dreambuilder mods in from the old subgame
(exactly as last supplied there, updates to these mods will follow later)
Diffstat (limited to 'biome_lib/README.md')
-rw-r--r--biome_lib/README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/biome_lib/README.md b/biome_lib/README.md
new file mode 100644
index 0000000..ce539d1
--- /dev/null
+++ b/biome_lib/README.md
@@ -0,0 +1,30 @@
+# Biome Lib
+
+This library's purpose is to allow other mods to add growing things to the map in a straightforward, simple manner. It contains all the core functions needed by mods and modpacks such as More Trees, Tiny Trees, Plantlife, and others.
+
+Spawning of plants is optionally sensitive to the amount of available light, elevation, nearness to other nodes, plant-to-plant density, water depth, and a whole host of controls.
+
+All objects spawned or generated using this mod use Perlin noise to stay within simple biomes, rather than just letting everything just spread around the map randomly.
+
+This library also features a basic temperature map, which should blend in nicely with SPlizard's Snow Biomes mod (the same Perlin settings are used, with the assumption that the edge of a snow biome is 0° Centigrade).
+
+Both mapgen-based spawning and ABM-based spawning is supported. Growing code is strictly ABM-based. L-system trees can be spawned at mapgen time via the engine's spawn_tree() function and are quite fast.
+
+It is primarily intended for mapgen v6, but it should work fine when used with mapgen v7.
+
+**Dependencies**: default from minetest_game
+
+**Recommends**: [Plantlife Modpack](https://github.com/VanessaE/plantlife_modpack),
+[More Trees](https://github.com/VanessaE/moretrees)
+
+**License**: WTFPL
+
+**API**: This mod supplies a small number of very powerful functions. They are, briefly:
+
+* biome_lib:register_generate_plant()
+* biome_lib:spawn_on_surfaces()
+* biome_lib:grow_plants()
+* biome_lib:find_valid_wall()
+* biome_lib:is_node_loaded()
+
+For a complete description of these functions as well as several of the internal variables within the mod, [read the API.txt document](https://raw.githubusercontent.com/VanessaE/biome_lib/master/API.txt) included in this package.