A minetest mod for mapmaking
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
sys4 4532b2b3c9 Add loading message to action log преди 2 седмици
models Add advanced table assets преди 4 месеца
sounds Add feedback sounds for table-related actions, and make sounds play for everyone преди 3 месеца
textures Add height mode toggle to maps преди 3 месеца
.gitignore Add graphics for 2nd tier table преди 5 месеца
.gitlab-ci.yml Add gitlab CI configuration to run luacheck automatically преди 2 месеца
.luacheckrc Fix remaining luacheck warnings преди 2 месеца
CHANGELOG.md Preparation for release преди 1 месец
LICENSE-ccbysa4 Add license files преди 2 месеца
LICENSE-gplv3 Add license files преди 2 месеца
README.md Add license files преди 2 месеца
audio.lua Documentation pass, part 1 преди 2 месеца
autofill.lua Resolve TODOs преди 1 месец
biome_api.lua Documentation pass, part 1 преди 2 месеца
chunk_api.lua Refactor marker_lookup out of init.lua преди 2 месеца
commands.lua Remove testing command преди 2 месеца
formspec.lua Formspec background fixes преди 1 месец
init.lua Add loading message to action log преди 2 седмици
items.lua Fix luacheck warnings преди 1 месец
map_api.lua Remove unused variable преди 1 месец
map_formspec.lua Fix coordinates being handled incorrectly in some places преди 2 месеца
marker_api.lua Documentation pass, part 2 преди 2 месеца
material_api.lua Documentation pass, part 2 преди 2 месеца
mod.conf Documentation pass, part 2 преди 2 месеца
scanner.lua Fix bounds-checking on marker pages преди 1 месец
screenshot.png Update screenshot: Make logo larger преди 1 месец
screenshot.xcf Update screenshot: Make logo larger преди 1 месец
settingtypes.txt Resolve TODOs преди 1 месец
skin_api.lua table formspec fixes преди 1 месец
storage.lua Add configuration settings преди 2 месеца
table.lua Formspec background fixes преди 1 месец
util.lua Documentation pass, part 3 преди 2 месеца

README.md

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
  4. When integrating into a game, you can use cartographer.skin (skin_api.lua) to re-skin this mod's UI with your own textures and better integrate the mod with your art direction.

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.

Contact

For questions, requests, and other communications regarding this work, you can contact the original creator at hugues.ross@gmail.com

License

Cartographer's code is licensed under the GNU General Public License v3.0. A copy of this license should be bundled with this work, if one was not provided then you can find the license here

Cartographer's visual/audio assets are licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. A copy of this license should be bundled with this work, if one was not provided then you can find the license here