nalc/cartographer
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
A minetest mod for mapmaking
94 Commits 1 Branch 0 Tags 616 KiB
Lua 63.1%
Wavefront Object 36.9%
81142b72d0
Go to file
Hugues Ross 81142b72d0 Add README
2020-06-13 09:30:03 -04: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
audio.lua Documentation pass, part 1 2020-06-13 07:41:56 -04:00
autofill.lua Documentation pass, part 1 2020-06-13 07:41:56 -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 Add cartographer privilege for using the /map command 2020-06-13 09:08:01 -04:00
formspec.lua Documentation pass, part 1 2020-06-13 07:41:56 -04:00
init.lua Documentation pass, part 2 2020-06-13 08:50:36 -04:00
items.lua Documentation pass, part 2 2020-06-13 08:50:36 -04:00
map_api.lua Documentation pass, part 2 2020-06-13 08:50:36 -04:00
map_formspec.lua Documentation pass, part 2 2020-06-13 08:50:36 -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
README.md Add README 2020-06-13 09:30:03 -04:00
scanner.lua Documentation pass, part 2 2020-06-13 08:50:36 -04:00
skin_api.lua Documentation pass, part 2 2020-06-13 08:50:36 -04:00
storage.lua Documentation pass, part 2 2020-06-13 08:50:36 -04:00
table.lua Documentation pass, part 3 2020-06-13 08:54:13 -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

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.