README.md

   1 # Spawn Builder
   2 Version 1.0.0
   3
   4 ## Description
   5 This mod generates a simple stone platform at the world origin
   6 or the static spawn point.
   7 Ideal for the `singlenode` map generator.
   8
   9 ## Usage
  10 Activate this *before* the spawn area got generated (ideally
  11 in a new world), then just join the world.
  12 Recommended to be used in the `singlenode` mapgen, but it works
  13 in other map generators, too.
  14
  15 ### Settings
  16 With the setting `spawnbuilder_width` you can change the width of
  17 the spawn platform. Note that values below 3 are not recommended.
  18
  19 If the static spawn point (`static_spawnpoint`) is set on the
  20 first start of the mod, the platform is centered at this
  21 position instead.
  22
  23 ## Behaviour
  24 This mod generates a stone platform of size 33×2×33 with
  25 a single cobblestone in the center. Also, 3 layers
  26 above the platform are turned into air because the
  27 center position might be buried in the ground.
  28
  29 As a safety measure, nodes with the property
  30 `is_ground_content=false` will never be overwritten.
  31
  32 Also, no platform is generated if the center position is
  33 already in a safe spawn (in air, a few blocks below solid
  34 ground).
  35
  36 ## Dependencies
  37 This mod works with almost all subgames out of the box.
  38
  39 The only requirement is that the subgame defines the mapgen
  40 aliases `mapgen_stone` and `mapgen_cobble` which is almost
  41 certainly the case.
  42
  43 ## License of everything in this mod
  44 MIT License.