LEVEL_EDITOR.md

   1 # How to use the Level Editor
   2 The game has a VERY crude level editor which isn't really user-friendly
   3 right now. It works with Minetest chat commands (refer to Minetest help to
   4 learn how they work). Remember you can use "`/help <command>`" for a
   5 syntax reference of a command.
   6
   7 To start, first enter the "`/editor`" command in chat,
   8 then choose a size with "`/editor_size`".
   9 There is no Creative Mode inventory, so you have to give yourself the
  10 blocks with "`/giveme`" or by using a mod.
  11 The Ultra Pickaxe removes blocks.
  12 When you're happy with the level, use "`/editor_save`". The level
  13 will be saved in your world directory (so be careful to not delete
  14 your world!).
  15
  16 To work properly, a level needs to:
  17 * To be solvable (duh!)
  18 * At least one treasure chest (locked or unlocked)
  19 * Exactly ONE teleporter in "off" state (`lzr_teleporter:teleporter_off`)
  20   (The player starts here, it also acts as a simple game menu when punched)
  21
  22 Do not mind the wooden boundary of the level, this is a dummy that will
  23 be replaced with the material specified in the level list, it is NOT
  24 part of the level file. Instead, the level border nodes are specified in the
  25 level list (see below).
  26
  27 To test a custom level, use "`editor_load`" and then "`editor exit`".
  28 Note this is still quite buggy. The game doesn't really support playing
  29 custom levels well, sorry. :(
  30
  31 ## Adding the level to the game
  32 If you think you made a nice level, send it to Wuzzy per e-mail at
  33 Wuzzy@disroot.org. This game desperately needs more levels, so submissions
  34 are appreciated. :D
  35
  36 If you don't want to wait for Wuzzy and add the level manually on your own
  37 computer, so that it appears in your level list, you must copy the level
  38 `.mts` file to `mods/lzr_levels/schematics`,
  39 give it a proper file name and then add a line to
  40 `mods/lzr_levels/data/level_data.csv`.
  41
  42 A line follows this format:
  43
  44     <file name>,<level name>,<border list>,<ambience>
  45
  46 where:
  47
  48 * `<file name>`: File name of the level `.mts` file
  49 * `<level name>`: Name of the level as shown to the player, in English
  50 * `<border list>`: List of border blocks, see below
  51 * `<ambience>`: Ambient sounds. Either `ocean`, `temple` or `none`.
  52
  53 Border list is a list of nodes used for the level border.
  54 It contains 1-4 node names, separated by `|`. The border nodes are, in this order:
  55
  56 * Wall|Window|Floor|Ceiling
  57
  58 Wall is mandatory, the rest is optional. If window, floor or ceiling are missing,
  59 they will the same as wall.