General Documentation        

General Documentation


The Grit Game Launcher (Grit.exe) captures log output from the game while it is running. It is located at %GRITROOTFOLDER%\grit_core\media. You can save the log which can be helpful when reporting bugs or troubleshooting on the forum or irc rooms. You can also change some basic options in the 'options' menu. Click 'launch' to start the game.

Using The Console, Changing Settings and Bindings

Toggle the console with the 'tab' key. In the console you can execute arbitrary Lua code. Note that all commands are case sensitive. You can quit the game using alt+F4 (in windows) or whatever you normally use to quit in Linux. You can toggle fullscreen with alt+enter.

You can tweak the current configuration using the user cfg table from the console. Dump the current settings like this:

 lua> user_cfg

As an example, many people will want to change mouse invert. To see what the current value is:

 lua> user_cfg.mouseInvert

To change it, type the following:

 lua> user_cfg.mouseInvert = false

With the console hidden you can fly around using WASD and the mouse. You can float up and down with 'space' and 'shift'.

These configurations will be saved as the game exits, to a file called user_cfg.lua. This contains all the settings and key bindings that casual users can modify between runs of the program. Open the file in a text editor for more information. It will not exist until you have run the game at least once.



Start the game and type

 lua> include `playground/init.lua`

This loads JostVice's test map which has a short road loop a warehouse and a (dry) river bed. There is a waterfall and some other random stuff.


Start the game and type

 lua> include `urban/init.lua`

This loads Brian's urban/suburban scene.


Start the game and type

 lua> include `wipeout/init.lua`

This loads a futuristic race track by Johnline.

Top Gear Track

Start the game and type

 lua> include `top_gear/init.lua`

This loads a large plane of an airfield (the Top Gear Test Track) with some google map imagery. There are some vehicles and a plane to play with.



Most of the keys on the keyboard (avoid the F1-F12 keys) (also avoid the 'F' key itself) will place objects in the direction you are pointing. You can fire them by holding down 'ctrl' and holding down the right mouse button will increase the speed of the projectile. Hold down 'alt' to also spin the projectile. Static objects can only be placed, they cannot be fired because they cannot move. For these objects ctrl and alt will change the type of object being placed.

If you're curious you can look in common/init.lua and see what the keybindings actually are.

Placing Specific Objects

You can place an object by pointing at (preferably flat) ground. Try the number keys (1234567890) first. Experiment with other keys on the keyboard.

You may also place a given class like this:

 lua> place `/common/veg/Tree_aelm`

If you want some additional z offset (e.g. 1 metre) on the placed object, you can get that by doing:

 lua> place(`/common/veg/Tree_aelm`,1)

To experiment with the physics engine, you can place a jenga stack with:

 lua> jenga()

You can place bowling pins with:

 lua> bowling()

If you have a fast CPU, try:

 lua> wall()


To drive a car, point at it and press 'F'. You can now drive with 'WASD' and look around with the mouse. You can execute handbrake turns with 'space'. Exit the car again with 'F'. You can right an upside-down car with 'enter'. Holding down 'S' and 'space' will lock the wheels and the car will skid to a halt.

The cars have different handling characteristics.

At night their headlights come on when being driven (for cars that have this added). You can point at a parked car and 'unpark' it, without having to get inside, by doing

 lua> pick_obj().instance.parked = false


Enter a plane like a car. The arrow keys control the ailerons and elevators. W and S control the throttle. Backspace raises/lowers the landing gear. A and D are the rudder.

See also