]> git.jsancho.org Git - lugaru.git/blob - Docs/DEVTOOLS.txt
Enhancements to devtools input processing code
[lugaru.git] / Docs / DEVTOOLS.txt
1 Lugaru Developer Tools
2 ======================
3
4 Activation
5 ----------
6
7 There are two ways to activate developer tools:
8
9 - Temporary: Pass the --devtools or -d option to the executable
10 - Persistent: Add the following to your config.txt file:
11
12     Devtools:
13     1
14
15 The config.txt file can be found in the following locations:
16
17 - On Linux: ~/.config/lugaru/config.txt
18 - On Mac: ~/Library/Application Support/Lugaru/config.txt
19 - On Windows: C:/Users/yourusername/AppData/Roaming/Lugaru/config.txt
20
21
22 Key bindings
23 ------------
24
25 Note: dev keys must be pressed as if on a QWERTY keyboard.
26
27 General
28 ~~~~~~~
29
30 ~ = console (see "Console commands" section)
31 alt+m = toggle editor mode (see "Map editor" section)
32
33 alt+k = restart challenge
34 shift+k = skip challenge
35
36 alt+h = give 200000 health and reset damage
37 alt+j = toggle snow/grass/desert environment
38 alt+c = toggle camera mode
39 alt+v = toggle freeze
40 alt+b = toggle slow motion
41 alt+n = ragdoll
42 alt+x = change weapon of nearby player [mod: ctrl]
43 alt+u = change yaw (rotation around Z axis) [mod: ctrl]
44 alt+f = put nearby player on fire [mod: ctrl]
45 alt+t = change player skin [mod: ctrl]
46 alt+shift+t = change player type (rabbit/wolf) [mod: ctrl]
47 alt+i = explode nearby head
48 alt+shift+i = explode nearby player
49
50 * Where noted, the ctrl modifier applies the change to the main player,
51   otherwise to the nearest player.
52
53 Map editor (alt+m)
54 ~~~~~~~~~~~~~~~~~~
55
56 o = place object
57 p = place player
58 delete = delete closest object
59 shift+delete = delete closest player
60
61 shift+left/right = change type of next object
62 up/down = change size of next object
63 left/right = change yaw (rotation around Z axis) of next object
64 ctrl+up/down = change pitch (tilt) of next object
65 shift+ctrl+up/down = change map radius
66
67 shift+p = place waypoint
68 ctrl+p = make/connect pathfind waypoint
69 comma/period = select prev/next pathfind waypoints
70 shift+comma = delete pathfind waypoint
71
72
73 Console commands
74 ----------------
75
76 Mapping
77 ~~~~~~~
78
79 map (string) - loads the specified map.
80     The string corresponds to the filename of a map in the Maps folder, located
81     in Lugaru's Data folder.
82 save (string) - saves the state of the current map.
83     The string corresponds to the filename that the map will be saved under in
84     the Maps folder, located in Lugaru's Data folder. Caution: this command
85     will overwrite other maps with the same name without prompting you.
86
87 Character attributes
88 ~~~~~~~~~~~~~~~~~~~~
89
90 wolfieisgod - sets the player to a wolf. You gain all of the speed, strength,
91     durability, and attacks of a wolf.
92 funnybunny - sets the player to a rabbit.
93 size (float) - changes the overall size of your character.
94     The value is based on 1, that is, 1.5 is 50% larger.
95 proportion (float) (float) (float) (float) - changes the proportions of your
96     character. The four floating point values correspond to the proportions of
97     the character's head, body, arm and leg respectively. Each value is based
98     on 1, that is, 1.5 is 50% larger.
99 speed (float) - sets your running speed.
100     Each value is based on 1, that is, 1.5 is 50% faster.
101 strength (float) - sets your attack strength.
102     Each value is based on 1; that is, 1.5 is 50% stronger.
103 power (float) - sets the amount of health you have.
104     Each value is based on 1; that is, 1.5 is 50% healthier.
105 protection (float) (float) (float) - sets your armor strength in terms of blunt
106     resistance. Each floating point corresponds to the strength of your high,
107     medium, or low resistance, respectively. Each value is based on 1; that is,
108     1.5 is 50% more durable.
109 armor (float) (float) (float) - sets your armor strength in terms of sharp
110     attacks. Each floating point corresponds to the strength of your high,
111     medium, or low resistance, respectively. Each value is based on 1; that is,
112     1.5 is 50% more durable.
113 immobile - makes character immobile.
114     May gain some FPS in dialogue levels.
115 mobile - cancels 'immobile'.
116 allimmobile - does as name suggests.
117     May be used when you are done with a dialogue level.
118 armorreset, protectionreset - reset the value of the armor and protection
119     settings for your character.
120 armornear, protectionnear, proportionnear, sizenear - apply the changes to the
121     character nearest to you instead of you.
122 cellophane - makes everyone invisible, except for the shadows.
123
124 Character appearance
125 ~~~~~~~~~~~~~~~~~~~~
126
127 cellar door, rambo, kungfu, white, brown, black - changes your skin to the
128     respective outfit. Note: this command is a little glitchy sometimes. You
129     may have to enter it multiple times before it changes.
130 tintr (float) - sets the redness of your clothes.
131     This only affects the color of future clothes, so you must set it in
132     advance. It must be a value from 0 to 1.
133 tintg (float) - sets the greenness of your clothes.
134     This only affects the color of future clothes, so you must set it in
135     advance. It must be a value from 0 to 1.
136 tintb (float) - sets the blueness of your clothes.
137     This only affects the color of future clothes, so you must set it in
138     advance. It must be a value from 0 to 1.
139 tint (float) (float) (float) - sets the color of your clothes.
140     This only affects the color of future clothes, so you must set it in
141     advance. Each floating point corresponds to red, green, and blue,
142     respectively. Each value must be a number from 0 to 1.
143 noclothes - removes all of your clothes.
144 noclothesnear - same, applied to the character nearest to you.
145 clothes (string) - adds clothes to your character.
146     The string can be one of the following (case sensitive):
147         Shirt
148         LongSleeve
149         EarWrap
150         FootWrap
151         Pants
152         FancyPants
153         Scar
154         HeadBand
155         LeatherWristLeft
156         LeatherWristRight
157         LeatherArmor
158         LeatherPants
159     Actually, these names come from the files in your Data/Lugaru/Textures
160     folder of type ".png". You may add any png file in that folder and use it
161     with the clothes command. See Decal Editing to create such files.
162 clothesnear - does the same for the character nearest to you.
163
164 Skybox
165 ~~~~~~
166
167 skybox - toggles skybox on and off.
168 skytint (float) (float) (float) - sets the color tint of the sky.
169     Each floating point value corresponds to a red, green, or blue value,
170     respectively, between 0 and 1.
171 skylight (float) (float) (float) - sets the color of the lighting of the sky.
172     Each floating point value corresponds to a red, green, or blue value,
173     respectively, between 0 and 1.
174
175 Miscellaneous map
176 ~~~~~~~~~~~~~~~~~
177
178 tutorial (boolean) - toggles tutorial mode on/off for the current map.
179 hostile (boolean) - toggles whether or not characters on the map are hostile.
180 type (string) - sets the initial state of the next character.
181     The possible values are listed below:
182         active
183         sitting
184         sitting wall
185         sleeping
186         dead1
187         dead2
188         dead3
189         dead4
190 path keepwalking/pause - determines whether enemies walk through the next
191     pathpoint or pause briefly.
192
193 Map objectives
194 ~~~~~~~~~~~~~~
195
196 mapkilleveryone - makes objective of the map to kill everyone.
197 mapgosomewhere - makes objective of the map to go somewhere.
198 mapkillsomeone - makes objective of the map to kill a specific enemy.
199 mapkillmost - makes objective of the map to kill everyone but one.
200
201 Hotspots
202 ~~~~~~~~
203
204 hs (size) (type) (string) - creates a hotspot underneath you.
205     The three arguments correspond to the size, type, and text of the hotspot,
206     respectively. See below for the explanations of each type integer:
207         type 0 = static, display text
208         type 1-10 = attached to player 1-10, display text
209         type 11-20 = attached to player 1-10, must kill to win
210         type -1 = win if approached
211 dhs - deletes the last hotspot.
212     An example is "hs 15.0 0 sdf". Note that hotspots are very buggy (TODO:
213     review once bugs are fixed), especially those not of type 0. Quitting and
214     restarting Lugaru, then creating a hotspot in a simple map first, can help.
215     You may have to fiddle around with this. Some strings may be randomly
216     rejected, but if you know how to hex-edit, you can change them directly in
217     the map file (make sure to change the byte before the string to the number
218     of its characters).
219
220 Graphics
221 ~~~~~~~~
222
223 viewdistance (float) - sets the far clipping plane.
224     In other words, it controls how far you can see before the fog obscures it.
225     Its value is based on 1, that is, 1.5 is 50% farther.
226 fadestart (float) - sets what fraction of the viewdistance an object must pass
227     to begin fading. In other words, it controls how far an object has to be
228     before it starts becoming transparent. Its value is based on 1, that is,
229     1.5 is 50% farther.
230
231 Miscellaneous
232 ~~~~~~~~~~~~~
233
234 quit - quits Lugaru.
235 slomo (float) - toggles slow motion on or off.
236     If it's turning on, the game speed is controlled by the floating point
237     value. The value is based on 1, that is, 0.5 is 50% slower than normal game
238     speed.
239 slofreq (integer) - sets the slow motion sound frequency.
240
241 The following commands have unknown effects: metal, sizemin, fixrotation,
242 fixtype.