nalc
/
cartographer
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add README

This commit is contained in:
Hugues Ross 2020-06-13 09:30:03 -04:00
parent dd5a620393
commit 81142b72d0
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md Normal file
View File

@ -0,0 +1,15 @@
# Cartographer
A Minetest mod that provides the necessary framework for crafting maps of the local environment from various resources. The mod is structured as an API of sorts, to allow it to be used with any game where such concepts are sensible.
## How to set up Cartographer
Since Cartographer is an API, it needs at least one additional mod in order to function in your world. There are example mods available for Minetest Game and Repixture, and you can make your own to extend these or support other games of your choosing.
The process of making such a mod is pretty straightforward:
1. Register every biome in your game with cartographer, by calling `cartographer.biomes.add`, listing the biome, texture names to use for each detail level, and an optional min/max height for those textures to be used.
2. Register items/item groups that provide "paper" and "pigment" for mapmaking, by calling `cartographer.materials.register_by_name` or `cartographer.materials.register_by_group`. You can optionally specify how much of a material to provide per-item, or let it provide 1 unit by default.
3. Add crafting recipes or other ways of acquiring the following nodes:
- cartographer:simple_table
- cartographer:standard_table
- cartographer:advanced_table
It's worth looking in the code to see what other options the cartographer API offers. If your mod/game would benefit from another means of acquiring or displaying maps, you can use the API to create your own crafting systems and mapping items.