A minetest mod for mapmaking
Ir al archivo
Sys Quatre 4532b2b3c9 Add loading message to action log 2020-07-23 16:04:12 +02:00
models Add advanced table assets 2020-03-29 20:34:48 -04:00
sounds Add feedback sounds for table-related actions, and make sounds play for everyone 2020-04-18 11:29:09 -04:00
textures Add height mode toggle to maps 2020-04-21 07:36:48 -04:00
.gitignore Add graphics for 2nd tier table 2020-02-25 20:23:09 -05:00
.gitlab-ci.yml Add gitlab CI configuration to run luacheck automatically 2020-06-01 07:33:57 -04:00
.luacheckrc Fix remaining luacheck warnings 2020-06-10 20:10:15 -04:00
CHANGELOG.md Preparation for release 2020-06-27 11:26:18 -04:00
LICENSE-ccbysa4 Add license files 2020-06-13 09:40:58 -04:00
LICENSE-gplv3 Add license files 2020-06-13 09:40:58 -04:00
README.md Add license files 2020-06-13 09:40:58 -04:00
audio.lua Documentation pass, part 1 2020-06-13 07:41:56 -04:00
autofill.lua Resolve TODOs 2020-06-13 16:50:34 -04:00
biome_api.lua Documentation pass, part 1 2020-06-13 07:41:56 -04:00
chunk_api.lua Refactor marker_lookup out of init.lua 2020-06-13 08:01:56 -04:00
commands.lua Remove testing command 2020-06-13 16:25:28 -04:00
formspec.lua Formspec background fixes 2020-06-26 18:02:18 -04:00
init.lua Add loading message to action log 2020-07-23 16:04:12 +02:00
items.lua Fix luacheck warnings 2020-06-27 13:54:01 -04:00
map_api.lua Remove unused variable 2020-06-13 17:15:47 -04:00
map_formspec.lua Fix coordinates being handled incorrectly in some places 2020-06-13 11:50:43 -04:00
marker_api.lua Documentation pass, part 2 2020-06-13 08:50:36 -04:00
material_api.lua Documentation pass, part 2 2020-06-13 08:50:36 -04:00
mod.conf Documentation pass, part 2 2020-06-13 08:50:36 -04:00
scanner.lua Fix bounds-checking on marker pages 2020-06-27 13:45:44 -04:00
screenshot.png Update screenshot: Make logo larger 2020-06-27 14:55:49 -04:00
screenshot.xcf Update screenshot: Make logo larger 2020-06-27 14:55:49 -04:00
settingtypes.txt Resolve TODOs 2020-06-13 16:50:34 -04:00
skin_api.lua table formspec fixes 2020-06-26 17:52:01 -04:00
storage.lua Add configuration settings 2020-06-13 16:21:34 -04:00
table.lua Formspec background fixes 2020-06-26 18:02:18 -04:00
util.lua Documentation pass, part 3 2020-06-13 08:54:13 -04:00

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