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 settimane fa
models Add advanced table assets 4 mesi fa
sounds Add feedback sounds for table-related actions, and make sounds play for everyone 3 mesi fa
textures Add height mode toggle to maps 3 mesi fa
.gitignore Add graphics for 2nd tier table 5 mesi fa
.gitlab-ci.yml Add gitlab CI configuration to run luacheck automatically 2 mesi fa
.luacheckrc Fix remaining luacheck warnings 2 mesi fa
CHANGELOG.md Preparation for release 1 mese fa
LICENSE-ccbysa4 Add license files 1 mese fa
LICENSE-gplv3 Add license files 1 mese fa
README.md Add license files 1 mese fa
audio.lua Documentation pass, part 1 1 mese fa
autofill.lua Resolve TODOs 1 mese fa
biome_api.lua Documentation pass, part 1 1 mese fa
chunk_api.lua Refactor marker_lookup out of init.lua 1 mese fa
commands.lua Remove testing command 1 mese fa
formspec.lua Formspec background fixes 1 mese fa
init.lua Add loading message to action log 2 settimane fa
items.lua Fix luacheck warnings 1 mese fa
map_api.lua Remove unused variable 1 mese fa
map_formspec.lua Fix coordinates being handled incorrectly in some places 1 mese fa
marker_api.lua Documentation pass, part 2 1 mese fa
material_api.lua Documentation pass, part 2 1 mese fa
mod.conf Documentation pass, part 2 1 mese fa
scanner.lua Fix bounds-checking on marker pages 1 mese fa
screenshot.png Update screenshot: Make logo larger 1 mese fa
screenshot.xcf Update screenshot: Make logo larger 1 mese fa
settingtypes.txt Resolve TODOs 1 mese fa
skin_api.lua table formspec fixes 1 mese fa
storage.lua Add configuration settings 1 mese fa
table.lua Formspec background fixes 1 mese fa
util.lua Documentation pass, part 3 1 mese fa

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