1SUPERTUX2(6)                         Games                        SUPERTUX2(6)
2
3
4

NAME

6       supertux2 - SuperTux, a classic jump'n'run platformer featuring Tux
7

SYNOPSIS

9       supertux2 [options]
10       supertux2 [options] level.stl
11       supertux2 [options] worldmap.stwm
12

DESCRIPTION

14       SuperTux  is  a  classic  style 2D platform game.  Run and jump through
15       multiple worlds, fighting off enemies by jumping on them, bumping  them
16       from  below  or  tossing  objects at them, grabbing power-ups and other
17       stuff on the way.
18

OPTIONS

20       These programs follow the usual GNU command line syntax, with long  op‐
21       tions starting with two dashes (`-').  A summary of options is included
22       below.
23
24       -h, --help
25              Show this help message
26
27       -v, --version
28              Show SuperTux version and quit
29
30       --verbose
31              Print verbose messages
32
33       --debug
34              Print extra verbose messages
35
36       --print-datadir
37              Print SuperTux's primary data directory.
38
39       --acknowledgements
40              Print the licenses of libraries used by SuperTux.
41
42       -f, --fullscreen
43              Run in fullscreen mode
44
45       -w, --window
46              Run in window mode
47
48       -g, --geometry WIDTHxHEIGHT
49              Run SuperTux in given resolution (eg. -g 800x600)
50
51       -a, --aspect WIDTH:HEIGHT
52              Run SuperTux with given aspect ratio (eg. -a 4:3)
53
54       -d, --default
55              Reset video settings to default values (-g 800x600 -a auto -w)
56
57       --renderer RENDERER
58              Render the game using the specified video renderer. Valid values
59              are sdl, opengl20, opengl33, and auto (the default).
60
61       --disable-sound, --disable-sfx
62              Disable sound effects
63
64       --disable-music
65              Disable music
66
67       --edit-level
68              Open given level in editor
69
70       --resave
71              Loads given level and saves it
72
73       --show-fps
74              Display framerate in levels
75
76       --no-show-fps
77              Do not display framerate in levels
78
79       --show-pos
80              Display player's current position
81
82       --no-show-pos
83              Do not display player's position
84
85       --christmas
86              Enable Christmas mode outside Christmas times
87
88       --no-christmas
89              Disable Christmas mode during Christmas times
90
91       --developer
92              Enable developer features
93
94       -s, --debug-scripts
95              Enable script debugger.
96
97       --spawn-pos X,Y
98              Where  in the level to spawn Tux. Only used if [level] is speci‐
99              fied.
100
101       --sector SECTOR
102              Spawn Tux in SECTOR
103
104       --spawnpoint SPAWNPOINT
105              Spawn Tux in SPAWNPOINT
106
107       --record-demo FILE LEVEL
108              Record a demo to FILE
109
110       --play-demo FILE LEVEL
111              Play a recorded demo
112
113       --datadir DIR
114              Set the directory for the games datafiles
115
116       --userdir DIR
117              Set the directory for user data (savegames, etc.)
118
119       --repository-url URL
120              Set the URL to the Add-On repository
121

ENVIRONMENT

123       SUPERTUX2_USER_DIR
124              Directory for user data (savegames, etc.)
125
126       SUPERTUX2_DATA_DIR
127              Directory for the games datafiles
128

FILES

130       ~/.local/share/supertux2, ~/.supertux2
131              Contains configuration and savegames.  Also acts as  an  overlay
132              of  the SuperTux game data path: Files placed here will override
133              or supplement game data files.
134

EXAMPLES

136       To play level /tmp/mylevel.stl in a window of  size  800x600,  run  the
137       program like this:
138
139              supertux2 --window --geometry 800x600 /tmp/mylevel.stl
140
141       To   play   a  previously  recorded  demo  /tmp/mylevel.demo  of  level
142       /tmp/mylevel.stl, run SuperTux like this:
143
144              supertux2 --play-demo /tmp/mylevel.demo /tmp/mylevel.stl
145
146       Custom-made levels can be  conveniently  stored  in  the  overlay  data
147       folder.
148
149       ~/.supertux2/levels/sample_collection/level01.stl
150              (supertux-level
151                (version 2)
152                (name (_ "Sample Level"))
153                (author "Myself")
154                ...
155
156       Make sure to also create an "info" file, so the collection will be rec‐
157       ognized by SuperTux.
158
159       ~/.supertux2/levels/sample_collection/info
160              ;SuperTux-Level-Subset
161              (supertux-level-subset
162                (title "Sample Collection")
163                (description "")
164              )
165
166       For easier distribution, the level collection can be bundled in  a  Zip
167       archive.
168
169       ~/.supertux2/sample_collection.zip
170              levels/sample_collection/info
171              levels/sample_collection/level01.stl
172               ...
173

BUGS

175       This is a development version, so expect plenty of bugs.
176

AUTHOR

178       This  manual  page was written by the SuperTux Devel Team and is placed
179       in the public domain.
180
181
182
183SuperTux 0.6.3                 December 20, 2021                  SUPERTUX2(6)
Impressum