Documentation Update for Minecraft 1.13 / Mapcrafter vNext

[ligos]

This is where documentation changes for mapcrafter are being tracked.

My main goals:

• Add example images to config file page
• Improve the getting started instructions
• General tidy-up

@m0r13 is still the owner and developer of Mapcrafter (and a very fine job he's doing). I'm just taking the drudge work of revising, updating and improving documentation off his hands.

Here's the detailed list I'm tracking. I'll create PRs for them as I go.

• Remove old / obsolete features
  • preblit water
  • Config texture_dir - blockcrafter
  • Config texture_blur - blockcrafter
  • Config water_opacity - blockcrafter
  • Config render_leaves_transparent - blockcrafter
  • Config render_unknown_blocks - to be always true??
  • world:crop_unpopulated_chunks
• Add new features
  • side render view
  • map:block_dir - to pick up spritemaps generated by blockcrafter
• Improve installation instructions / make it easier to get started
  • docker instructions
  • "hello world" steps
  • Improve Windows instructions
  • Sample / example config files included in source / packages on example Wiki and config page
  • OSX Homebrew dramas when building from source
• Example images against config file options
  • Each map:render_view
  • Each map:render_mode
  • Each map:overlay
  • Each map:rotations
  • map:texture_size - no pictures in the end
  • map:tile_width - no pictures, but did re-write the section
  • map:lighting_intensity
  • map:lighting_water_intensity
  • map:render_biomes
  • Each world:dimension
  • A few world:crop* examples
  • Revise world:block_mask for Minecraft 1.13
  • A few marker:* examples
• Example maps + config files (aiming for ~5 with various differences)
• Blockcrafter instructions for custom resource packs / block sizes
• Regarding pre 1.13 maps
  • Very clear doco: they aren't supported
  • Code to fail (reasonably) gracefully
• Review each doc page for general style and readability
  • Index
  • Installation
  • Using Mapcrafter - planning to split into Command Line Reference and new Getting Started page
  • Configuration
  • Logging
  • Markers

[m0r13]

Removed features are: texture_dir (no textures need to be extracted for Mapcrafter and loaded anymore at all), texture_blur (handled by blockcrafter), water_opacity, render_leaves_transparent (would be blockcrafters responsibility too), maybe render_unknown_blocks (as with all blocks theoretically supported unknown blocks are really a special thing you'd want to see) too.

The directory with generated block images (block_dir in map config) is also a new important thing to describe.

The example images for possible configuration setting sound good, but try to keep it manageable/readable with not too many images. Maybe it would be even enough to have images only for some of the main settings (like render view, render mode, rotation, texture_size), the remaining small options could be still figured out by advanced users.

These are my few notes on your ideas, otherwise it sounds good!

[ligos]

I've updated the various obsolete / new options.

Understood about the config images - my plans were to keep them small and contrasting. That is, for things like render_view it will be a composite image with each option side-by-side. Enough for people to get an idea of the differences. I guess I'll see how well that works out!

[ligos]

@m0r13 Pushed my first round of changes focusing on the map configuration section. Example images are up for relevant items.

I plan to make my test world public, once I consolidate some of the testing I'm doing.

Oh, and I managed to get Mapcrafter to allocate ~3GB of ram with tile_width = 16! Seriously though, tile_width = 4 should make Windows considerably happier.

[m0r13]

Hmm could you perhaps just create a pull request on the main Mapcrafter repo so I can easily see your changes? There are so many things coming in these days and my time is very limited, I really need all things to be easily accessible in one place.