LEVELDESIGN

   1
   2 - Level editing for SuperTux -
   3 http://super-tux.sf.net/
   4
   5 Last update: April 26, 2004
   6
   7 This document describes both the level format and
   8 the level editor.
   9
  10 = LEVEL FORMAT =
  11
  12 The level format used to be pretty easy to understand, but it
  13 is now more complex.
  14 Anyway, should be pretty usefull to know a bit of it, when you
  15 want to do stuff just as to just change the author's name or
  16 something small.
  17
  18 It uses the Lisp syntax and is pretty intuitive. Here have a
  19 look at a quotation:
  20 (Comments can be made using ';')
  21
  22 ; This is a comment!
  23 (supertux-level
  24 ; a few level's info: version, author and level's name
  25   (version 1)
  26   (author "Ingo Ruhnke")
  27   (name "Night Chill")
  28 ; number of tiles used (currently the height has to be 15)
  29   (width  515)
  30   (height 15)
  31 ; Tux starts position
  32   (start_pos_x    100)
  33   (start_pos_y    170)
  34 ; Background image, if any is specified, the color below will be used
  35   (background "")
  36 ; Music file
  37   (music "Mortimers_chipdisko.mod")
  38 ; Colors, as you can see you can have different colors in the top
  39 ; and in the bottom, thus creating a gradient
  40   (bkgd_red_top    0)
  41   (bkgd_green_top  0)
  42   (bkgd_blue_top   0)
  43   (bkgd_red_bottom    120)
  44   (bkgd_green_bottom  120)
  45   (bkgd_blue_bottom   0)
  46 ; Time (it is not in seconds!)
  47   (time  300)
  48 ; Gravity to be used (you should let it stay in 10 for ordinary levels)
  49   (gravity  10)
  50 ; The particle system allows that images can be displaying simulating weather
  51 ; In the writing of this text, both "snow" and "clouds" are supported
  52   (particle_system "snow")
  53 ; Theme is the tiles look that are used
  54   (theme "antarctica")
  55   (interactive-tm
  56 ; here goes a lot of numbers that are the tiles places
  57   )
  58 ; Reset points, there can be more than one
  59 ; Reset points are positions where the player passes through and
  60 ; if he dies, he will be back to there. They are invisible
  61   (reset-points
  62     (point (x 6988) (y 222))
  63    )
  64 ; Objects include enemies, may include more stuff in the future
  65 ; just as moving plataforms...
  66   (objects
  67     (mriceblock  (x 13919) (y 384))
  68     (mriceblock  (x 14258) (y 366))
  69     (mriceblock  (x 12996) (y 248))
  70     (mriceblock  (x 13058) (y 250))
  71     (mriceblock  (x 12933) (y 245))
  72   )
  73    )
  74
  75
  76 = LEVEL EDITORS =
  77
  78 USING THE BUILT-IN LEVEL EDITOR:
  79 --------------------------------
  80
  81 When opening the leveleditor, a menu will appear. This
  82 menu can be used to select or add level subsets.
  83 A level subset is a collection of levels. Subsets can be chose
  84 during gameplay when starting a game.
  85
  86 After selecting the subset, have a look at the level editor.
  87 The button bar in the right is the place where you can control
  88 the actions related with editing. You can select levels and add
  89 throught there.
  90 To select tiles (foreground or background) and enemies, the button
  91 bar is the right place. There you can also save, test and setup
  92 the level. It is also possible between two selection cursors! Give
  93 a try to both.
  94 A right click in a button bar button will give you a description
  95 and a shortcut for it.
  96
  97 To change a tile, just press the tile you want to change with a
  98 mouse left click. The current tile will be used. Depending
  99 on the selection behavior, you can or not select more
 100 than one tiles.
 101 To scroll, you just have to point over the two arrow buttons, or
 102 use the right button click.
 103
 104 There is a small help that can be reached by pressing F1.
 105
 106 To go back to the menu, just press Esc.
 107
 108 The levels are saved under a .supertux/levels directory in
 109 your home directory.
 110
 111 FIXME: this description of the built-in level editor are
 112 out dated. Anyway, it is yet being developed.
 113
 114 USING FLEXLAY:
 115 --------------
 116
 117 FlexLay is an external project (it even uses different libraries)
 118 that is developed by Ingo Ruhnke and supports a lot of different
 119 games, including SuperTux (or else we wouldn't mention it :) ).
 120
 121 Anyway, it is pretty easy to use and a lot more advanced than
 122 the internal one. So, if you are considering in doing a few levels
 123 for us, it may be a good idea to check this out.
 124
 125 There isn't currently any webpage for it, just go to our webpage and
 126 you should find a download of this program.
 127
 128 The only cons it has is that you have to have an accelerated
 129 videocard (with the drivers working, obviously). Anyway shouldn't
 130 be a problem nowadays.
 131 For linux, we advise nvidia videocards with the use of nvidia's closed
 132 drivers. ATI drivers should be enough to run this game though.
 133
 134
 135 = CONCLUSION =
 136
 137 To sum up, go and do lots of levels and HAVE FUN!!
 138
 139 Please, send your levels or any art you created to the SuperTux's
 140 mailinglist or to the maintainer (look at AUTHORS).
 141
 142
 143 - SuperTux developers