Fix for coverity #29369
[supertux.git] / docs / worldmapformat.txt
1
2 - World Map editing for SuperTux -
3 http://supertux.lethargik.org/
4
5 Last update: September 4, 2004
6
7 This document describes how to edit a world map.
8
9 = EDITING WORLDMAP TILES =
10
11 To edit a World Map, please use FlexLay. Thought it might have problems with
12 the editing of level and special tiles, since it isn't sync with CVS.
13
14 = INTRODUCTION =
15
16 These things are always changing, so if even 0.1.x has something like something
17 described here, it might have a different name or be used in a different way.
18
19 Stuff prefixed by a ';' are comments.
20
21 ; This is a comment! :)
22
23 = MAKING THE HOLE FOR A LEVEL =
24
25 ; Opening level group
26 (level
27
28 ; X and Y position [NECESSARY]
29  (x 10)
30  (y 14)
31
32 ; Filename of the level [NECESSARY]
33  (name "file_name.stl")
34
35 ; Flip the level vertically - default: false
36  (vertical-flip #t)
37
38 ; Show this text file after completing this level
39  (extro-filename "filename")
40
41 ; Go to this world after completing this level
42  (next-worldmap "worldmap.stwt)
43
44 ; Exit world map after completing this level
45  (quit-worldmap #t)
46
47 ; Disable auto walking after completing the level - default: false
48  (auto-path #f)
49
50 ) ; end of level group
51
52
53 = AVAILABLE SPECIAL TILES =
54
55 ; Opening special-tile group
56 (special-tile
57
58 ; X and Y position [NECESSARY]
59  (x 10)
60  (y 14)
61
62 ; Add a message tile. You can also use this together with a teleporter.
63  (map-message "Hello World!"
64
65 ; Instead of showing a fix message, show while the player
66 ; passes by [NEEDS: map-message]- default: false
67  (passive-message #t)
68
69 ; Apply action only in this/these direction(s) [WORKS FOR: passive-message] -
70 ; default: true for all - possible values: north/south/east/west.
71 ; More than one can be used with a separator or not
72  (apply-to-direction "north-east")
73
74 ; Add a teleporter tile to
75  (teleport-to-x 20)
76  (teleport-to-y 13)
77
78 ; Don't show this tile [WORKS FOR: teleporter, map-message]
79  (invisible-tile #t)
80
81 ) ; end of special-tile group
82
83
84     - SuperTux developers