Maps, ... yeah I love maps!
So why is there no direct support for maps?
Well that is because it is not yet scheduled into the planning. And it is quite a bit of work to do it right.
This post is here to collect all the information about maps.
What already exists?
- UristMaps: A very nice leaflet based worldmap for DF. You can zoom and look around and plot some information on the map.
- IsoWorld: (gitrepo) A lovely isometric view of the world. It looks fantastic!
What will DF Storyteller get?
Currently we are planning on creating a map visualizer similar to OpenStreetMap. It uses Leaflet to render the maps. An alternative is Mapbox GL. They both support Mapbox vector tiles (some might work better then others). Vector tiles are like SVG type images. So they allow the user to customize the lines that it draws. This way we can create a zoom-able map with having to pre-render the images beforehand.
I have had worked on some Vector tiles maps before and they have some problems with higher zoom levels because of shape simplification or data size. But as the Dwarf Fortress world is not the same size as the actual worldmap this might be less or not even a problem for us. We will have to do tests before we can be sure though.
So what does this mean for the maps in DF Storyteller?
This way we allow the visualizers to customize the maps as they please and allow filtered data to be visualized very easily. We will provide the needed examples for users to pull this off and get them going. But the results should be wonderful.
When are you getting started on this?
This feature is not planned as we first want to stabilize the base API and give users a good experience there. If we start working on the map, the basic features of the API might not even get used or might not be as stable as we want it to be. So this feature is still at least a few months away even if we started working on it now.
What about the planned map rewrite in Dwarf Fortress?
We don't know the exact plans of what is going to change for us and how this will effect this project. And we don't know when it is going to happen. So a soon as we get more info that is relevant to use we will change our plans accordingly (if needed).
How will this change the current API?
Well we don't know for sure but we hope there are not going to be any breaking changes. There might be additional information provided but it could also be that it is separated from the existing API.
But what can we use now?
There is some coordinate data inside the API already. This in combination with the exported images can be used to create a temporary map for current projects.
What data will be included in the new map API?
We are planning on giving you all the data that we can extract from the images and other exported files. We will combine all the different images and allow you to query the data as you want. This includes displaying names, getting border outlines, elevation data, biomes, rain, evil, site maps, ... Data will be available both in API form and Vector tiles.
Can I help somehow?
Help use find the needed info, create tests and examples. But most importantly help test and stabilize the existing API so we can start working on this.
This post will be update as we get more info or have updates for you.