VDrift - User contributions [en]

Main Page

2012-08-26T18:18:33Z

Venzon:

[[Image:vdrift_logo.png]]

='''VDrift Wiki'''=

Welcome to the [[Project:About|VDrift Wiki]].

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''[[:Category:General Info|General Info]]'''
*[[About the project]]
*[[Authors and contributors]]
*[[License]]
*[[Contributing]]
*[[Useful links]]
|width="250px"|'''[[:Category:Installation|Installation]]'''
*[[Requirements]]
*[[Downloading]]
*[[Installing]]
|}

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''[[:Category:Configuration|Configuration]]'''
*[[Configuring the display]]
*[[Configuring the sound]]
*[[Configuring the controls]]
*[[Logitech G25 support]]
*[[Setting up force feedback]]
|width="250px"|'''[[:Category:Playing|Playing]]'''
*[[Replays]]
*[[Drifting Techniques]]
*[[Drift scoring]]
|}

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''[[:Category:Files|Files]]'''
*[[User settings directory]]
*[[Data directory]]
*[[VDrift.config]]
*[[Adding video modes|videomodes]]
*[[options.config]]
*[[Sound/graphics formats]]
*[[JOE format]], [[JOEPack format]]
*[[Configfile format]]
*[[Menu system|Menu file format]]
|width="250px"|'''[[:Category:Development|Development]]'''
*[[Getting the development version]]
*[[Working with the development version]]
*[[Compiling]]
*[[Packaging]]
*[[Testing]]
*[[Debugging]]
*[[Coding Guidelines]]
*[[Source code documentation]]
*[[Numerical Integration]]
|}

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''[[:Category:Cars|Cars]]'''
*[[Getting cars]]
*[[Car files and formats]]
*[[Creating cars]]
*[[Car parameters]]
*[[3D modelling]]
|width="250px"|'''[[:Category:Tracks|Tracks]]'''
*[[Getting tracks]]
*[[Track files and formats]]
*[[Creating tracks]]
*[[Importing Racer tracks]]
|}

Compiling VDrift

2011-12-13T05:05:20Z

Venzon: /* Optional: Compile Options */

Compiling VDrift depends upon the build environment beeing set up correctly. See [[Getting VDrift]].

Compiling VDrift makes it possible to [[Installing|Installing VDrift]].

Compiling VDrift is different depending on the operating system on which it is compiled. So follow the applicable passage.

= Compiling on FreeBSD =

To compile VDrift on FreeBSD, use the ports system.

== Latest Release ==

If you downloaded a release, simply run <code>make</code> on the '''vdrift''' port:

cd /usr/ports/games/vdrift && make install clean clean-depends

== Development Version ==

If you Downloaded the development version, copy the '''vdrift''' and '''vdrift-data''' ports to '''vdrift-devel''' and '''vdrift-data-devel''':

cd /usr/ports/games && cp -rf vdrift vdrift-devel && cp -rf vdrift-data vdrift-data-devel

To compile, run <code>make</code> on the newly-created '''vdrift-devel''' port:

cd /usr/ports/games/vdrift-devel && make install clean clean-depends

= Compiling on Linux =

== Prerequisites ==

The required build tools include:

* '''g++''' - The GNU C++ compiler
* '''scons''' - A replacement for Make

The required libraries include:

* '''libsdl''' - Simple Direct Media Layer
* '''libglew''' - OpenGL extension utilities
* '''sdl-gfx''' - Graphics drawing primitives library for SDL
* '''sdl-image''' - Image file loading library for SDL
* '''vorbisfile''' - File loading library for the ogg vorbis format
* '''libvorbis''' - The Vorbis General Audio Compression Codec
* '''libbullet''' - Bullet Physics Library
* '''libcurl''' - the multiprotocol file transfer library
* '''libarchive''' - library for reading and writing archive formats
* Boost C++ Libraries (header-file-only)
* ASIO C++ Libraries (header-file-only)

Make sure you have all the required libraries and build tools. Make sure you also have the development files for each of the libraries. Your Linux distribution may have different package names and/or bundled differently. The list above should give enough information to search for applicable packages within your distribution's package manager.

=== Bullet ===

For the 2009-02-15 release, the only step required is to expand the Bullet source archive:
tar zxvf bullet-2.73-sp1.tgz

{{note|For older versions of VDrift, you will need to follow the [[Old Method of Compiling Bullet]].}}

Ubuntu does not include a libbullet package, but getdeb does. To add the
getdeb-repository to your sources-list.d:

wget -q -O - http://archive.getdeb.net/getdeb-archive.key | sudo apt-key add -
sudo sh -c 'echo "deb http://archive.getdeb.net/ubuntu natty-getdeb games" > /etc/apt/sources.list.d/getdeb.list'
sudo apt-get update

=== LibGLEW ===

{{note|VDrift requires libglew version greater than 1.5.3.}}

Ubuntu 11.04 (Natty Narwhal) does contain libglew1.5, only. To install
libglew1.6 and its development headers:

wget http://archive.ubuntu.com/ubuntu/pool/universe/g/glew/libglew1.6_1.6.0-3_amd64.deb
sudo dpkg -i libglew1.6_1.6.0-3_amd64.deb
rm libglew1.6_1.6.0-3_amd64.deb

wget http://archive.ubuntu.com/ubuntu/pool/universe/g/glew/libglew1.6-dev_1.6.0-3_amd64.deb
sudo dpkg -i libglew1.6-dev_1.6.0-3_amd64.deb
rm libglew1.6-dev_1.6.0-3_amd64.deb

=== Ubuntu 8.04 ===

For Ubuntu 8.04 you additionally need:
sudo apt-get install libboost-date-time-dev libboost-regex-dev

=== SCons ===

As of the 2005-10-02 release, VDrift no longer uses ./configure, make, etc. (autotools). Now the project is built with [http://scons.org/ SCons]. You may want to read a little about [[Using SCons]].

There are two ways to use SCons. The first way is to install scons on your system through your package manager, then you can use it simply by the name of the program, "scons". If you followed the directions for installing prerequisites for Ubuntu above, then you're done and can continue on to the next section. The second way is to use the scons-local package (included with VDrift) which will do the same thing but doesn't require that you install scons on your system. To do this, you must move the scons-local-0.96.95.tar.gz archive from tools to the root vdrift folder, un-tar the archive, and then use the <code>./scons.py</code> command instead of <code>scons</code>.

=== All other Packages ===

All other required packages can be installed using this command:

sudo apt-get install g++ libarchive-dev libarchive-dev libasio-dev \
libboost-dev libcurl4-gnutls-dev libdrm-dev \
libgl1-mesa-dev libglu1-mesa-dev libkms1 \
mesa-common-dev libsdl-gfx1.2-dev libsdl-image1.2-dev \
libsdl-net1.2-dev libvorbis-dev freeglut3 libbullet0 \
libbullet-dev scons

== Optional: Using scons-local instead of installing SCons ==

If you have decided not to install SCons on your system, you can use scons-local. To set it up, do the following:

tar zxvf tools/scons-local-0.96.1.tar.gz

{{note|Some of the following steps refer to the <code>scons</code> command, you should now replace that with <code>./scons.py</code>.}}

== Compiling ==

To compile VDrift, just use the <code>scons</code> command.
scons

=== Optional: Compile Options ===

You can use one or more compile options. To compile with optimization for a certain platform, you can use the '''arch''' option.
scons arch=a64
Compiling VDrift in '''release''' mode will turn off debugging options, and enable more compiler optimizations. VDrift runs much more quickly in release mode.
scons release=1
To enable force feedback, use this option:
scons force_feedback=1
You can get a list of all compile time options with:
scons --help
{{note|These options are probably best left off the first time you compile. If you have problems compiling or running VDrift, it is easier to debug with them off. Once you verify that VDrift is compiling, then recompile with these optimizations to improve performance.}}

== Installing ==

VDrift does not need to be installed to work and you can run it from the folder where you compiled it. If you do want to install, use the SCons build target '''install'''. This command must be run as root.
sudo scons install

{{note|The <code>scons install</code> process was broken for several releases including the 2009-02-15 release and may fail to install needed datafiles. If you have release 2009-02-15 or earlier, run "sudo scons install" as noted above and then manually re-copy the data files to the installed destination folder:
sudo cp -r data/* /usr/share/games/vdrift/data}}

=== Optional: Installation Location ===

You can change the installation prefix. For example, if you want VDrift to go in <code>/usr/local/share/games/vdrift</code>, you can change the '''prefix''' setting.
scons install prefix=/usr/local

{{note|There are many more build and install options, see the [[Using SCons]] page for more information.}}

= Compiling on Mac OS =

== Prerequisites ==

The VDrift Mac OS X project requires Xcode 3.2 or later. The latest version, [http://developer.apple.com/xcode/ Xcode] 4.1 is free on the [http://itunes.apple.com/us/app/xcode/id422352214?mt=12&ls=1 Mac App Store].

Get the VDrift source code, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Mac OS X|development version]].

== Building ==

Open ''tools/osx/vdrift.xcodeproj'' and in Xcode 4 or higher click "Build" in the "Product" menu, otherwise hit "Build" from XCode's "Build" menu.

== Error fixing ==

If when building, you get some errors, it is most likely because the Xcode project is out of date (it often is as we don't have an active Mac OS X developer). To fix it:
* Remove files from Xcode that are in the project but not in the repository anymore.
* Add new files to Xcode that are in the repository, but have not yet been added to the project.

= Compiling on Windows =

== Prerequisites ==

* Get the VDrift source code and data [[Getting the development version#Windows|development version]].
* Alternatively you can download certain vdrift revisions from gihub/sourceforge web interfaces. For source select a tag and click download https://github.com/VDrift/vdrift and https://github.com/VDrift/vdrift-win. Place vdrift-win into vdrift directory. For data select a tag and download the tarball http://vdrift.svn.sourceforge.net/viewvc/vdrift/tags/. Place data into vdrift directory.

== Building with Code::Blocks/MinGW ==

* Download [http://sourceforge.net/projects/mingw/files/ latest MinGW]. When asked to select components for install, you only need the base system and the g++ compiler.
* Your PATH Environment Variable should contain the MinGW bin path(e.g. C:\MinGW\bin;).
* Download [http://forums.codeblocks.org/index.php/board,20.0.html Code::Blocks nightly]
* Run "vdrift-win\premake4 codeblocks" command line from vdrift directory to generate the solution.

== Building with MSVC ==

* Run "vdrift-win\premake4 vs2008" or "vdrift-win\premake4 vs2010" command line from vdrift directory to generate the appropriate solution.

== Building with Scons(broken) ==

{{note|SCons will prefer the MSVC tools over the MinGW. So if you have Microsoft Visual Studio installed, you might have problems building VDrift with Scons.}}
* Download [http://sourceforge.net/projects/mingw/files/ latest MinGW]. When asked to select components for install, you only need the base system and the g++ compiler.
* Your PATH Environment Variable should contain the MinGW bin path(e.g. C:\MinGW\bin;).
* Download [http://www.python.org/ftp/python/2.6.4/python-2.6.4.msi Python 2.6.4]
* Run the installer and accept all the defaults.

* Download [http://www.scons.org/ SCons 1.20]
* Run the installer. It should find your Python installation, accept all defaults.
* Your PATH Environment Variable should contain the Python and Python scripts paths(e.g. C:\Python26;C:\Python26\Scripts;).
* Open a new CMD prompt by choosing START, RUN, cmd, OK.
* Change directories to the spot where you checked VDrift out.
* Now, to build VDrift, run the command:
tools/win/bin/build_vdrift.bat

== Installing VDrift Data ==

* Move or copy the VDrift data to a directory named data within the root VDrift directory. This can be done in a few different ways, depending on how you obtained the VDrift data. You could check it out directly here, or you could check it out in another place and use TortoiseSVN to export it to this location. If you downloaded a VDrift data archive you can extract it here, or extract it elsewhere and then move or copy the necessary files to runtime. In the end, just make sure you have a directory structure with paths like '''VDrift/data/cars/''', '''VDrift/data/tracks/''', etc.

[[Category:Development]]
[[Category:Review]]
[[Category:Operating Systems:FreeBSD]]
[[Category:Operating Systems:Linux]]
[[Category:Operating Systems:Mac OS X]]
[[Category:Operating Systems:Windows]]

Logitech G25 support

2011-09-09T14:32:13Z

Venzon:

==Windows==
The G25 should be fully supported in Windows without any special steps.

==Linux==
When initially plugged in, the G25 will be in compatibility mode, which restricts the steering range and disables the clutch pedal and some of the gears on the H-shifter. VDrift includes two tools that can be used to change G25 modes. Either tool can be used; use whichever tool works the best for you.
If you want to use force feedback, you'll need to patch your kernel because when set to native mode, the G25 change its product id, and this product id is not known yet by the kernel ( have a look here [[Enabling force feedback in kernel]] )
===usbtool===
The tool can be found in VDrift/tools/usbtool-0.1.tar.gz. The tool requires libusb development headers to be installed (package libusb-dev on ubuntu intrepid, for example) as well as the swig package. Run ./build.sh and then run ./usbtool to see the options available. To set the wheel to native mode and the range to 900 degrees, run:
sudo ./usbtool g25-set-range-wheel-900
and
sudo ./usbtool g25-set-extended-mode
This will likely disconnect the joystick driver. To reconnect it run:
sudo rmmod joydev;sudo rmmod usbhid;sudo modprobe usbhid

===G25manage===
The tool can be found in VDrift/tools/G25manage. The tool requires libusb development headers to be installed (package libusb-dev on ubuntu intrepid, for example). Run make to compile the tool, then run:
sudo ./G25manage --nativemode
and
sudo ./G25manage --range 900
The wheel should now support the entire turning radius as well as the clutch pedal.

===LTWheelConf===
LTWheelConf is a new tool based on G25manage.
https://github.com/TripleSpeeder/LTWheelConf

===Automatically enable native mode===
If your distribution uses udev (such as Ubuntu), you can put this in /etc/udev/rules.d/90-g25-wheel.rules to automatically run G25manage when the wheel is plugged in:

SUBSYSTEM!="usb", GOTO="g25_rules_end"
ACTION!="add", GOTO="g25_rules_end"

ATTRS{idVendor}=="046d", ATTRS{idProduct}=="c294", RUN+="/usr/local/bin/G25manage --nativemode"
#ATTRS{idVendor}=="046d", ATTRS{idProduct}=="c299", RUN+="/usr/local/bin/G25manage --range 900"
LABEL="g25_rules_end"

# for a joystick detected by the kernel event interface, with a model name "G25_Racing_Wheel change the permissions on the device file
# and add a symlink to the event device file
KERNEL=="event[0-9]*", ATTRS{idVendor}=="046d", ATTRS{idProduct}=="c299", SYMLINK+="input/G25event"
KERNEL=="event[0-9]*", ATTRS{idVendor}=="046d", ATTRS{idProduct}=="c299", MODE="0664", GROUP="games"

# No deadzone for the wheel on the G25 in native mode
KERNEL=="event[0-9]*", ATTRS{idVendor}=="046d", ATTRS{idProduct}=="c299", RUN+="/usr/local/bin/G25manage --evdev=/dev/input/G25event --deadzone=0 --axis=0"
# No deadzone for the clutch pedal on the G25 in native mode
KERNEL=="event[0-9]*", ATTRS{idVendor}=="046d", ATTRS{idProduct}=="c299", RUN+="/usr/local/bin/G25manage --evdev=/dev/input/G25event --deadzone=0 --axis=1"
# No deadzone for the break pedal on the G25 in native mode
KERNEL=="event[0-9]*", ATTRS{idVendor}=="046d", ATTRS{idProduct}=="c299", RUN+="/usr/local/bin/G25manage --evdev=/dev/input/G25event --deadzone=0 --axis=2"
# No deadzone for the throttle pedal on the G25 in native mode
KERNEL=="event[0-9]*", ATTRS{idVendor}=="046d", ATTRS{idProduct}=="c299", RUN+="/usr/local/bin/G25manage --evdev=/dev/input/G25event --deadzone=0 --axis=5"

After creating that file and copying the G25manage binary to /usr/local/bin, run "/etc/init.d/udev reload" (or "service udev reload" on Ubuntu karmic) and you no longer have to manually run G25manage.

[[Category:Configuration]]
[[Category:Operating Systems:Linux]]
[[Category:Operating Systems:FreeBSD]]
[[Category:Operating Systems:Windows]]
[[Category:Operating Systems:Mac OS X]]
[[Category:Expand]]

Old Method of Compiling on Linux

2011-08-30T14:43:04Z

Venzon:

{{Update}}

==Linux==
===Prerequisites===
Make sure you have all the required libraries and build tools. Make sure you also have the development files for each of the libraries.

The required build tools include:

* '''g++''' - The GNU C++ compiler
* '''scons''' - A replacement for Make

The required libraries include:

* '''libsdl''' - Simple Direct Media Layer
* '''libglew''' - OpenGL extension utilities
* '''sdl-gfx''' - Graphics drawing primitives library for SDL
* '''sdl-image''' - Image file loading library for SDL
* '''vorbisfile''' - File loading library for the ogg vorbis format
* '''libvorbis''' - The Vorbis General Audio Compression Codec
* '''libbullet''' - Bullet Physics Library
* '''libcurl''' - the multiprotocol file transfer library
* '''libarchive''' - library for reading and writing archive formats
* Boost C++ Libraries (header-file-only)
* ASIO C++ Libraries (header-file-only)

Your Linux distribution may have different package names and/or bundled differently. The list above should give enough information to search for applicable packages within your distribution's package manager.

For Ubuntu, all the required packages may be installed using this command:
sudo apt-get install g++ scons libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libvorbis-dev libglew-dev libbullet-dev libasio-dev libboost-dev libcurl4-gnutls-dev libarchive-dev

For Ubuntu 8.04 you additionally need:
sudo apt-get install libboost-date-time-dev libboost-regex-dev

====Bullet====
As of SVN R2358 (2009-06-15 release and later), no steps are required to build bullet and you can continue to the next section.

For the 2009-02-15 release, the only step required is to expand the Bullet source archive:
tar zxvf bullet-2.73-sp1.tgz

{{note|For older versions of VDrift, you will need to follow the [[Old Method of Compiling Bullet]].}}

====SCons====
As of the 2005-10-02 release, VDrift no longer uses ./configure, make, etc. (autotools). Now the project is built with [http://scons.org/ SCons]. You may want to read a little about [[Using SCons]].

There are two ways to use SCons. The first way is to install scons on your system through your package manager, then you can use it simply by the name of the program, "scons". If you followed the directions for installing prerequisites for Ubuntu above, then you're done and can continue on to the next section. The second way is to use the scons-local package (included with VDrift) which will do the same thing but doesn't require that you install scons on your system. To do this, you must move the scons-local-0.96.95.tar.gz archive from tools to the root vdrift folder, un-tar the archive, and then use the <code>./scons.py</code> command instead of <code>scons</code>.

===Get the Code===
You can get the code from a source package for a particular version, or you can [[Getting the development version|get the development version]].
====Source Package====
[http://sourceforge.net/project/showfiles.php?group_id=137283 Download] the latest VDrift Linux source package. All the files in the package are in a directory called vdrift-'''version'''-src where '''version''' is something like 2009-06-15.

Unpack the archive.

tar jxvf vdrift-2009-06-15-src.tar.bz2

=====Enter directory=====
Now change directories into the location of your newly created VDrift source tree.
cd vdrift-2009-06-15

====Optional: Using scons-local instead of installing SCons====
If you have decided not to install SCons on your system, you can use scons-local. To set it up, do the following:

tar zxvf tools/scons-local-0.96.1.tar.gz

{{note|Some of the following steps refer to the <code>scons</code> command, you should now replace that with <code>./scons.py</code>.}}

===Compiling===
To compile VDrift, just use the <code>scons</code> command.
scons

====Optional: Compile Options====
You can use one or more compile options. To compile with optimization for a certain platform, you can use the '''arch''' option.
scons arch=a64
Compiling VDrift in '''release''' mode will turn off debugging options, and enable more compiler optimizations. VDrift runs much more quickly in release mode.
scons release=1
{{note|These options are probably best left off the first time you compile. If you have problems compiling or running VDrift, it is easier to debug with them off. Once you verify that VDrift is compiling, then recompile with these optimizations to improve performance.}}

===Installing===
VDrift does not need to be installed to work and you can run it from the folder where you compiled it. If you do want to install, use the SCons build target '''install'''. This command must be run as root.
sudo scons install
{{note|The <code>scons install</code> process was broken for several releases including the 2009-02-15 release and may fail to install needed datafiles. If you have release 2009-02-15 or earlier, run "sudo scons install" as noted above and then manually re-copy the data files to the installed destination folder:
sudo cp -r data/* /usr/share/games/vdrift/data}}

====Optional: Installation Location====
You can change the installation prefix. For example, if you want VDrift to go in <code>/usr/local/share/games/vdrift</code>, you can change the '''prefix''' setting.
scons install prefix=/usr/local

{{note|There are many more build and install options, see the [[Using SCons]] page for more information.}}

===Running===
For release 2009-02-15 and earlier, if you used the default install locations, VDrift can be run with the command:
/usr/share/games/vdrift/bin/vdrift
For release 2009-06-15 and later, if you used the default install locations, VDrift can be run with the command:
/usr/local/bin/vdrift

[[Category:Development]]
[[Category:Review]]
[[Category:Operating Systems:Linux]]

Packaging

2011-08-28T15:33:30Z

Venzon:

Packaging VDrift is different depending on the operating system on which it is packaged.

==Common==
The data/settings/updates.config file should be updated to contain the cars that will be included in the release along with their SVN revision numbers.

==Linux==
''See [[Packaging on Linux]]''

==FreeBSD==
''See [[Packaging on FreeBSD]]''

==Mac OS X==
''See [[Packaging on Mac OS X]]''

==Windows==
''See [[Packaging on Windows]]''

[[Category:Development]]

Creating cars

2011-07-31T16:26:56Z

Venzon: Reverted edits by GeorginaBevan (Talk); changed back to last version by Timo 6

{{update}}

This article gives a rough idea of what it takes to create a car for VDrift.

==Get the Art Tools==
Download the [https://github.com/VDrift/blender-scripts Blender export scripts] from [[Getting the development version|GitHub]].

==Create Models==
You will need to create 3D models using Blender for the car's body, the glass pieces, and the wheels. Each different model must be a separate Blender object and each must have a separate texture. Models must be entirely made of triangles. Units of the models are in meters.

===Coordinate Systems===
See [[Coordinate systems]]

===Shading and Smoothing===
Faces (and perhaps individual vertices) can be set to smooth or solid shading, and that will get exported in the joe file. The best way to do smoothing is to select all of the faces, set solid, and then select groups that should be blended together and do set smooth individually. That makes it so that smooth parts that intersect in a hard edge have correct normals. Don't use any double-sided faces.

===Body Model===
In the model pack you will find a Blender file "test.blend". This is the default car model. The glass is one object and the rest of the car is one object. This allows you to export the glass as a "glass.joe" file and the rest of the car as a "body.joe" file. The car should be in the neighborhood of 3500 faces (car and windows combined), although less is of course possible and more is probably also acceptable. The body can be placed anywhere, although by convention the body is usually placed so that the center of the model is near the origin.

===Interior Model===
The interior model should fit inside the body model to provide the inside of the car. This is a separate model so it can appear flat instead of shiny like the painted exterior. The interior model should share the center point or object handle of the body model so they fit together perfectly without being translated.

===Wheel Model===
The file "wheel.blend" is the default wheel model. Try to keep your wheel model under 1000 faces. The wheel model must be centered at the origin.

==Texture the Models==
A single UV map can be used per object for texturing. The .png files are the textures for each associated .joe model. The textures must be 512x512 24- or 32-bit PNG images. Their names should be the same as the model they coordinate with except for the .png extension at the end. For example, the texture for the model "body.joe" must be named "body.png".

===Brake lights===
Add a texture "brake.png" that is the same as the body graphic, but the brake lights are now on and the rest of the file is black. This should be a 24-bit png file (no alpha channel).

==Export the Models==
Using the Python scripts ("export-joe-0.3.py" and "export-all-joe-0.3.py") you can export objects modeled in Blender to JOE format. The mesh needs to be all triangles before export. The currently selected object is exported. Object level transformations are not exported, so make sure any rotation or moving or scaling is done in edit mode, not object mode. You can actually position the car wherever you want, but all of your positioning must match up with the values in the car's .car file. The default exporter setting of 1 frame is what you should use. The export-all script exports all the objects to files based on the objects' names.

==About file==
Write a short text file about your car. This goes in the about.txt file. This information is displayed in the car selection menu. Please include information such as authorship and license. See the other cars for examples.

==Car Definition File==
Finally you must write car definition file, which contains all of the [[car parameters]]. You can start by copying tools/cars/blank.car and entering values to fit your vehicle. Try to find accurate information regarding the specifications of the car and duplicate it as closely as possible. The units are all in [http://scienceworld.wolfram.com/physics/MKS.html MKS] (meters, kilograms, seconds). It might also help to read [http://www.miata.net/sport/Physics/ ''The Physics of Racing''] by Brian Beckman.

Needless to say, it requires a lot of knowledge to create a car definition file from scratch so it is suggested that you try using values from other cars. Many of the [http://www.racer-xtreme.com/ community-made cars for Racer] have very similar values that can be used for VDrift.

==Locations==
All the files needed for a car go into the directory '''data/cars/car_name/''', where ''car_name'' is the short name of the car.

==Need Help?==
Try the related wiki articles on [[car files and formats]], [[car parameters]], or the [[car modeling tutorial]]. If you get stuck, feel free to ask questions in our [http://vdrift.net/Forum/viewforum.php?f=1 VDrift.net Help forum] or on [http://vdrift.net/staticpages/index.php?page=irc-chat VDrift IRC]

==Contribute==
Once you create a new car please contribute it back to the game so that others can enjoy it. The best way to do this is to start a thread in our [http://vdrift.net/Forum/viewforum.php?f=5 Development forum] or to create an account on [http://cars.vdrift.net cars.vdrift.net] and upload it there.

[[Category:Cars]]
[[Category:Update]]

Autoupdate

2011-07-31T16:12:50Z

Venzon:

This page describes, at a high level, how the auto-update function works.

==Introduction==
One major barrier to releasing more often is the huge size of the VDrift releases. These large sizes are due to the large number of cars and tracks that are typically included in a release. If VDrift has auto-update functionality, then releases can be very minimal (one track and one car, for example) and people can download new cars and tracks (and keep their existing ones up to date) through an in-game interface.

The rest of this document talks exclusively about updating cars, but tracks should work similarly.

The auto-update functionality was first proposed in this forum post:
http://vdrift.net/Forum/viewtopic.php?p=12999

==User Interface==
Several GUI pages have been added. From the main menu, the "Cars and Tracks" button takes the user to a page with options to check for updates and manage cars. When the user clicks "check for updates", the sourceforge svn browser html is scraped to get the latest revision numbers for the car folders. The car manager UI is populated from code and allows the user to see what updates are available and provides an "apply update" button.

==Versioning==
There are two types of versioning: the versioning for each car folder, and the versioning for the car format.

First, car folder versioning. The data/settings/updates.config file is distributed with each release, and contains the cars that have been included in that release along with their SVN revision numbers. When the game checks for updates, the sourceforge svn browser html is scraped to get the latest revision numbers, and that information ([available_cars] section) along with the current on-disk versions ([cars] section) are stored in an updates.config in the user's folder (~/.vdrift on linux). The game offers to apply updates when the on-disk versions are less than the available versions.

Next, car format versioning. Sometimes, the format of car files changes in a way that breaks compatibility with old data files. To protect against updating cars to a format that the user's executables won't understand, format versions are stored in the updates.config file in the [formats] section. The version of the car format that the executable release understands is set in the data/settings/updates.config file included in the release (and copied to the user's folder). The game retrieves the latest data/settings/update.config via the sourceforge svn website and checks the format version there to make sure it matches the version number in the local update.config. If the format versions are not equal, updates will refuse to apply.

==Updating==
When the user clicks "apply update", the car format versioning is re-checked per the description above. If the car format versions mismatch, the game refuses to continue. Otherwise, updates are applied by fetching the .tar.gz bundle for a car's folder from sourceforge's http svn browser to a temporary folder (~/.vdrift/tmp on linux). This file then decompressed using libarchive into the settings directory (~/.vdrift on linux) under a "cars" subdir. The game should look here first when loading car files, and fall back to the global data path. The downloaded file is deleted once the update completes successfully, otherwise it leaves the temporary file around for troubleshooting.

[[Category:Development]]

Autoupdate

2011-07-27T20:30:55Z

Venzon:

Autoupdate

2011-07-27T16:33:08Z

Venzon: New page: This page describes, at a high level, how the auto-update function works. ==Introduction== One major barrier to releasing more often is the huge size of the VDrift releases. These large s...

Old Method of Compiling on Linux

2011-07-27T16:08:45Z

Venzon: /* Prerequisites */

{{Update}}

==Linux==
===Prerequisites===
Make sure you have all the required libraries and build tools. Make sure you also have the development files for each of the libraries.

The required build tools include:

* '''g++''' - The GNU C++ compiler
* '''scons''' - A replacement for Make

The required libraries include:

* '''libsdl''' - Simple Direct Media Layer
* '''libglew''' - OpenGL extension utilities
* '''sdl-gfx''' - Graphics drawing primitives library for SDL
* '''sdl-image''' - Image file loading library for SDL
* '''vorbisfile''' - File loading library for the ogg vorbis format
* '''libvorbis''' - The Vorbis General Audio Compression Codec
* '''libbullet''' - Bullet Physics Library
* '''libarchive''' - library for reading and writing archive formats
* Boost C++ Libraries (header-file-only)
* ASIO C++ Libraries (header-file-only)

Your Linux distribution may have different package names and/or bundled differently. The list above should give enough information to search for applicable packages within your distribution's package manager.

For Ubuntu, all the required packages may be installed using this command:
sudo apt-get install g++ scons libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libvorbis-dev libglew-dev libbullet-dev libasio-dev libboost-dev libarchive-dev

For Ubuntu 8.04 you additionally need:
sudo apt-get install libboost-date-time-dev libboost-regex-dev

====Bullet====
As of SVN R2358 (2009-06-15 release and later), no steps are required to build bullet and you can continue to the next section.

For the 2009-02-15 release, the only step required is to expand the Bullet source archive:
tar zxvf bullet-2.73-sp1.tgz

{{note|For older versions of VDrift, you will need to follow the [[Old Method of Compiling Bullet]].}}

====SCons====
As of the 2005-10-02 release, VDrift no longer uses ./configure, make, etc. (autotools). Now the project is built with [http://scons.org/ SCons]. You may want to read a little about [[Using SCons]].

There are two ways to use SCons. The first way is to install scons on your system through your package manager, then you can use it simply by the name of the program, "scons". If you followed the directions for installing prerequisites for Ubuntu above, then you're done and can continue on to the next section. The second way is to use the scons-local package (included with VDrift) which will do the same thing but doesn't require that you install scons on your system. To do this, you must move the scons-local-0.96.95.tar.gz archive from tools to the root vdrift folder, un-tar the archive, and then use the <code>./scons.py</code> command instead of <code>scons</code>.

===Get the Code===
You can get the code from a source package for a particular version, or you can [[Getting the development version|get the development version]].
====Source Package====
[http://sourceforge.net/project/showfiles.php?group_id=137283 Download] the latest VDrift Linux source package. All the files in the package are in a directory called vdrift-'''version'''-src where '''version''' is something like 2009-06-15.

Unpack the archive.

tar jxvf vdrift-2009-06-15-src.tar.bz2

=====Enter directory=====
Now change directories into the location of your newly created VDrift source tree.
cd vdrift-2009-06-15

====Optional: Using scons-local instead of installing SCons====
If you have decided not to install SCons on your system, you can use scons-local. To set it up, do the following:

tar zxvf tools/scons-local-0.96.1.tar.gz

{{note|Some of the following steps refer to the <code>scons</code> command, you should now replace that with <code>./scons.py</code>.}}

===Compiling===
To compile VDrift, just use the <code>scons</code> command.
scons

====Optional: Compile Options====
You can use one or more compile options. To compile with optimization for a certain platform, you can use the '''arch''' option.
scons arch=a64
Compiling VDrift in '''release''' mode will turn off debugging options, and enable more compiler optimizations. VDrift runs much more quickly in release mode.
scons release=1
{{note|These options are probably best left off the first time you compile. If you have problems compiling or running VDrift, it is easier to debug with them off. Once you verify that VDrift is compiling, then recompile with these optimizations to improve performance.}}

===Installing===
VDrift does not need to be installed to work and you can run it from the folder where you compiled it. If you do want to install, use the SCons build target '''install'''. This command must be run as root.
sudo scons install
{{note|The <code>scons install</code> process was broken for several releases including the 2009-02-15 release and may fail to install needed datafiles. If you have release 2009-02-15 or earlier, run "sudo scons install" as noted above and then manually re-copy the data files to the installed destination folder:
sudo cp -r data/* /usr/share/games/vdrift/data}}

====Optional: Installation Location====
You can change the installation prefix. For example, if you want VDrift to go in <code>/usr/local/share/games/vdrift</code>, you can change the '''prefix''' setting.
scons install prefix=/usr/local

{{note|There are many more build and install options, see the [[Using SCons]] page for more information.}}

===Running===
For release 2009-02-15 and earlier, if you used the default install locations, VDrift can be run with the command:
/usr/share/games/vdrift/bin/vdrift
For release 2009-06-15 and later, if you used the default install locations, VDrift can be run with the command:
/usr/local/bin/vdrift

[[Category:Development]]
[[Category:Review]]
[[Category:Operating Systems:Linux]]

Working with the development version

2011-07-03T18:58:50Z

Venzon:

VDrift's code is kept in a Git repository on GitHub. To get the development version, you must "check out" the code from this repository.

==Browsing the repositories==
VDrift's source on the GitHub web site is at https://github.com/VDrift/vdrift/. Here you may browse the VDrift repositories and even download single files. This is very useful for examining changes between different revisions, in a user-friendly manner.

==Checking out the code==
If you want to do much work on VDrift you'll need to check out an entire copy of the development tree.

===Linux/Unix===
Install a git ([http://git-scm.com/ Git]) client. If you are using a Linux distribution you can search for it in the package manager. When you have installed it you need to open a terminal and run the following code:

git clone git://github.com/VDrift/vdrift.git vdrift

It will download the current development version in the subfolder vdrift. Next, [[Getting_the_development_version#Checking_out_the_data|check out the data]].

===Windows===
The best solution for Windows is to download [http://code.google.com/p/msysgit/ MSysGit]. After installing it, open Windows explorer and go to the directory where you want to download the VDrift development version. Right-click and click Git GUI Here. Select Open Existing Repository. In the next screen you need to fill in the URL of the repository which is git://github.com/VDrift/vdrift.git. Simply click OK, and the development version will be downloaded. Next, [[Getting_the_development_version#Checking_out_the_data|check out the data]].

===Mac OS X===
This is the same as working with [[Getting_the_development_version#Linux/Unix|Linux/Unix]] however you will need to obtain a git client.
Once you have a working SVN client see the [[Getting_the_development_version#Linux/Unix|Linux/Unix]] instructions.

==Checking out the data==
The data set is currently only available from the SourceForge SVN. Get it from https://vdrift.svn.sourceforge.net/svnroot/vdrift/vdrift-data to the vdrift/data from svn.vdrift.net. If you are using a command-line SVN client and have the VDrift repository checked out in a directory called /home/user/code, you would do this:
cd /home/user/code
svn co https://vdrift.svn.sourceforge.net/svnroot/vdrift/vdrift-data data
If you are using the Tortoise SVN client, see the documentation on the Tortoise SVN [http://tortoisesvn.tigris.org/ website] for more information on how to check out a repository.

==Working with the repository==
===Updating===
Once the reposotory has been checked out, it can be updated without downloading the entire thing again. For command line git, use the command
git pull
to check for updates and apply them.

===Checking in changes===
You can request a VDrift developer to incorporate your changes by initiating a GitHub pull request. See this documentation for more info: http://help.github.com/send-pull-requests/

===Adding and removing files===
Every file you introduce to the checkout on your computer is not automatically added to the repository. First you must add it:
git add ''filename''
Where ''filename'' is the file you wish to add. Similarly you may remove files that are no longer needed with <code>git rm ''filename''</code>.

[[Category:Development]]
[[Category:Review]]
[[Category:Operating Systems:Linux]]
[[Category:Operating Systems:FreeBSD]]
[[Category:Operating Systems:Windows]]
[[Category:Operating Systems:Mac OS X]]

Creating tracks

2011-04-22T03:15:38Z

Venzon: /* Video Tutorial */

==Video Tutorial==
NaN has produced this nifty video tutorial (Windows, but mostly applicable to Linux too): http://www.youtube.com/watch?v=oju-vKVVaho

==What you need==
* Vdrift program
* Vdrift level editor
* Blender 2.33 or higher. Tested on 2.45 with Python 2.5.1
* Blender JOE export script. Get that here: http://svn.vdrift.net/repos/vdrift-art/trunk/tools/
Get the "export-all-joe-0.3.py" script. The difference in the files is that one exports all the object in the scene and the other only exports the one that is selected.

==Getting the level editor==
In the Linux console, copy ''everything'' below:
svn co http://svn.vdrift.net/repos/vdrift-trackeditor/trunk vdrift-trackeditor

==Directions for creating tracks==
* Model the scene. See the [[track modeling tutorial]] for help with this step.
* If you use a 3d editor other than blender, import the track into blender.
* Use the export-all-joe-0.3.py blender export script to export all objects. This script can be found in the VDrift art repository under the tools folder. The export script creates a number of .joe files and a list.txt file. The list.txt file may be named somename-list.txt, in which case you should rename it to list.txt. At least one .joe file should get created for the curve track. Also verify that list.txt is mentioning all the .joe files. An empty list.txt will not load anything in the editor.
* Create new folder for track in track editor folder TRACKEDITOR_TP (if your track is called parkinglot, the path could be /home/joe/VDrift-trackeditor/data/tracks/parkinglot).
* Make folder TRACKEDITOR_TP/objects/
* Copy all of the .joe files and the list.txt file to TRACKEDITOR_TP/objects/
* Open track editor data/tracks/editor.config and set active track to TRACKEDITOR_TP.
* Create a TRACKEDITOR_TP/track.txt file with at least a line "cull faces = on". track.txt is modified by track editor to add all starting positions and lap sequence points. Read the track editor inhelp for more information.
* Run the track editor. Trace the roadways and mark the starting position (press H for help). A track may not always appear on the screen. Move the mouse around and you could see it in the black space. The first time, check the console output of track editor for any warnings.
{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''Why trace roadways?'''
[[Image:Track-smoothing.png]]
This is a visual depiction of the track smoothing that occurs when tracing a roadway. Imagine this image is showing the track surface from a side view. The black lines represent the track mesh, and the red lines represent the bezier patches. Once the track has been traced in the track editor, VDrift will use the red lines to do collision instead of the black lines. On the top, this represents a dip in the road. You can see how collision using the red line will behave properly. On the bottom, this represents a bump road. You can see that the red line doesn't change the magnitude of the bumps, it just makes them realistically smooth instead of unrealistically pointy.
|}
* CD to the VDrift-trackeditor/joepack folder. Compile the joepack tool by running
scons
* CD to the TRACKEDITOR_TP/objects folder (this is important, the packfile stores relative paths) and run
/path/to/VDrift-trackeditor/joepack/joepack -c objects.jpk *.joe
* If you want, this command will show you the files in the joepack to allow you to verify the previous step worked correctly:
/path/to/VDrift-trackeditor/joepack/joepack -l objects.jpk
* Copy TRACKEDITOR_TP into the main VDrift tracks folder VDRIFT_TP (for example /home/joe/VDrift/data/tracks/parkinglot). Erase VDRIFT_TP/objects/*.joe since they are all in the pack file now.
* Add VDRIFT_TP/about.txt and ensure that the first line is the name of the track. You should put information about the track author, where the track came from, etc in the second line and on.
* Run VDrift and check out what the track looks like in-game. Note that you will only be able to drive on the roadways you defined in the track editor since no other surfaces have been flagged as collideable. Also take a screenshot for the track selection screen.
* Create a track selection image (a 512x512 png file works best) and save it to VDRIFT_TP/trackshot.png
* Open up all of the texture files in TRACKEDITOR_TP/objects and review which textures belong to objects that should be collide-able (roads and walls), have full brightness (trees), be mipmapped (fences and fine transparent objects sometimes look better when not mipmapped), or be skyboxes.
* Set the correct object properties using the VDrift-tracked/listedit tool (more documentation to come).
* Done!

==Other Notes==
* A track should be of a minimum size for loading within vdrift game. If the editor is not allowing to adjust the camera poistions correctly, probably the track is very small. Scale everything in the blender twice or more and try again.
* Starting points are set within the track editor. After the track is loaded, position the track like you were in the car on the track i.e. first person view. Press L to save the position as a starting position. Continue to add positions depending on your track. Also add a lap sequence i.e. lap starting/ending point　track.
* Track editor does not paint or mark the starting points or lap sequence numbers on the track. These are only saved in track.txt. Also, the editor will always continue adding more starting positions if track.txt had some already. Therefore, consider deleting everything in track.txt if you wish to reedit the positions.
* A .joe file gets created when the track has a texture.
* The export-joe script should be loaded within blender along with the track, and executed.

[[Category:Tracks]]
[[Category:Review]]

Creating tracks

2011-04-22T03:14:01Z

Venzon:

==Video Tutorial==
NaN has produced this nifty video tutorial: http://www.youtube.com/watch?v=oju-vKVVaho

==What you need==
* Vdrift program
* Vdrift level editor
* Blender 2.33 or higher. Tested on 2.45 with Python 2.5.1
* Blender JOE export script. Get that here: http://svn.vdrift.net/repos/vdrift-art/trunk/tools/
Get the "export-all-joe-0.3.py" script. The difference in the files is that one exports all the object in the scene and the other only exports the one that is selected.

==Getting the level editor==
In the Linux console, copy ''everything'' below:
svn co http://svn.vdrift.net/repos/vdrift-trackeditor/trunk vdrift-trackeditor

==Directions for creating tracks==
* Model the scene. See the [[track modeling tutorial]] for help with this step.
* If you use a 3d editor other than blender, import the track into blender.
* Use the export-all-joe-0.3.py blender export script to export all objects. This script can be found in the VDrift art repository under the tools folder. The export script creates a number of .joe files and a list.txt file. The list.txt file may be named somename-list.txt, in which case you should rename it to list.txt. At least one .joe file should get created for the curve track. Also verify that list.txt is mentioning all the .joe files. An empty list.txt will not load anything in the editor.
* Create new folder for track in track editor folder TRACKEDITOR_TP (if your track is called parkinglot, the path could be /home/joe/VDrift-trackeditor/data/tracks/parkinglot).
* Make folder TRACKEDITOR_TP/objects/
* Copy all of the .joe files and the list.txt file to TRACKEDITOR_TP/objects/
* Open track editor data/tracks/editor.config and set active track to TRACKEDITOR_TP.
* Create a TRACKEDITOR_TP/track.txt file with at least a line "cull faces = on". track.txt is modified by track editor to add all starting positions and lap sequence points. Read the track editor inhelp for more information.
* Run the track editor. Trace the roadways and mark the starting position (press H for help). A track may not always appear on the screen. Move the mouse around and you could see it in the black space. The first time, check the console output of track editor for any warnings.
{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''Why trace roadways?'''
[[Image:Track-smoothing.png]]
This is a visual depiction of the track smoothing that occurs when tracing a roadway. Imagine this image is showing the track surface from a side view. The black lines represent the track mesh, and the red lines represent the bezier patches. Once the track has been traced in the track editor, VDrift will use the red lines to do collision instead of the black lines. On the top, this represents a dip in the road. You can see how collision using the red line will behave properly. On the bottom, this represents a bump road. You can see that the red line doesn't change the magnitude of the bumps, it just makes them realistically smooth instead of unrealistically pointy.
|}
* CD to the VDrift-trackeditor/joepack folder. Compile the joepack tool by running
scons
* CD to the TRACKEDITOR_TP/objects folder (this is important, the packfile stores relative paths) and run
/path/to/VDrift-trackeditor/joepack/joepack -c objects.jpk *.joe
* If you want, this command will show you the files in the joepack to allow you to verify the previous step worked correctly:
/path/to/VDrift-trackeditor/joepack/joepack -l objects.jpk
* Copy TRACKEDITOR_TP into the main VDrift tracks folder VDRIFT_TP (for example /home/joe/VDrift/data/tracks/parkinglot). Erase VDRIFT_TP/objects/*.joe since they are all in the pack file now.
* Add VDRIFT_TP/about.txt and ensure that the first line is the name of the track. You should put information about the track author, where the track came from, etc in the second line and on.
* Run VDrift and check out what the track looks like in-game. Note that you will only be able to drive on the roadways you defined in the track editor since no other surfaces have been flagged as collideable. Also take a screenshot for the track selection screen.
* Create a track selection image (a 512x512 png file works best) and save it to VDRIFT_TP/trackshot.png
* Open up all of the texture files in TRACKEDITOR_TP/objects and review which textures belong to objects that should be collide-able (roads and walls), have full brightness (trees), be mipmapped (fences and fine transparent objects sometimes look better when not mipmapped), or be skyboxes.
* Set the correct object properties using the VDrift-tracked/listedit tool (more documentation to come).
* Done!

==Other Notes==
* A track should be of a minimum size for loading within vdrift game. If the editor is not allowing to adjust the camera poistions correctly, probably the track is very small. Scale everything in the blender twice or more and try again.
* Starting points are set within the track editor. After the track is loaded, position the track like you were in the car on the track i.e. first person view. Press L to save the position as a starting position. Continue to add positions depending on your track. Also add a lap sequence i.e. lap starting/ending point　track.
* Track editor does not paint or mark the starting points or lap sequence numbers on the track. These are only saved in track.txt. Also, the editor will always continue adding more starting positions if track.txt had some already. Therefore, consider deleting everything in track.txt if you wish to reedit the positions.
* A .joe file gets created when the track has a texture.
* The export-joe script should be loaded within blender along with the track, and executed.

[[Category:Tracks]]
[[Category:Review]]

Profiling

2010-12-24T17:27:19Z

Venzon: New page: VDrift uses the GNU profiler, gprof. To use it, recompile VDrift with "scons profiling=1", then run the VDrift executable and perform activities that you'd like to profile. After exiting, ...

VDrift uses the GNU profiler, gprof. To use it, recompile VDrift with "scons profiling=1", then run the VDrift executable and perform activities that you'd like to profile. After exiting, simply run gprof on the executable.

Sound/Audio Development

2010-09-30T14:32:23Z

Venzon: Reverted edits by Marriedwithkids (Talk); changed back to last version by Fangbaby

These are some preliminary recordings of a miata.

Discussion is welcomed here and in the forum thread: [http://vdrift.net/Forum/viewtopic.php?t=816 Collecting Audio]

*Notes:
**Inside - 2 microphones in a 180 degree stereo setup behind the driver headrest.
**Behind - 2 Microphones in a 45 degrees stereo setup 7 feet behind the car.
**Some filenames have odd case, I'll make all lowcase standard in the future.
**I did very little to the raw audio other than a little compression to lessen the dynamic range.
**Some of these are very quiet, such as the 1k inside.

----
*Miata sounds:
**[http://fangbaby.com/share/vdrift/01%20-%201k%20inside.wav 1k inside]
**[http://fangbaby.com/share/vdrift/02%20-%202k%20inside.wav 2k inside]
**[http://fangbaby.com/share/vdrift/03%20-%203k%20inside.wav 3k inside]
**[http://fangbaby.com/share/vdrift/04%20-%204k%20inside.wav 4k inside]
**[http://fangbaby.com/share/vdrift/05%20-%205k%20inside.wav 5k inside]
**[http://fangbaby.com/share/vdrift/06%20-%206k%20inside.wav 6k inside]
**[http://fangbaby.com/share/vdrift/07%20-%207k%20inside.wav 7k inside]
**[http://fangbaby.com/share/vdrift/08%20-%20Revlimit%20Inside.wav RevLimit inside]
**[http://fangbaby.com/share/vdrift/09%20-%20750to7k%20inside.wav 750to7k inside]
**[http://fangbaby.com/share/vdrift/10%20-%201k%20Behind.wav 1k behind]
**[http://fangbaby.com/share/vdrift/11%20-%202k%20Behind.wav 2k behind]
**[http://fangbaby.com/share/vdrift/12%20-%203k%20Behind.wav 3k behind]
**[http://fangbaby.com/share/vdrift/13%20-%204k%20Behind.wav 4k behind]
**[http://fangbaby.com/share/vdrift/14%20-%205k%20Behind.wav 5k behind]
**[http://fangbaby.com/share/vdrift/15%20-%206k%20Behind.wav 6k behind]
**[http://fangbaby.com/share/vdrift/16%20-%207k%20behind.wav 7k behind]
**[http://fangbaby.com/share/vdrift/17%20-%20Revlimit%20behind.wav RevLimit behind]
**[http://fangbaby.com/share/vdrift/18%20-%20Start%20Behind.wav Start behind]
**[http://fangbaby.com/share/vdrift/19%20-%20Stop%20Behind.wav stop behind]
**[http://fangbaby.com/share/vdrift/20%20-%20Moving.wav Moving Inside]
**[http://fangbaby.com/share/vdrift/21%20-%20Moving2.wav More Moving Inside]

Configuring the display

2010-09-30T14:29:10Z

Venzon: Undo revision 759 by Special:Contributions/Julianmarble (User talk:Julianmarble)

Configuring the display is done by editing [[VDrift.config]] manually, or by changing the settings in the '''Options -> Display''' and '''Options -> Display -> Advanced''' menus.

==Display Options==

===Resolution===
* type: integer pair
* settings: display.width, display.height
* values: depends on the file '''vdrift/data/lists/videomodes''' and the resolutions your video card makes available

Change the resolution of the game display.

See [[Adding video modes]] for how to make new video modes available to choose from.

===Fullscreen===
* type: boolean
* setting: display.fullscreen
* values: on, off

Make the game take up the entire screen.

===Speed Units===
* type: boolean
* setting: display.mph
* values: on = "MPH", off = "km/h"

Change the units that speed is displayed in.

===Framerate Counter===
* type: boolean
* setting: display.show_fps
* values: on, off

Enable/disable the framerate counter.

===Heads Up Display===
* type: boolean
* setting: display.show_hud
* values: on, off

Enable/disable the heads up display.

===Menu Skin===
* type: string
* setting: display.skin
* values: default "simple", the name of any directory in '''vdrift/data/skins/'''

Change the graphics and layout of the VDrift menus.

===Input Graph===
* type: boolean
* setting: display.input_graph
* values: on, off

Visualize the steering and acceleration/braking on screen.

==Advanced Display Options==

===Color Depth===
* type: integer
* setting: display.depth
* values: 16, 32

Adjust the amount of colors available.

===Texture Size===
* type: string
* setting: display.texture_size
* values: "small", "medium", "large"

Change the size of the textures displayed.

===View Distance===
* type: floating-point
* setting: display.view_distance
* values: any positive decimal number of meters

Change the maximum view distance.

===Anisotropic Filtering===
* type: integer
* setting: display.anisotropic
* values: depends on your video card

Set anisotropic filtering level for textures.

===Antialiasing===
* type: integer
* setting: display.antialiasing
* values: depends on your video card

Set the full scene antialiasing level.

===Car Shadows===
* type: boolean
* setting: display.car_shadows
* values: on, off

Draw simple static shadows beneath the cars.

===Field of View===
* type: floating-point
* setting: display.FOV
* values: any positive decimal number

Field of view angle in the vertical direction.

===Lighting Quality===
* type: integer
* setting: display.lighting
* values: 0, 1

Set how good the lighting looks during gameplay. 0 is Low, which is totally static lighting. 1 is Medium, static cube-mapped lighting.

===Reflection Quality===
* type: integer
* setting: display.reflections
* values: 0, 1, 2

Set how good the reflections look during gameplay. 0 is Low, static sphere-mapped reflections. 1 is Medium, static cube-mapped reflections, and 2 is High, dynamic cube-mapped reflections.

Authors and contributors

2010-08-14T15:08:48Z

Venzon: Reverted edits by Jennifertaylor (Talk); changed back to last version by Venzon

{{note|Many people contribute and deserved to be recognized here, but there is no central method to do that. If you have contributed, please obtain a wiki account and update this page.}}

==Authors==
VDrift was created by [http://vdrift.net/users.php?mode=profile&uid=5 Joe Venzon] who continues to write nearly all the source code for the game, and created everything in the game which is not attributed to someone else below.

The physics engine in the game is the [http://vamos.sourceforge.net/ Vamos Automotive Simulator], written by Sam Varner.

==Contributors==
===Code===
* [http://vdrift.net/users.php?mode=profile&uid=4 Chris Guirl] set up the web sites and the Subversion repositories, and is also to blame for the SCons build scripts, XS model, some miscellaneous graphics, the GUI system, bug fixes and reports, documentation, testing, support, and generally annoying Joe.
* rookie1 wrote the automatic shifting code, and the entire artificial intelligence system. He's also fixed a few bugs here and there, and made some improvements to the track editor.
* [http://vdrift.net/users.php?mode=profile&uid=197 Matthew Nicholson] helps with testing and debugging, and has provided help improving the build system. He's also written a much improved error logging system which is not in use yet.
* [http://vdrift.net/users.php?mode=profile&uid=5379 NaN] has rewritten the physics code, added car color selection, and continues to fix bugs and add new features.

===Game Data===
Most of the imported cars and tracks had several authors to begin with, too many to list here. Thanks to them anyway, and in general to [http://www.racer-xtreme.com/ Racer-Xtreme] and the [http://www.racer.nl/ Racer community] at [http://www.rscnet.org/ Race Sim Central].

====Cars====
* [http://vdrift.net/users.php?mode=profile&uid=240 Dick Maurer] imported many cars from Racer and other sources, and created several too.
* cotharyus has improved the car specifications for many models using research done on the internet, as well as play testing.
* [http://vdrift.net/Forum/profile.php?mode=viewprofile&u=1324 TF] created the 360

====Tracks====
* alexr has imported several very good tracks.
* pwp71 has helped update many older tracks' parameters as new track features have become available.

==Ports==
* [http://vdrift.net/users.php?mode=profile&uid=140 Julian Mayer] ported VDrift to Mac OS X.
* [http://vdrift.net/users.php?mode=profile&uid=167 Jose Alonso Cardenas Marquez] manages the VDrift port for FreeBSD.
* [http://vdrift.net/users.php?mode=profile&uid=32 Nathan Samson] manages the VDrift port for Windows (Cygwin) and helped set up the Autopackage builder for Linux. He also added internationalization support.
* [http://vdrift.net/users.php?mode=profile&uid=158 Alex (Nenillo)] took care of the Windows port for a while before Nathan.

==Packagers==
* [http://vdrift.net/users.php?mode=profile&uid=364 Szymon Ender] has packaged VDrift for Slackware Linux and has helped get VDrift into Arch Linux.
* [http://vdrift.net/users.php?mode=profile&uid=197 Matthew Nicholson] and Gonéri Le Bouder have both worked on Debian GNU/Linux packages for VDrift.
* Gonéri Le Bouder has helped get VDrift into Arch Linux.

Enabling force feedback in kernel

2010-07-27T01:34:03Z

Venzon: Reverted edits by AmandaCusack (Talk); changed back to last version by Cborivant

Here is how to enable force feedback on Ubuntu 8.10 64 bits kernels (should also work on 32 bits ones):

==For the G25 owners==
If you use a G25 wheel, you need to patch your kernel to be able to use it in its native mode
First create a patch file named G25.patch for the kernel ( patches for 2.6.27 and 2.6.28 are provided ).

=== kernel 2.6.27 ===
diff -Naur linux-source-2.6.27/drivers/hid/usbhid/hid-ff.c linux-source-2.6.27.orig/drivers/hid/usbhid/hid-ff.c
--- linux-source-2.6.27/drivers/hid/usbhid/hid-ff.c 2008-10-10 00:13:53.000000000 +0200
+++ linux-source-2.6.27.orig/drivers/hid/usbhid/hid-ff.c 2009-02-23 22:21:27.000000000 +0100
@@ -57,6 +57,7 @@
{ 0x46d, 0xc286, hid_lgff_init }, /* Logitech Force 3D Pro Joystick */
{ 0x46d, 0xc294, hid_lgff_init }, /* Logitech Formula Force EX */
{ 0x46d, 0xc295, hid_lgff_init }, /* Logitech MOMO force wheel */
+ { 0x46d, 0xc299, hid_lgff_init }, /* Logitech G25 wheel */
{ 0x46d, 0xca03, hid_lgff_init }, /* Logitech MOMO force wheel */
#endif
#ifdef CONFIG_LOGIRUMBLEPAD2_FF
diff -Naur linux-source-2.6.27/drivers/hid/usbhid/hid-lgff.c linux-source-2.6.27.orig/drivers/hid/usbhid/hid-lgff.c
--- linux-source-2.6.27/drivers/hid/usbhid/hid-lgff.c 2008-10-10 00:13:53.000000000 +0200
+++ linux-source-2.6.27.orig/drivers/hid/usbhid/hid-lgff.c 2009-02-23 22:23:22.000000000 +0100
@@ -55,6 +55,7 @@
{ 0x046d, 0xc286, ff_joystick },
{ 0x046d, 0xc294, ff_joystick },
{ 0x046d, 0xc295, ff_joystick },
+ { 0x046d, 0xc299, ff_joystick },
{ 0x046d, 0xca03, ff_joystick },
};
diff -Naur linux-source-2.6.27/drivers/hid/usbhid/hid-quirks.c linux-source-2.6.27.orig/drivers/hid/usbhid/hid-quirks.c
--- linux-source-2.6.27/drivers/hid/usbhid/hid-quirks.c 2009-03-13 18:54:14.000000000 +0100
+++ linux-source-2.6.27.orig/drivers/hid/usbhid/hid-quirks.c 2009-02-23 22:25:45.000000000 +0100
@@ -316,6 +316,7 @@
#define USB_DEVICE_ID_LOGITECH_HARMONY_64 0xc14f
#define USB_DEVICE_ID_LOGITECH_EXTREME_3D 0xc215
#define USB_DEVICE_ID_LOGITECH_WHEEL 0xc294
+#define USB_DEVICE_ID_LOGITECH_WHEELG25 0xc299
#define USB_DEVICE_ID_LOGITECH_ELITE_KBD 0xc30a
#define USB_DEVICE_ID_LOGITECH_KBD 0xc311
#define USB_DEVICE_ID_S510_RECEIVER 0xc50c
@@ -625,6 +626,7 @@
{ USB_VENDOR_ID_ELO, USB_DEVICE_ID_ELO_TS2700, HID_QUIRK_NOGET },
{ USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_EXTREME_3D, HID_QUIRK_NOGET },
{ USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_WHEEL, HID_QUIRK_NOGET },
+ { USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_WHEELG25, HID_QUIRK_NOGET },
{ USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_WIRELESS_OPTICAL_DESKTOP_3_0, HID_QUIRK_NOGET },
{ USB_VENDOR_ID_PETALYNX, USB_DEVICE_ID_PETALYNX_MAXTER_REMOTE, HID_QUIRK_NOGET },
{ USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },

=== kernel 2.6.28 ===
diff -Naur linux-source-2.6.28/drivers/hid/hid-core.c linux-source-2.6.28.patched/drivers/hid/hid-core.c
--- linux-source-2.6.28/drivers/hid/hid-core.c 2009-04-08 06:38:33.000000000 +0200
+++ linux-source-2.6.28.patched/drivers/hid/hid-core.c 2009-04-10 14:15:27.000000000 +0200
@@ -1290,6 +1290,7 @@
{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_FORCE3D_PRO) },
{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_MOMO_WHEEL) },
{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_MOMO_WHEEL2) },
+ { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_G25_WHEEL) },
{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_RUMBLEPAD2) },
{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_SIDEWINDER_GV) },
{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_NE4K) },
diff -Naur linux-source-2.6.28/drivers/hid/hid-ids.h linux-source-2.6.28.patched/drivers/hid/hid-ids.h
--- linux-source-2.6.28/drivers/hid/hid-ids.h 2008-12-25 00:26:37.000000000 +0100
+++ linux-source-2.6.28.patched/drivers/hid/hid-ids.h 2009-04-10 14:12:44.000000000 +0200
@@ -291,6 +291,7 @@
#define USB_DEVICE_ID_LOGITECH_FORCE3D_PRO 0xc286
#define USB_DEVICE_ID_LOGITECH_WHEEL 0xc294
#define USB_DEVICE_ID_LOGITECH_MOMO_WHEEL 0xc295
+#define USB_DEVICE_ID_LOGITECH_G25_WHEEL 0xc299
#define USB_DEVICE_ID_LOGITECH_ELITE_KBD 0xc30a
#define USB_DEVICE_ID_LOGITECH_KBD 0xc311
#define USB_DEVICE_ID_S510_RECEIVER 0xc50c
diff -Naur linux-source-2.6.28/drivers/hid/hid-lg.c linux-source-2.6.28.patched/drivers/hid/hid-lg.c
--- linux-source-2.6.28/drivers/hid/hid-lg.c 2008-12-25 00:26:37.000000000 +0100
+++ linux-source-2.6.28.patched/drivers/hid/hid-lg.c 2009-04-10 14:14:17.000000000 +0200
@@ -304,6 +304,8 @@
.driver_data = LG_FF },
{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_MOMO_WHEEL2),
.driver_data = LG_FF },
+ { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_G25_WHEEL),
+ .driver_data = LG_FF },
{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_RUMBLEPAD2),
.driver_data = LG_FF2 },
{ }

==Enabling force feedback in the kernel==
===Prepare to compile a kernel===
Make sure U have everything needed to compile your kernel :
sudo apt-get install fakeroot build-essential makedumpfile libncurses5 libncurses5-dev kernel-package
sudo apt-get build-dep linux
Get the kernel source code :
sudo apt-get install linux-source
Now we are ready to start :
Prepare your environment:
mkdir ~/src
cd ~/src
tar xjvf /usr/src/linux-source-<version>.tar.bz2
cd linux-source-<version>

===Apply the G25 patch if needed===
copy the G25.patch file into the source directory ( ~/src ) and
patch -p1 <../G25.patch
the output should be something like that:
patching file drivers/hid/usbhid/hid-ff.c
patching file drivers/hid/usbhid/hid-lgff.c
patching file drivers/hid/usbhid/hid-quirks.c

===Configure the new kernel===
Get the running kernel configuration:
cp -vi /boot/config-`uname -r` .config
Adjust the kernel configuration:
make oldconfig
make menuconfig
Go to Device Drivers , and HID Devices
and enable the following options
Force feedback support (EXPERIMENTAL)
PID device support
Logitech devices support
Logitech Rumblepad 2 support
PantherLord/GreenAsia based device support
ThrustMaster devices support
Zeroplus based game controller support
With the 2.6.27 kernel on Ubuntu 8.10, I have to disable paravirtualized guest support otherwise the kernel cleaning fail.
This is not needed on 2.6.28 on Ubuntu 9.04 beta (2.6.28.11)
Go to Processor type and features and disable the following:
Paravirtualized guest support

===Compile and package the new kernel===
make-kpkg clean
fakeroot make-kpkg --initrd --append-to-version=-ff kernel-image kernel-headers
you now have 2 new package files in ~/src.

===Install the new kernel===
sudo dpkg -i linux-image-2.6.27.18-ff_2.6.27.18-ff-10.00.Custom_amd64.deb linux-headers-2.6.27.18-ff_2.6.27.18-ff-10.00.Custom_amd64.deb

Authors and contributors

2010-07-11T17:44:16Z

Venzon: Reverted edits by Alysia (Talk); changed back to last version by Venzon

Authors and contributors

2010-07-07T02:29:33Z

Venzon:

Authors and contributors

2010-07-07T02:24:37Z

Venzon:

{{note|Many people contribute and deserved to be recognized here, but there is no central method to do that. If you have contributed, please obtain a wiki account and update this page.}}

==Authors==
VDrift was created by [http://vdrift.net/users.php?mode=profile&uid=5 Joe Venzon] who continues to write nearly all the source code for the game, and created everything in the game which is not attributed to someone else below.

The physics engine in the game is the [http://vamos.sourceforge.net/ Vamos Automotive Simulator], written by Sam Varner.

==Contributors==
===Code===
* [http://vdrift.net/users.php?mode=profile&uid=4 Chris Guirl] set up the web sites and the Subversion repositories, and is also to blame for the SCons build scripts, XS model, some miscellaneous graphics, the GUI system, bug fixes and reports, documentation, testing, support, and generally annoying Joe.
* rookie1 wrote the automatic shifting code, and the entire artificial intelligence system. He's also fixed a few bugs here and there, and made some improvements to the track editor.
* [http://vdrift.net/users.php?mode=profile&uid=197 Matthew Nicholson] helps with testing and debugging, and has provided help improving the build system. He's also written a [http://www.superiorpapers.com/reasons.php buy term papers] much improved error logging system which is not in use yet.

===Game Data===
Most of the imported cars and tracks had several authors to begin with, too many to list here. Thanks to them anyway, and in general to [http://www.racer-xtreme.com/ Racer-Xtreme] and the [http://www.racer.nl/ Racer community] at [http://www.rscnet.org/ Race Sim Central].

====Cars====
* [http://vdrift.net/users.php?mode=profile&uid=240 Dick Maurer] imported many cars from Racer and other sources, and created several too.
* cotharyus has improved the car specifications for many models using research done on the internet, as well as play testing.
* [http://vdrift.net/Forum/profile.php?mode=viewprofile&u=1324 TF] created the 360

====Tracks====
* alexr has imported several very good tracks.
* pwp71 has helped update many older tracks' parameters as new track features have become available.

==Ports==
* [http://vdrift.net/users.php?mode=profile&uid=140 Julian Mayer] ported VDrift to Mac OS X.
* [http://vdrift.net/users.php?mode=profile&uid=167 Jose Alonso Cardenas Marquez] manages the VDrift port for FreeBSD.
* [http://vdrift.net/users.php?mode=profile&uid=32 Nathan Samson] manages the VDrift port for Windows (Cygwin) and helped set up the Autopackage builder for Linux. He also added internationalization support.
* [http://vdrift.net/users.php?mode=profile&uid=158 Alex (Nenillo)] took care of the Windows port for a while before Nathan.

==Packagers==
* [http://vdrift.net/users.php?mode=profile&uid=364 Szymon Ender] has packaged VDrift for Slackware Linux and has helped get VDrift into Arch Linux.
* [http://vdrift.net/users.php?mode=profile&uid=197 Matthew Nicholson] and Gonéri Le Bouder have both worked on Debian GNU/Linux packages for VDrift.
* Gonéri Le Bouder has helped get VDrift into Arch Linux.

Car parameters for vdrift-2009-06-15 and older

2010-02-07T17:32:24Z

Venzon: /* Tire */

The units are all in [http://scienceworld.wolfram.com/physics/MKS.html MKS] (meters, kilograms, seconds). It might also help to read [http://www.miata.net/sport/Physics/ ''The Physics of Racing''] by Brian Beckman.
For unit conversion you can go to: [http://www.sonar-equipment.com/useful_conversion_factors_table1_p00.htm ''This Site''].

The .car file contains several sections. Each section will now be described, along with example values from the XS.car file. The XS has performance comparable to the Honda S2000.

==Coordinate system==
A vector of 3 floats ( 1.0, 3.0, 1.5 ) will be interpreted as distances from the car body model origin. See [[Coordinate systems]] for a detailed description.

==Top level parameters==
<pre>
drive = RWD
</pre>
The "drive" parameter accepts values "RWD", "FWD", "AWD" that correspond to rear wheel drive, front wheel drive, and all wheel drive, respectively.

<pre>
version = 2
</pre>
The file format version. The only change between version 1 and version 2 is the move to coordinate system version 2, which is described in [[Coordinate systems]]. If no version is specified version 1 is assumed. VDrift is backward compatible with previous file formats. VDrift is not forward compatible with new file formats -- that is, VDrift will refuse to load a file specifying format version 3 if VDrift's code only supports version 2.

==Steering==
<pre>
max-angle = 33.19
</pre>
This defines the maximum angle that the wheels will turn in each direction. For the XS, when the steering wheel is full left, the wheels would be at -33.19 degrees.

==Engine==
<pre>
position = 0.86, 0.0, -0.21
mass = 140.0
max-power = 1.79e5
peak-engine-rpm = 7800.0
rpm-limit = 9000.0
inertia = 0.25
idle = 0.02
start-rpm = 1000
stall-rpm = 350
fuel-consumption = 1e-9
torque-friction = 0.0003
torque-curve-00 = 1000, 140.0
torque-curve-01 = 2000, 149.14
torque-curve-02 = 2200, 145.07
torque-curve-03 = 2500, 147.78
torque-curve-04 = 3000, 169.50
torque-curve-05 = 3300, 172.19
torque-curve-06 = 4000, 169.50
torque-curve-07 = 4500, 166.77
torque-curve-08 = 5600, 172.19
torque-curve-09 = 5800, 170.83
torque-curve-10 = 6000, 168.12
torque-curve-11 = 6100, 177.61
torque-curve-12 = 6200, 186.42
torque-curve-13 = 6300, 192.53
torque-curve-14 = 6500, 195.92
torque-curve-15 = 6700, 195.92
torque-curve-16 = 7000, 195.24
torque-curve-17 = 7600, 190.49
torque-curve-18 = 8000, 184.39
torque-curve-19 = 8200, 183.04
torque-curve-20 = 8300, 146.43
torque-curve-21 = 9500, 146.43
</pre>
The position and mass parameters affect the weight distribution of the car. The torque curve is calculated from max-power and peak-engine-rpm using a polynomial expression given in Motor Vehicle Dynamics, Genta (1997), where peak-engine-rpm is the engine speed at which the maximum power output (max-power) is achieved. Alternatively, the torque curve can be explicitly defined, as in the example above. A rev limit can be set with rpm-limit. The rotational inertia of the moving parts is inertia. idle is the throttle position at idle. Starting the engine initially sets the engine speed to start-rpm. Letting the engine speed drop below stall-rpm makes the engine stall. The rate of fuel consumption is set with fuel-consumption. The actual fuel consumed each second (in units of liters) is the fuel-consumption parameter times RPM times throttle (throttle is from 0.0 to 1.0, where 1.0 is full throttle).

==Clutch==
<pre>
sliding = 0.27
radius = 0.15
area = 0.75
max-pressure = 11079.26
</pre>
The clutch is described by its sliding friction coefficient, radius, area and maximum applied pressure. The torque capacity(maximum transmitted torque) of the clutch is TC = sliding * radius * area * max-pressure. It should be somewhere between one and two times the maximum enine torque. TC = 1.25 * max-engine-torque is a good start value.

==Transmission==
<pre>
gears = 6
gear-ratio-r = -2.8
gear-ratio-1 = 3.133
gear-ratio-2 = 2.045
gear-ratio-3 = 1.481
gear-ratio-4 = 1.161
gear-ratio-5 = 0.943
gear-ratio-6 = 0.763
shift-time = 0.2
</pre>
The number of forward gears is set with the gears parameter. The gear ration for reverse and all of the forward gears is then defined. The shift-time tag tells how long it takes, in total seconds, to change gears (when autoclutch is enabled). Half the time is spent changing the gear and the other half is spent letting the clutch out. This parameter is not required and defaults to 0.2 seconds, which is a reasonable value for a manual transmission. F1 cars take about 50 ms, by comparison.

==Differential==
<pre>
final-drive = 4.100
anti-slip = 600.0
anti-slip-torque = 1
anti-slip-torque-deceleration-factor = 0
</pre>
The final drive provides an additional gear reduction. The anti-slip parameter defines the maximum anti-slip torque. For speed-sensitive differentials, it also defines the anti-slip torque per radian per second of speed difference between the wheels. If the differential is speed-sensitive, the anti-slip-torque and anti-slip-torque-deceleration-factor parameters must be omitted or set to zero. If the differential is torque-sensitive, then anti-slip-torque defines the amount of anti-slip torque per input torque. The anti-slip-torque-deceleration-factor defines the amount of anti-slip torque per negative input torque. For a 1-way torque-sensitive LSD, set anti-slip-torque-deceleration-factor to zero, for a 2-way torque-sensitive LSD, set anti-slip-torque-deceleration-factor to 1.0, for 1.5-way, set it between 0.0 and 1.0.

==Fuel tank==
<pre>
position = -0.8, -0.1, -0.26
capacity = 0.0492
volume = 0.0492
fuel-density = 730.0
</pre>
The fuel tank's position, the current volume of fuel and the density of the fuel affect the car's weight distribution. The capacity tag sets the maximum volume of fuel that the tank can hold. The initial volume is set with the volume tag. The density of the fuel is set with fuel-density.

==Suspension==
Front/rear parameters are broken into two fields. Per-wheel parameters are broken into four fields. In the example below the front suspension is shown, followed by the front left wheel suspension parameters.
<pre>
[ suspension-front ]
spring-constant = 49131.9
spring-factor-1 = 0.052, 1.0
spring-factor-2 = 0.055, 1.2
bounce = 2588
rebound = 2612
damper-factor-1 = 0.08,1.0
damper-factor-2 = 0.1, 0.7
travel = 0.19
camber = -1.33
caster = 6.12
toe = 0.0
anti-roll = 8000.0
</pre>
<pre>
[ suspension-FL ]
hinge = 0,0,0
</pre>
The spring-constant is the '''wheel rate''' in N/m. The spring-factor-1 and 2 parameters define a curve for the spring response. These can be omitted if desired, in which case a factor of 1.0 will be used everywhere. Points are defined by specifying an x,y pair where x is the suspension displacement in meters and y is the factor to be applied to the spring coefficient. In this example, the spring factor will be 1.0 when the displacement is between 0 and 0.052 m, and then the spring factor will change linearly to 1.2 at 0.055 m (and beyond). The spring factor gets multiplied by the spring-constant. You can put as many spring-factor points as you want (just increase the spring-factor- number for each additional point). Note that displacement values are relative to the "zero g", "zero force" position. For best results, start VDrift with the -debug option and observe suspension displacements during maneuvering to determine where you want to put your points.

The bounce and rebound parameters are the damping coefficients for compression and expansion of the suspension, respectively, in units of N/m/s. The damper-factor-1 and 2 parameters define a curve for the damper response. These can be omitted if desired, in which case a factor of 1.0 will be used everywhere. Points are defined by specifying an x,y pair where x is an absolute value of suspension velocity in m/s and y is the factor to be applied to the damping coefficient. In this example, the damper factor will be 1.0 when the compression velocity absolute value is between 0 and 0.08 m/s, and then the damper factor will change linearly to 0.7 at 0.1 m/s (and beyond). The damper factor gets applied to the bonce or rebound damper coefficient, depending on the direction of travel. You can put as many damper-factor points as you want (just increase the damper-factor- number for each additional point).

The hinge is the center of the wheel's path as the suspension moves. The location of the hinge is determined by suspension geometry, and may be outside of the car itself.

Wheel alignment is set with the camber, caster, and toe tags. All angles are in degrees.

Note that the suspension position parameter and the max-compression-velocity parameters are no longer used and can be omitted.

==Tire==
Front/rear parameters are broken into two fields. In the example below the front tire section is shown.
<pre>
radius = 0.29
rolling-resistance = 1.3e-2, 6.5e-6
rotational-inertia = 10.0
tread = 0.0
# Lateral force
a0=1.6
a1=-38
a2=1201
a3=1914
a4=8.7
a5=0.014
a6=-0.24
a7=1.0
a8=-0.03
a9=-0.0013
a10=-0.15
a111=-8.5
a112=-0.29
a12=17.8
a13=-2.4
# Longitudinal force
b0=1.7
b1=-80
b2=1571
b3=23.3
b4=300
b5=0
b6=0.0068
b7=0.055
b8=-0.024
b9=0.014
b10=0.26
b11=-86
b12=350
# Aligning moment
c0=2.3
c1=-3.8
c2=-3.14
c3=-1.16
c4=-7.2
c5=0.0
c6=0.0
c7=0.044
c8=-0.58
c9=0.18
c10=0.043
c11=0.048
c12=-0.0035
c13=-0.18
c14=0.14
c15=-1.029
c16=0.27
c17=-1.1
</pre>
The two elements of rolling-resistance are the constant and velocity-squared terms, respectively. Radius defines the radius of the tire. The tread parameter ranges over arbitrary values of 0.0 to 1.0, where 0.0 is a road tire and 1.0 is an off-road tire. The longitudinal, transverse, and aligning section each contain a vector of “magic formula” coefficients as presented in Motor Vehicle Dynamics, Genta (1997). A description is shown below:
<pre>
Shape factor ........................................... A0
Load infl. on lat. friction coeff (*1000)... (1/kN) .... A1
Lateral friction coefficient at load = 0 (*1000) ....... A2
Maximum stiffness ........................ (N/deg) ..... A3
Load at maximum stiffness ................ (kN) ........ A4
Camber infiuence on stiffness ............ (%/deg/100) . A5
Curvature change with load ............................. A6
Curvature at load = 0 .................................. A7
Horizontal shift because of camber ........(deg/deg).... A8
Load influence on horizontal shift ........(deg/kN)..... A9
Horizontal shift at load = 0 ..............(deg)........ A10
Camber influence on vertical shift ........(N/deg/kN)... A111
Camber influence on vertical shift ........(N/deg/kN**2) A112
Load influence on vertical shift ..........(N/kN)....... A12
Vertical shift at load = 0 ................(N).......... A13

Shape factor ........................................... B0
Load infl. on long. friction coeff (*1000)... (1/kN) ... B1
Longitudinal friction coefficient at load = 0 (*1000)... B2
Curvature factor of stiffness ............ (N/%/kN**2) . B3
Change of stiffness with load at load = 0 (N/%/kN) ..... B4
Change of progressivity of stiffness/load (1/kN) ....... B5
Curvature change with load ............................. B6
Curvature change with load ............................. B7
Curvature at load = 0 .................................. B8
Load influence on horizontal shift ....... (%/kN) ...... B9
Horizontal shift at load = 0 ............. (%) ......... B10
Load influence on vertical shift ......... (N/kN) ...... B11
Vertical shift at load = 0 ............... (N) ......... B12

Shape factor ........................................... C0
Load influence of peak value ............ (Nm/kN**2) ... C1
Load influence of peak value ............ (Nm/kN) ...... C2
Curvature factor of stiffness ........... (Nm/deg/kN**2) C3
Change of stiffness with load at load = 0 (Nm/deg/kN) .. C4
Change of progressivity of stiffness/load (1/kN) ....... C5
Camber influence on stiffness ........... (%/deg/100) .. C6
Curvature change with load ............................. C7
Curvature change with load ............................. C8
Curvature at load = 0 .................................. C9
Camber influence of stiffness .......................... C10
Camber influence on horizontal shift......(deg/deg)..... C11
Load influence on horizontal shift........(deg/kN)...... C12
Horizontal shift at load = 0..............(deg)......... C13
Camber influence on vertical shift........(Nm/deg/kN**2) C14
Camber influence on vertical shift........(Nm/deg/kN)... C15
Load influence on vertical shift..........(Nm/kN)....... C16
Vertical shift at load = 0................(Nm).......... C17
</pre>
More information can be found at http://members.xoom.virgilio.it/adiaforo/epcjk.htm or if it's down try http://web.archive.org/web/20050913052226/http://members.xoom.virgilio.it/adiaforo/epcjk.htm

==Brakes==
Front/rear parameters are broken into two fields. In the example below the front section is shown.
<pre>
friction = 0.73
max-pressure = 4.0e6
bias = 0.60
radius = 0.14
area = 0.015
</pre>
The bias parameter is the fraction of braking pressure applied to the front brakes (in the front brake section) or the rear brakes (in the rear brake section). To make sense, the rear value should equal 1.0 minus the front value. The maximum brake torque is calculated as friction * area * bias * max-pressure * radius. Some fraction of this value is applied based on the brake pedal.

==Driver==
<pre>
position = -0.62, -0.35, -0.12
mass = 90.0
view-position = -0.64, 0.35, 0.30
hood-mounted-view-position = 0.55, 0, 0.17
view-stiffness = 0.0
</pre>
The position and mass affect the weight distribution of the car. The view positions define 3D coordinates for camera placement. The view-stiffness parameter defines the stiffness of the camera bounce effect, where 0.0 is a sports car and 1.0 is F1-ish.

==Drag==
<pre>
position = 0.0, 0.0, 0.2
frontal-area = 2
drag-coefficient = 0.3
</pre>
The frontal area and coefficient of drag, set with frontal-area and drag-coefficient, are used to calculate the drag force.

==Wing==
Front/rear parameters are broken into two fields. In the example below the front section is shown.
<pre>
position = 1.9, 0.0, 0.60
frontal-area = 0.2
drag-coefficient = 0.0
surface-area = 0.3
lift-coefficient = -0.5
efficiency = 0.95
</pre>
Downforce can be added with wings. The amount of downforce is determined by the value in the lift-coefficient tag. If the lift coefficient is positive, upforce is generated. This is usually undesirable for cars. The efficiency determines how much drag is added as downforce increases. The surface-area is the surface area of the wing. This value is also used in the drag calculation.

==Wheel==
Per-wheel parameters are broken into four fields. In the example below the front left wheel is shown.
<pre>
position = 1.14, 0.76, -0.47
roll-height = 0.29
mass = 18.14
restitution = 0.1
</pre>

==Contact-points==
<pre>
mass = 0.05
position-00 = 1.96, 0.37, -0.24
position-01 = 1.96, -0.37, -0.24
position-02 = 1.52, 0.83, 0.16
position-03 = 1.52, -0.83, 0.16
position-04 = -0.10, 0.89, -0.24
position-05 = -0.10, -0.89, -0.24
position-06 = -2.18, -0.83, -0.10
position-07 = -2.18, 0.83, -0.10
</pre>
These values are used for weight distribution and balance only. They no longer perform any contact-related function. So, contact-points are the same as particles (defined below), but the syntax is slightly different.

==Particle==
These parameters are broken into a series of values starting at 00 and going to some number less than 100. The particle-00 is shown below.
<pre>
mass = 30.0
position = -1.28, 0.0, -0.36
</pre>
These values are used for weight distribution and balance.

Compiling VDrift

2009-10-17T15:32:01Z

Venzon: /* VDrift */

Compiling VDrift is different depending on the operating system on which it is compiled.

==Linux==
===Prerequisites===
Make sure you have all the required libraries and build tools. Make sure you also have the development files for each of the libraries.

The required build tools include:

* '''g++''' - The GNU C++ compiler
* '''scons''' - A replacement for Make

The required libraries include:

* '''libsdl''' - Simple Direct Media Layer
* '''libglew''' - OpenGL extension utilities
* '''sdl-gfx''' - Graphics drawing primitives library for SDL
* '''sdl-image''' - Image file loading library for SDL
* '''vorbisfile''' - File loading library for the ogg vorbis format
* '''libvorbis''' - The Vorbis General Audio Compression Codec
* Boost C++ Libraries (header-file-only)
* ASIO C++ Libraries (header-file-only)

Your Linux distribution may have different package names and/or bundled differently. The list above should give enough information to search for applicable packages within your distribution's package manager.

For Ubuntu, all the required packages may be installed using this command:
sudo apt-get install g++ scons libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libvorbis-dev libglew-dev libasio-dev libboost-dev

====Bullet====
As of SVN R2358 (2009-06-15 release and later), no steps are required to build bullet and you can continue to the next section.

For the 2009-02-15 release, the only step required is to expand the Bullet source archive:
tar zxvf bullet-2.73-sp1.tgz

{{note|For older versions of VDrift, you will need to follow the [[Old Method of Compiling Bullet]].}}

====SCons====
As of the 2005-10-02 release, VDrift no longer uses ./configure, make, etc. (autotools). Now the project is built with [http://scons.org/ SCons]. You may want to read a little about [[Using SCons]].

There are two ways to use SCons. The first way is to install scons on your system through your package manager, then you can use it simply by the name of the program, "scons". If you followed the directions for installing prerequisites for Ubuntu above, then you're done and can continue on to the next section. The second way is to use the scons-local package (included with VDrift) which will do the same thing but doesn't require that you install scons on your system. To do this, you must move the scons-local-0.96.95.tar.gz archive from tools to the root vdrift folder, un-tar the archive, and then use the <code>./scons.py</code> command instead of <code>scons</code>.

===Get the Code===
You can get the code from a source package for a particular version, or you can [[Getting the development version|get the development version]].
====Source Package====
[http://sourceforge.net/project/showfiles.php?group_id=137283 Download] the latest VDrift Linux source package. All the files in the package are in a directory called vdrift-'''version'''-src where '''version''' is something like 2009-06-15.

Unpack the archive.

tar jxvf vdrift-2009-06-15-src.tar.bz2

=====Enter directory=====
Now change directories into the location of your newly created VDrift source tree.
cd vdrift-2009-06-15

====Optional: Using scons-local instead of installing SCons====
If you have decided not to install SCons on your system, you can use scons-local. To set it up, do the following:

tar zxvf tools/scons-local-0.96.1.tar.gz

{{note|Some of the following steps refer to the <code>scons</code> command, you should now replace that with <code>./scons.py</code>.}}

===Compiling===
To compile VDrift, just use the <code>scons</code> command.
scons

====Optional: Compile Options====
You can use one or more compile options. To compile with optimization for a certain platform, you can use the '''arch''' option.
scons arch=a64
Compiling VDrift in '''release''' mode will turn off debugging options, and enable more compiler optimizations. VDrift runs much more quickly in release mode.
scons release=1
{{note|These options are probably best left off the first time you compile. If you have problems compiling or running VDrift, it is easier to debug with them off. Once you verify that VDrift is compiling, then recompile with these optimizations to improve performance.}}

===Installing===
VDrift does not need to be installed to work and you can run it from the folder where you compiled it. If you do want to install, use the SCons build target '''install'''. This command must be run as root.
sudo scons install
{{note|The <code>scons install</code> process was broken for several releases including the 2009-02-15 release and may fail to install needed datafiles. If you have release 2009-02-15 or earlier, run "sudo scons install" as noted above and then manually re-copy the data files to the installed destination folder:
sudo cp -r data/* /usr/share/games/vdrift/data}}

====Optional: Installation Location====
You can change the installation prefix. For example, if you want VDrift to go in <code>/usr/local/share/games/vdrift</code>, you can change the '''prefix''' setting.
scons install prefix=/usr/local

{{note|There are many more build and install options, see the [[Using SCons]] page for more information.}}

===Running===
For release 2009-02-15 and earlier, if you used the default install locations, VDrift can be run with the command:
/usr/share/games/vdrift/bin/vdrift
For release 2009-06-15 and later, if you used the default install locations, VDrift can be run with the command:
/usr/local/bin/vdrift

==Mac OS X==
===Prerequisites===
The VDrift Mac OS X project requires Xcode version 2.2 with the "10.4 Universal SDK" and the "X11 SDK" installed.

===Download===
Get the VDrift source code, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Mac OS X|development version]].

===Build===
Finally open ''tools/osx/vdrift.xcodeproj'' and hit "Build" from XCode's "Build" menu.

==Windows==
In order to build VDrift for Windows, you must set up the tools to build the software, build Bullet and VDrift, and then install VDrift into a runtime folder.

===Install and Configure Build Tools===
To build VDrift on Windows you'll need working installations of [http://www.mingw.org/ MinGW], [http://www.mingw.org/msys.shtml MSYS and MSYS-DTK], [http://www.python.org/ Python], and [http://www.scons.org/ SCons].
{{note|The versions listed for these tools were the ones used at time of this writing (current stable versions of all packages), there may be new versions. This is a known working configuration.}}
====MinGW====
* [http://downloads.sourceforge.net/mingw/MinGW-5.1.3.exe?modtime=1168811236&big_mirror=1 Download MinGW 5.1.3]
* Run the installer.
* When asked to select components for install, you only need the base system and the g++ compiler.
* Choose the default install location.
====MSYS====
* [http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe?modtime=1079444447&big_mirror=1 Download MSYS 1.0.10]
* Run the installer.
* Choose the default install location.
* When presented with a terminal asking if you want to continue with the post-install, type '''y''', then press enter.
* When asked if MinGW is installed, enter '''C:/MinGW''', then press enter.
* The MSYS post install script should find your MinGW installation now and configure itself.
====MSYS DTK====
* [http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe?modtime=1041430674&big_mirror=1 Download MSYS-DTK 1.01]
* Run the installer and accept all the defaults.
====Python====
* [http://www.python.org/ftp/python/2.5.1/python-2.5.1.msi Download Python 2.5.1]
* Run the installer and accept all the defaults.
====SCons====
* [http://www.scons.org/ SCons 0.97]
* Run the installer. It should find your Python installation, accept all defaults.

===Download VDrift Source and Data===
Get the VDrift source code and data, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Windows|development version]].

{{note|From this point on the directory in which you checked out VDrift will be referred to as the root VDrift directory. The development environment setup script puts this in an environment variable $VDRIFT_DIR.}}

===Building===
====Boost====
Download a Boost distribution from this link:

http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041&release_id=679861

Uncompress Boost, and move the boost_1_39_0/boost folder to VDrift/tools/win/include

====ASIO====
Download the ASIO distribution from this link:

http://sourceforge.net/project/showfiles.php?group_id=122478&package_id=134200&release_id=665620

Uncompress ASIO, and move asio-1.4.1/include/* to VDrift/tools/win/include

====VDrift====
To build VDrift you must use the MSYS terminal, compile the Bullet library, and compile VDrift itself.
* Launch MSYS by clicking '''Start''' -> '''Programs''' -> '''MinGW''' -> '''MSYS''' -> '''msys'''.
* Change directories to the spot where you checked VDrift out. If your username is '''Administrator''' and you put it on your Desktop in a directory named '''VDrift''', you would enter this command:
cd /c/Documents\ and\ Settings/Administrator/Desktop/VDrift
* Now, to build VDrift, run the command:
sh tools/win/bin/build_vdrift.sh

===Run VDrift===
* Move or copy the VDrift data to a directory named data within the root VDrift directory. This can be done in a few different ways, depending on how you obtained the VDrift data. You could check it out directly here, or you could check it out in another place and use TortoiseSVN to export it to this location. If you downloaded a VDrift data archive you can extract it here, or extract it elsewhere and then move or copy the necessary files to runtime. In the end, just make sure you have a directory structure with paths like '''VDrift/data/cars/''', '''VDrift/data/tracks/''', etc.
===Running===
Now, to run VDrift, you just need to double-click on the file '''vdrift.exe''' within the root VDrift directory.

Compiling VDrift

2009-10-07T02:54:36Z

Venzon: /* Prerequisites */

Compiling VDrift is different depending on the operating system on which it is compiled.

==Linux==
===Prerequisites===
Make sure you have all the required libraries and build tools. Make sure you also have the development files for each of the libraries.

The required build tools include:

* '''g++''' - The GNU C++ compiler
* '''scons''' - A replacement for Make

The required libraries include:

* '''libsdl''' - Simple Direct Media Layer
* '''libglew''' - OpenGL extension utilities
* '''sdl-gfx''' - Graphics drawing primitives library for SDL
* '''sdl-image''' - Image file loading library for SDL
* '''vorbisfile''' - File loading library for the ogg vorbis format
* '''libvorbis''' - The Vorbis General Audio Compression Codec
* Boost C++ Libraries (header-file-only)
* ASIO C++ Libraries (header-file-only)

Your Linux distribution may have different package names and/or bundled differently. The list above should give enough information to search for applicable packages within your distribution's package manager.

For Ubuntu, all the required packages may be installed using this command:
sudo apt-get install g++ scons libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libvorbis-dev libglew-dev libasio-dev libboost-dev

====Bullet====
As of SVN R2358 (2009-06-15 release and later), no steps are required to build bullet and you can continue to the next section.

For the 2009-02-15 release, the only step required is to expand the Bullet source archive:
tar zxvf bullet-2.73-sp1.tgz

{{note|For older versions of VDrift, you will need to follow the [[Old Method of Compiling Bullet]].}}

====SCons====
As of the 2005-10-02 release, VDrift no longer uses ./configure, make, etc. (autotools). Now the project is built with [http://scons.org/ SCons]. You may want to read a little about [[Using SCons]].

There are two ways to use SCons. The first way is to install scons on your system through your package manager, then you can use it simply by the name of the program, "scons". If you followed the directions for installing prerequisites for Ubuntu above, then you're done and can continue on to the next section. The second way is to use the scons-local package (included with VDrift) which will do the same thing but doesn't require that you install scons on your system. To do this, you must move the scons-local-0.96.95.tar.gz archive from tools to the root vdrift folder, un-tar the archive, and then use the <code>./scons.py</code> command instead of <code>scons</code>.

===Get the Code===
You can get the code from a source package for a particular version, or you can [[Getting the development version|get the development version]].
====Source Package====
[http://sourceforge.net/project/showfiles.php?group_id=137283 Download] the latest VDrift Linux source package. All the files in the package are in a directory called vdrift-'''version'''-src where '''version''' is something like 2009-06-15.

Unpack the archive.

tar jxvf vdrift-2009-06-15-src.tar.bz2

=====Enter directory=====
Now change directories into the location of your newly created VDrift source tree.
cd vdrift-2009-06-15

====Optional: Using scons-local instead of installing SCons====
If you have decided not to install SCons on your system, you can use scons-local. To set it up, do the following:

tar zxvf tools/scons-local-0.96.1.tar.gz

{{note|Some of the following steps refer to the <code>scons</code> command, you should now replace that with <code>./scons.py</code>.}}

===Compiling===
To compile VDrift, just use the <code>scons</code> command.
scons

====Optional: Compile Options====
You can use one or more compile options. To compile with optimization for a certain platform, you can use the '''arch''' option.
scons arch=a64
Compiling VDrift in '''release''' mode will turn off debugging options, and enable more compiler optimizations. VDrift runs much more quickly in release mode.
scons release=1
{{note|These options are probably best left off the first time you compile. If you have problems compiling or running VDrift, it is easier to debug with them off. Once you verify that VDrift is compiling, then recompile with these optimizations to improve performance.}}

===Installing===
VDrift does not need to be installed to work and you can run it from the folder where you compiled it. If you do want to install, use the SCons build target '''install'''. This command must be run as root.
sudo scons install
{{note|The <code>scons install</code> process was broken for several releases including the 2009-02-15 release and may fail to install needed datafiles. If you have release 2009-02-15 or earlier, run "sudo scons install" as noted above and then manually re-copy the data files to the installed destination folder:
sudo cp -r data/* /usr/share/games/vdrift/data}}

====Optional: Installation Location====
You can change the installation prefix. For example, if you want VDrift to go in <code>/usr/local/share/games/vdrift</code>, you can change the '''prefix''' setting.
scons install prefix=/usr/local

{{note|There are many more build and install options, see the [[Using SCons]] page for more information.}}

===Running===
For release 2009-02-15 and earlier, if you used the default install locations, VDrift can be run with the command:
/usr/share/games/vdrift/bin/vdrift
For release 2009-06-15 and later, if you used the default install locations, VDrift can be run with the command:
/usr/local/bin/vdrift

==Mac OS X==
===Prerequisites===
The VDrift Mac OS X project requires Xcode version 2.2 with the "10.4 Universal SDK" and the "X11 SDK" installed.

===Download===
Get the VDrift source code, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Mac OS X|development version]].

===Build===
Finally open ''tools/osx/vdrift.xcodeproj'' and hit "Build" from XCode's "Build" menu.

==Windows==
In order to build VDrift for Windows, you must set up the tools to build the software, build Bullet and VDrift, and then install VDrift into a runtime folder.

===Install and Configure Build Tools===
To build VDrift on Windows you'll need working installations of [http://www.mingw.org/ MinGW], [http://www.mingw.org/msys.shtml MSYS and MSYS-DTK], [http://www.python.org/ Python], and [http://www.scons.org/ SCons].
{{note|The versions listed for these tools were the ones used at time of this writing (current stable versions of all packages), there may be new versions. This is a known working configuration.}}
====MinGW====
* [http://downloads.sourceforge.net/mingw/MinGW-5.1.3.exe?modtime=1168811236&big_mirror=1 Download MinGW 5.1.3]
* Run the installer.
* When asked to select components for install, you only need the base system and the g++ compiler.
* Choose the default install location.
====MSYS====
* [http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe?modtime=1079444447&big_mirror=1 Download MSYS 1.0.10]
* Run the installer.
* Choose the default install location.
* When presented with a terminal asking if you want to continue with the post-install, type '''y''', then press enter.
* When asked if MinGW is installed, enter '''C:/MinGW''', then press enter.
* The MSYS post install script should find your MinGW installation now and configure itself.
====MSYS DTK====
* [http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe?modtime=1041430674&big_mirror=1 Download MSYS-DTK 1.01]
* Run the installer and accept all the defaults.
====Python====
* [http://www.python.org/ftp/python/2.5.1/python-2.5.1.msi Download Python 2.5.1]
* Run the installer and accept all the defaults.
====SCons====
* [http://www.scons.org/ SCons 0.97]
* Run the installer. It should find your Python installation, accept all defaults.

===Download VDrift Source and Data===
Get the VDrift source code and data, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Windows|development version]].

{{note|From this point on the directory in which you checked out VDrift will be referred to as the root VDrift directory. The development environment setup script puts this in an environment variable $VDRIFT_DIR.}}

===Building===
====Boost====
Download a Boost distribution from this link:

http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041&release_id=679861

Uncompress Boost, and move the boost_1_39_0/boost folder to VDrift/tools/win/include

====ASIO====
Download the ASIO distribution from this link:

http://sourceforge.net/project/showfiles.php?group_id=122478&package_id=134200&release_id=665620

Uncompress ASIO, and move asio-1.4.1/include/* to VDrift/tools/win/include

====VDrift====
To build VDrift you must use the MSYS terminal, compile the Bullet library, and compile VDrift itself.
* Launch MSYS by clicking '''Start''' -> '''Programs''' -> '''MinGW''' -> '''MSYS''' -> '''msys'''.
* Change directories to the spot where you checked VDrift out. If your username is '''Administrator''' and you put it on your Desktop in a directory named '''VDrift''', you would enter this command:
cd /c/Documents\ and\ Settings/Administrator/Desktop/VDrift
* Now, to build VDrift, run the command:
build_vdrift.sh

===Run VDrift===
* Move or copy the VDrift data to a directory named data within the root VDrift directory. This can be done in a few different ways, depending on how you obtained the VDrift data. You could check it out directly here, or you could check it out in another place and use TortoiseSVN to export it to this location. If you downloaded a VDrift data archive you can extract it here, or extract it elsewhere and then move or copy the necessary files to runtime. In the end, just make sure you have a directory structure with paths like '''VDrift/data/cars/''', '''VDrift/data/tracks/''', etc.
===Running===
Now, to run VDrift, you just need to double-click on the file '''vdrift.exe''' within the root VDrift directory.

Creating tracks

2009-09-13T18:58:21Z

Venzon: /* Directions for creating tracks */

{{note|These instructions are meant for Linux, not Windows. Although you can do this on Windows, you'll probably need to ask for better directions on the VDrift forums.
http://vdrift.net/Forum/index.php}}

==What you need==
* Vdrift program
* Vdrift level editor
* Blender 2.33 or higher. Tested on 2.45 with Python 2.5.1
* Blender JOE export script. Get that here: http://svn.vdrift.net/repos/vdrift-art/trunk/tools/
Get the "export-all-joe-0.3.py" script. The differnce in the files is that one exports all the object in the scene and the other only exports the one that is selected.

==Getting the level editor==
In the Linux console, copy ''everything'' below:
svn co http://svn.vdrift.net/repos/vdrift-trackeditor/trunk vdrift-trackeditor

==Directions for creating tracks==
* Model the scene. See the [[track modeling tutorial]] for help with this step.
* If you use a 3d editor other than blender, import the track into blender.
* Use the export-all-joe-0.3.py blender export script to export all objects. This script can be found in the VDrift art repository under the tools folder. The export script creates a number of .joe files and a list.txt file. The list.txt file may be named somename-list.txt, in which case you should rename it to list.txt
* Create new folder for track in track editor folder TRACKEDITOR_TP (if your track is called parkinglot, the path could be /home/joe/VDrift-trackeditor/data/tracks/parkinglot).
* Make folder TRACKEDITOR_TP/objects/
* Copy all of the .joe files and the list.txt file to TRACKEDITOR_TP/objects/
* Open track editor data/tracks/editor.config and set active track to TRACKEDITOR_TP.
* Run the track editor. Trace the roadways and mark the starting position (press H for help).
{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''Why trace roadways?'''
[[Image:Track-smoothing.png]]
This is a visual depiction of the track smoothing that occurs when tracing a roadway. Imagine this image is showing the track surface from a side view. The black lines represent the track mesh, and the red lines represent the bezier patches. Once the track has been traced in the track editor, VDrift will use the red lines to do collision instead of the black lines. On the top, this represents a dip in the road. You can see how collision using the red line will behave properly. On the bottom, this represents a bump road. You can see that the red line doesn't change the magnitude of the bumps, it just makes them realistically smooth instead of unrealistically pointy.
|}
* CD to the VDrift-trackeditor/joepack folder. Compile the joepack tool by running
scons
* CD to the TRACKEDITOR_TP/objects folder (this is important, the packfile stores relative paths) and run
/path/to/VDrift-trackeditor/joepack/joepack -c objects.jpk *.joe
* If you want, this command will show you the files in the joepack to allow you to verify the previous step worked correctly:
/path/to/VDrift-trackeditor/joepack/joepack -l objects.jpk
* Copy TRACKEDITOR_TP into the main VDrift tracks folder VDRIFT_TP (for example /home/joe/VDrift/data/tracks/parkinglot). Erase VDRIFT_TP/objects/*.joe since they are all in the pack file now.
* Add VDRIFT_TP/about.txt and ensure that the first line is the name of the track. You should put information about the track author, where the track came from, etc in the second line and on.
* Run VDrift and check out what the track looks like in-game. Note that you will only be able to drive on the roadways you defined in the track editor since no other surfaces have been flagged as collideable. Also take a screenshot for the track selection screen.
* Create a track selection image (a 512x512 png file works best) and save it to VDRIFT_TP/trackshot.png
* Open up all of the texture files in TRACKEDITOR_TP/objects and review which textures belong to objects that should be collide-able (roads and walls), have full brightness (trees), be mipmapped (fences and fine transparent objects sometimes look better when not mipmapped), or be skyboxes.
* Set the correct object properties using the VDrift-tracked/listedit tool (more documentation to come).
* Done!

Creating tracks

2009-09-13T18:57:36Z

Venzon: /* Directions for creating tracks */

{{note|These instructions are meant for Linux, not Windows. Although you can do this on Windows, you'll probably need to ask for better directions on the VDrift forums.
http://vdrift.net/Forum/index.php}}

==What you need==
* Vdrift program
* Vdrift level editor
* Blender 2.33 or higher. Tested on 2.45 with Python 2.5.1
* Blender JOE export script. Get that here: http://svn.vdrift.net/repos/vdrift-art/trunk/tools/
Get the "export-all-joe-0.3.py" script. The differnce in the files is that one exports all the object in the scene and the other only exports the one that is selected.

==Getting the level editor==
In the Linux console, copy ''everything'' below:
svn co http://svn.vdrift.net/repos/vdrift-trackeditor/trunk vdrift-trackeditor

==Directions for creating tracks==
* Model the scene. See the [[track modeling tutorial]] for help with this step.
* If you use a 3d editor other than blender, import the track into blender.
* Use the export-all-joe-0.3.py blender export script to export all objects. This script can be found in the VDrift art repository under the tools folder. The export script creates a number of .joe files and a list.txt file. The list.txt file may be named somename-list.txt, in which case you should rename it to list.txt
* Create new folder for track in track editor folder TRACKEDITOR_TP (if your track is called parkinglot, the path could be /home/joe/VDrift-trackeditor/data/tracks/parkinglot).
* Make folder TRACKEDITOR_TP/objects/
* Copy all of the .joe files and the list.txt file to TRACKEDITOR_TP/objects/
* Open track editor data/tracks/editor.config and set active track to TRACKEDITOR_TP.
* Run the track editor. Trace the roadways and mark the starting position (press H for help).
{{note|Why trace roadways?
[[Image:Track-smoothing.png]]
This is a visual depiction of the track smoothing that occurs when tracing a roadway. Imagine this image is showing the track surface from a side view. The black lines represent the track mesh, and the red lines represent the bezier patches. Once the track has been traced in the track editor, VDrift will use the red lines to do collision instead of the black lines. On the top, this represents a dip in the road. You can see how collision using the red line will behave properly. On the bottom, this represents a bump road. You can see that the red line doesn't change the magnitude of the bumps, it just makes them realistically smooth instead of unrealistically pointy. }}
* CD to the VDrift-trackeditor/joepack folder. Compile the joepack tool by running
scons
* CD to the TRACKEDITOR_TP/objects folder (this is important, the packfile stores relative paths) and run
/path/to/VDrift-trackeditor/joepack/joepack -c objects.jpk *.joe
* If you want, this command will show you the files in the joepack to allow you to verify the previous step worked correctly:
/path/to/VDrift-trackeditor/joepack/joepack -l objects.jpk
* Copy TRACKEDITOR_TP into the main VDrift tracks folder VDRIFT_TP (for example /home/joe/VDrift/data/tracks/parkinglot). Erase VDRIFT_TP/objects/*.joe since they are all in the pack file now.
* Add VDRIFT_TP/about.txt and ensure that the first line is the name of the track. You should put information about the track author, where the track came from, etc in the second line and on.
* Run VDrift and check out what the track looks like in-game. Note that you will only be able to drive on the roadways you defined in the track editor since no other surfaces have been flagged as collideable. Also take a screenshot for the track selection screen.
* Create a track selection image (a 512x512 png file works best) and save it to VDRIFT_TP/trackshot.png
* Open up all of the texture files in TRACKEDITOR_TP/objects and review which textures belong to objects that should be collide-able (roads and walls), have full brightness (trees), be mipmapped (fences and fine transparent objects sometimes look better when not mipmapped), or be skyboxes.
* Set the correct object properties using the VDrift-tracked/listedit tool (more documentation to come).
* Done!

Main Page

2009-08-30T15:32:40Z

Venzon:

[[Image:Vdrift-logo.png]]

='''VDrift Documentation Wiki'''=

== Welcome ==
Welcome to the [http://vdrift.net/ VDrift] Documentation Wiki. This site contains some information regarding the VDrift project, but it is not yet complete.

Users are encouraged to make an account and edit articles, or leave comments. To get familiar with this wiki's format and style, read the [[Wiki usage notes]] page.

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''General Info'''
*[[About the project]], [[Community]]
*[[Authors and contributors]]
*[[License]]
*[[Contribution]]
*[[Reporting problems]]
*[[2008 Refactor Project]]
|width="250px"|'''Installation'''
*[[Hardware requirements]]
*[[Software requirements]]
*[[Installing on Linux]]
*[[Installing on FreeBSD]]
*[[Installing on Windows]]
*[[Installing on Mac OS X]]
|}

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''Configuration'''
*[[Configuring the display]]
*[[Configuring the sound]]
*[[Configuring the controls]]
*[[Logitech G25 support]]
*[[Setting up force feedback]]
|width="250px"|'''Playing'''
*[[Replays]]
*[[Drifting Techniques]]
*[[Drift scoring]]
|}

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''Files'''
*[[User settings directory]]
*[[VDrift.config]]
*[[Adding video modes|videomodes]]
*[[options.config]]
*[[Sound/graphics formats]]
*[[JOE format]], [[JOEPack format]]
*[[Configfile format]]
*[[Menu system|Menu file format]]
|width="250px"|'''Development'''
*[[Release Planning]]
*[[Class structure]]
*[[Coding Guidelines]]
*[[Numerical Integration]]
*[[Getting the development version]]
*[[Compiling]]
*[[Using SCons]]
*[[Debugging]]
*[[Packaging]]
*[[Useful links]]
|}

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''Cars'''
*[[Getting more cars]]
*[[List of cars]]
*[[Car files and formats]]
*[[Car parameters]]
*[[Creating cars]]
*[[Car modeling tutorial]]
|width="250px"|'''Tracks'''
*[[List of tracks]]
*[[Track files and formats]]
*[[Creating tracks]]
*[[Track modeling tutorial]]
*[[Importing Racer tracks]]
|}

Old List of cars

2009-08-30T15:32:19Z

Venzon:

These are all the cars currently available in VDrift. Some of them are only available in the [[Getting the development version|development version]].

Refer to [[Getting more cars|this link]] for information about how to install new cars.

* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/360/ 360]: Ferrari F360
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/3S/ 3S]: Mazda 3 series sedan
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/AX2/ AX2]: Fictional Concept Car
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/C7/ C7]: Lotus Super 7 remake aka "Locost"
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/CO/ CO]: Shelby Cobra
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/CS/ CS]: Porsche 911 Clubsport
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/CT/ CT]: Porsche Carrera Turbo
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/F1/ F1]: Modern F1 car
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/FE/ FE]: Ford Escort MKII Rally
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/FF/ FF]: Formula Ford
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/G4/ G4]: Ford GT40
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/GT/ GT]: Ford Mustang GT
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/M3/ M3]: BMW E30 M3
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/M7/ M7]: Mazda RX-7 FC
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/M8/ M8]: Mazda RX-8
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/MC/ MC]: Mini Cooper (new style)
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/MI/ MI]: Mini Cooper (old style)
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/NS/ NS]: Nissan Skyline R32
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/RG/ RG]: Renault 12 Gordini
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/RS2/ RS2]: Subaru Impreza RS 2.5
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/SB/ SB]: sand buggy
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/SV/ SV]: Lamborghini Miura SV
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/T73/ T73]: Lotus 43
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/TC/ TC]: Toyota Celica ST185 Rally
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/TL/ TL]: Toyota Levin
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/TL2/ TL2]: Toyota Levin (model version 2)
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/XG/ XG]: BMW 330cxi
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/XM/ XM]: BMW M3 SPEED World Challenge
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/XS/ XS]: Honda S2000
* [http://vdrift.svn.sourceforge.net/viewvc/vdrift/vdrift-data/cars/Z06/ Z06]: Chevrolet C5 Corvette Z06

Getting more cars

2009-08-30T15:28:54Z

Venzon: New page: This article explains how to get more cars for VDrift and how to install them. ==Getting cars== A number of cars can be found on the [http://cars.vdrift.net cars.vdrift.net] website. Navi...

This article explains how to get more cars for VDrift and how to install them.

==Getting cars==
A number of cars can be found on the [http://cars.vdrift.net cars.vdrift.net] website. Navigate to the car you'd like to download and if the car status says it's playable in VDrift, download the .zip file or follow the link to the .tar.gz file.

==Installing cars==
You should have a .zip or .tar.gz file at this point. The .zip or .tar.gz extensions are both file compression formats. Uncompress the files with a decompression program such as the free tool [http://www.7-zip.org/ 7zip]. This process should create a folder with the name of the car. Move that folder (which should contain files like about.txt and body.joe) to your VDrift/data/cars folder. You're done!

Creating cars

2009-08-30T15:23:23Z

Venzon:

This article gives a rough idea of what it takes to create a car for VDrift.

==Get the Art Tools==
Download the [http://svn.vdrift.net/viewvc.cgi/trunk/tools/?root=VDrift+Art Blender export scripts] from [[Getting the development version|SVN]].

==Create Models==
You will need to create 3D models using Blender for the car's body, the glass pieces, and the wheels. Each different model must be a separate Blender object and each must have a separate texture. Models must be entirely made of triangles. Units of the models are in meters.

===Coordinate Systems===
See [[Coordinate systems]]

===Shading and Smoothing===
Faces (and perhaps individual vertices) can be set to smooth or solid shading, and that will get exported in the joe file. The best way to do smoothing is to select all of the faces, set solid, and then select groups that should be blended together and do set smooth individually. That makes it so that smooth parts that intersect in a hard edge have correct normals. Don't use any double-sided faces.

===Body Model===
In the model pack you will find a Blender file "test.blend". This is the default car model. The glass is one object and the rest of the car is one object. This allows you to export the glass as a "glass.joe" file and the rest of the car as a "body.joe" file. The car should be in the neighborhood of 3500 faces (car and windows combined), although less is of course possible and more is probably also acceptable. The body can be placed anywhere, although by convention the body is usually placed so that the center of the model is near the origin.

===Interior Model===
The interior model should fit inside the body model to provide the inside of the car. This is a separate model so it can appear flat instead of shiny like the painted exterior. The interior model should share the center point or object handle of the body model so they fit together perfectly without being translated.

===Wheel Model===
The file "wheel.blend" is the default wheel model. Try to keep your wheel model under 1000 faces. The wheel model must be centered at the origin.

==Texture the Models==
A single UV map can be used per object for texturing. The .png files are the textures for each associated .joe model. The textures must be 512x512 24- or 32-bit PNG images. Their names should be the same as the model they coordinate with except for the .png extension at the end. For example, the texture for the model "body.joe" must be named "body.png".

===Brake lights===
Add a texture "brake.png" that is the same as the body graphic, but the brake lights are now on and the rest of the file is black. This should be a 24-bit png file (no alpha channel).

==Export the Models==
Using the Python scripts ("export-joe-0.3.py" and "export-all-joe-0.3.py") you can export objects modeled in Blender to JOE format. The mesh needs to be all triangles before export. The currently selected object is exported. Object level transformations are not exported, so make sure any rotation or moving or scaling is done in edit mode, not object mode. You can actually position the car wherever you want, but all of your positioning must match up with the values in the car's .car file. The default exporter setting of 1 frame is what you should use. The export-all script exports all the objects to files based on the objects' names.

==About file==
Write a short text file about your car. This goes in the about.txt file. This information is displayed in the car selection menu. Please include information such as authorship and license. See the other cars for examples.

==Car Definition File==
Finally you must write car definition file, which contains all of the [[car parameters]]. You can start by copying tools/cars/blank.car and entering values to fit your vehicle. Try to find accurate information regarding the specifications of the car and duplicate it as closely as possible. The units are all in [http://scienceworld.wolfram.com/physics/MKS.html MKS] (meters, kilograms, seconds). It might also help to read [http://www.miata.net/sport/Physics/ ''The Physics of Racing''] by Brian Beckman.

Needless to say, it requires a lot of knowledge to create a car definition file from scratch so it is suggested that you try using values from other cars. Many of the [http://www.racer-xtreme.com/ community-made cars for Racer] have very similar values that can be used for VDrift.

==Locations==
All the files needed for a car go into the directory '''data/cars/car_name/''', where ''car_name'' is the short name of the car.

==Need Help?==
Try the related wiki articles on [[car files and formats]], [[car parameters]], or the [[car modeling tutorial]]. If you get stuck, feel free to ask questions in our [http://vdrift.net/forum/index.php?forum=1 VDrift.net Help forum] or on [http://vdrift.net/staticpages/index.php/irc-chat VDrift IRC]

==Contribute==
Once you create a new car please contribute it back to the game so that others can enjoy it. The best way to do this is to start a thread in our [http://vdrift.net/Forum/index.php?forum=5 Development forum] or to create an account on [http://cars.vdrift.net cars.vdrift.net] and upload it there.

Main Page

2009-08-30T15:16:25Z

Venzon:

[[Image:Vdrift-logo.png]]

='''VDrift Documentation Wiki'''=

== Welcome ==
Welcome to the [http://vdrift.net/ VDrift] Documentation Wiki. This site contains some information regarding the VDrift project, but it is not yet complete.

Users are encouraged to make an account and edit articles, or leave comments. To get familiar with this wiki's format and style, read the [[Wiki usage notes]] page.

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''General Info'''
*[[About the project]], [[Community]]
*[[Authors and contributors]]
*[[License]]
*[[Contribution]]
*[[Reporting problems]]
*[[2008 Refactor Project]]
|width="250px"|'''Installation'''
*[[Hardware requirements]]
*[[Software requirements]]
*[[Installing on Linux]]
*[[Installing on FreeBSD]]
*[[Installing on Windows]]
*[[Installing on Mac OS X]]
|}

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''Configuration'''
*[[Configuring the display]]
*[[Configuring the sound]]
*[[Configuring the controls]]
*[[Logitech G25 support]]
*[[Setting up force feedback]]
|width="250px"|'''Playing'''
*[[Replays]]
*[[Drifting Techniques]]
*[[Drift scoring]]
|}

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''Files'''
*[[User settings directory]]
*[[VDrift.config]]
*[[Adding video modes|videomodes]]
*[[options.config]]
*[[Sound/graphics formats]]
*[[JOE format]], [[JOEPack format]]
*[[Configfile format]]
*[[Menu system|Menu file format]]
|width="250px"|'''Development'''
*[[Release Planning]]
*[[Class structure]]
*[[Coding Guidelines]]
*[[Numerical Integration]]
*[[Getting the development version]]
*[[Compiling]]
*[[Using SCons]]
*[[Debugging]]
*[[Packaging]]
*[[Useful links]]
|}

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''Cars'''
*[[List of cars]]
*[[Getting more cars]]
*[[Car files and formats]]
*[[Car parameters]]
*[[Creating cars]]
*[[Car modeling tutorial]]
|width="250px"|'''Tracks'''
*[[List of tracks]]
*[[Track files and formats]]
*[[Creating tracks]]
*[[Track modeling tutorial]]
*[[Importing Racer tracks]]
|}

Main Page

2009-08-30T15:16:11Z

Venzon:

[[Image:Vdrift-logo.png]]

='''VDrift Documentation Wiki'''=

== Welcome ==
Welcome to the [http://vdrift.net/ VDrift] Documentation Wiki. This site contains some information regarding the VDrift project, but it is not yet complete.

Users are encouraged to make an account and edit articles, or leave comments. To get familiar with this wiki's format and style, read the [[Wiki usage notes]] page.

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''General Info'''
*[[About the project]], [[Community]]
*[[Authors and contributors]]
*[[License]]
*[[Contribution]]
*[[Reporting problems]]
*[[2008 Refactor Project]]
|width="250px"|'''Installation'''
*[[Hardware requirements]]
*[[Software requirements]]
*[[Installing on Linux]]
*[[Installing on FreeBSD]]
*[[Installing on Windows]]
*[[Installing on Mac OS X]]
|}

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''Configuration'''
*[[Configuring the display]]
*[[Configuring the sound]]
*[[Configuring the controls]]
*[[Logitech G25 support]]
*[[Setting up force feedback]]
|width="250px"|'''Playing'''
*[[Replays]]
*[[Drifting Techniques]]
*[[Drift scoring]]
|}

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''Files'''
*[[User settings directory]]
*[[VDrift.config]]
*[[Adding video modes|videomodes]]
*[[options.config]]
*[[Sound/graphics formats]]
*[[JOE format]], [[JOEPack format]]
*[[Configfile format]]
*[[Menu system|Menu file format]]
|width="250px"|'''Development'''
*[[Release Planning]]
*[[Class structure]]
*[[Coding Guidelines]]
*[[Numerical Integration]]
*[[Getting the development version]]
*[[Compiling]]
*[[Using SCons]]
*[[Debugging]]
*[[Packaging]]
*[[Useful links]]
|}

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''Cars'''
*[[List of cars]]
*[[Getting new cars]]
*[[Car files and formats]]
*[[Car parameters]]
*[[Creating cars]]
*[[Car modeling tutorial]]
|width="250px"|'''Tracks'''
*[[List of tracks]]
*[[Track files and formats]]
*[[Creating tracks]]
*[[Track modeling tutorial]]
*[[Importing Racer tracks]]
|}

Main Page

2009-08-30T15:15:53Z

Venzon:

[[Image:Vdrift-logo.png]]

='''VDrift Documentation Wiki'''=

== Welcome ==
Welcome to the [http://vdrift.net/ VDrift] Documentation Wiki. This site contains some information regarding the VDrift project, but it is not yet complete.

Users are encouraged to make an account and edit articles, or leave comments. To get familiar with this wiki's format and style, read the [[Wiki usage notes]] page.

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''General Info'''
*[[About the project]], [[Community]]
*[[Authors and contributors]]
*[[License]]
*[[Contribution]]
*[[Reporting problems]]
*[[2008 Refactor Project]]
|width="250px"|'''Installation'''
*[[Hardware requirements]]
*[[Software requirements]]
*[[Installing on Linux]]
*[[Installing on FreeBSD]]
*[[Installing on Windows]]
*[[Installing on Mac OS X]]
|}

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''Configuration'''
*[[Configuring the display]]
*[[Configuring the sound]]
*[[Configuring the controls]]
*[[Logitech G25 support]]
*[[Setting up force feedback]]
|width="250px"|'''Playing'''
*[[Replays]]
*[[Drifting Techniques]]
*[[Drift scoring]]
|}

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''Files'''
*[[User settings directory]]
*[[VDrift.config]]
*[[Adding video modes|videomodes]]
*[[options.config]]
*[[Sound/graphics formats]]
*[[JOE format]], [[JOEPack format]]
*[[Configfile format]]
*[[Menu system|Menu file format]]
|width="250px"|'''Development'''
*[[Release Planning]]
*[[Class structure]]
*[[Coding Guidelines]]
*[[Numerical Integration]]
*[[Getting the development version]]
*[[Compiling]]
*[[Using SCons]]
*[[Debugging]]
*[[Packaging]]
*[[Useful links]]
|}

{| style="border: solid 1px black; background-color: #e0e0e0"
|- valign="top"
|width="250px"|'''Cars'''
*[[List of cars]]
*[[Downloading and installing new cars]]
*[[Car files and formats]]
*[[Car parameters]]
*[[Creating cars]]
*[[Car modeling tutorial]]
|width="250px"|'''Tracks'''
*[[List of tracks]]
*[[Track files and formats]]
*[[Creating tracks]]
*[[Track modeling tutorial]]
*[[Importing Racer tracks]]
|}

Car parameters for vdrift-2009-06-15 and older

2009-08-01T17:57:07Z

Venzon: /* Suspension */

The units are all in [http://scienceworld.wolfram.com/physics/MKS.html MKS] (meters, kilograms, seconds). It might also help to read [http://www.miata.net/sport/Physics/ ''The Physics of Racing''] by Brian Beckman.
For unit conversion you can go to: [http://www.sonar-equipment.com/useful_conversion_factors_table1_p00.htm ''This Site''].

The .car file contains several sections. Each section will now be described, along with example values from the XS.car file. The XS has performance comparable to the Honda S2000.

==Coordinate system==
A vector of 3 floats ( 1.0, 3.0, 1.5 ) will be interpreted as distances from the car body model origin. See [[Coordinate systems]] for a detailed description.

==Top level parameters==
<pre>
drive = RWD
</pre>
The "drive" parameter accepts values "RWD", "FWD", "AWD" that correspond to rear wheel drive, front wheel drive, and all wheel drive, respectively.

<pre>
version = 2
</pre>
The file format version. The only change between version 1 and version 2 is the move to coordinate system version 2, which is described in [[Coordinate systems]]. If no version is specified version 1 is assumed. VDrift is backward compatible with previous file formats. VDrift is not forward compatible with new file formats -- that is, VDrift will refuse to load a file specifying format version 3 if VDrift's code only supports version 2.

==Steering==
<pre>
max-angle = 33.19
</pre>
This defines the maximum angle that the wheels will turn in each direction. For the XS, when the steering wheel is full left, the wheels would be at -33.19 degrees.

==Engine==
<pre>
position = 0.86, 0.0, -0.21
mass = 140.0
max-power = 1.79e5
peak-engine-rpm = 7800.0
rpm-limit = 9000.0
inertia = 0.25
idle = 0.02
start-rpm = 1000
stall-rpm = 350
fuel-consumption = 1e-9
torque-friction = 0.0003
torque-curve-00 = 1000, 140.0
torque-curve-01 = 2000, 149.14
torque-curve-02 = 2200, 145.07
torque-curve-03 = 2500, 147.78
torque-curve-04 = 3000, 169.50
torque-curve-05 = 3300, 172.19
torque-curve-06 = 4000, 169.50
torque-curve-07 = 4500, 166.77
torque-curve-08 = 5600, 172.19
torque-curve-09 = 5800, 170.83
torque-curve-10 = 6000, 168.12
torque-curve-11 = 6100, 177.61
torque-curve-12 = 6200, 186.42
torque-curve-13 = 6300, 192.53
torque-curve-14 = 6500, 195.92
torque-curve-15 = 6700, 195.92
torque-curve-16 = 7000, 195.24
torque-curve-17 = 7600, 190.49
torque-curve-18 = 8000, 184.39
torque-curve-19 = 8200, 183.04
torque-curve-20 = 8300, 146.43
torque-curve-21 = 9500, 146.43
</pre>
The position and mass parameters affect the weight distribution of the car. The torque curve is calculated from max-power and peak-engine-rpm using a polynomial expression given in Motor Vehicle Dynamics, Genta (1997), where peak-engine-rpm is the engine speed at which the maximum power output (max-power) is achieved. Alternatively, the torque curve can be explicitly defined, as in the example above. A rev limit can be set with rpm-limit. The rotational inertia of the moving parts is inertia. idle is the throttle position at idle. Starting the engine initially sets the engine speed to start-rpm. Letting the engine speed drop below stall-rpm makes the engine stall. The rate of fuel consumption is set with fuel-consumption. The actual fuel consumed each second (in units of liters) is the fuel-consumption parameter times RPM times throttle (throttle is from 0.0 to 1.0, where 1.0 is full throttle).

==Clutch==
<pre>
sliding = 0.27
radius = 0.15
area = 0.75
max-pressure = 11079.26
</pre>
The torque on the clutch is found by multiplying the clutch pressure by the value in the area tag, the radius, and the sliding (friction) parameters.

==Transmission==
<pre>
gears = 6
gear-ratio-r = -2.8
gear-ratio-1 = 3.133
gear-ratio-2 = 2.045
gear-ratio-3 = 1.481
gear-ratio-4 = 1.161
gear-ratio-5 = 0.943
gear-ratio-6 = 0.763
shift-time = 0.2
</pre>
The number of forward gears is set with the gears parameter. The gear ration for reverse and all of the forward gears is then defined. The shift-time tag tells how long it takes, in total seconds, to change gears (when autoclutch is enabled). Half the time is spent changing the gear and the other half is spent letting the clutch out. This parameter is not required and defaults to 0.2 seconds, which is a reasonable value for a manual transmission. F1 cars take about 50 ms, by comparison.

==Differential==
<pre>
final-drive = 4.100
anti-slip = 600.0
anti-slip-torque = 1
anti-slip-torque-deceleration-factor = 0
</pre>
The final drive provides an additional gear reduction. The anti-slip parameter defines the maximum anti-slip torque. For speed-sensitive differentials, it also defines the anti-slip torque per radian per second of speed difference between the wheels. If the differential is speed-sensitive, the anti-slip-torque and anti-slip-torque-deceleration-factor parameters must be omitted or set to zero. If the differential is torque-sensitive, then anti-slip-torque defines the amount of anti-slip torque per input torque. The anti-slip-torque-deceleration-factor defines the amount of anti-slip torque per negative input torque. For a 1-way torque-sensitive LSD, set anti-slip-torque-deceleration-factor to zero, for a 2-way torque-sensitive LSD, set anti-slip-torque-deceleration-factor to 1.0, for 1.5-way, set it between 0.0 and 1.0.

==Fuel tank==
<pre>
position = -0.8, -0.1, -0.26
capacity = 0.0492
volume = 0.0492
fuel-density = 730.0
</pre>
The fuel tank's position, the current volume of fuel and the density of the fuel affect the car's weight distribution. The capacity tag sets the maximum volume of fuel that the tank can hold. The initial volume is set with the volume tag. The density of the fuel is set with fuel-density.

==Suspension==
Front/rear parameters are broken into two fields. Per-wheel parameters are broken into four fields. In the example below the front suspension is shown, followed by the front left wheel suspension parameters.
<pre>
[ suspension-front ]
spring-constant = 49131.9
spring-factor-1 = 0.052, 1.0
spring-factor-2 = 0.055, 1.2
bounce = 2588
rebound = 2612
damper-factor-1 = 0.08,1.0
damper-factor-2 = 0.1, 0.7
travel = 0.19
camber = -1.33
caster = 6.12
toe = 0.0
anti-roll = 8000.0
</pre>
<pre>
[ suspension-FL ]
hinge = 0,0,0
</pre>
The spring-constant is the '''wheel rate''' in N/m. The spring-factor-1 and 2 parameters define a curve for the spring response. These can be omitted if desired, in which case a factor of 1.0 will be used everywhere. Points are defined by specifying an x,y pair where x is the suspension displacement in meters and y is the factor to be applied to the spring coefficient. In this example, the spring factor will be 1.0 when the displacement is between 0 and 0.052 m, and then the spring factor will change linearly to 1.2 at 0.055 m (and beyond). The spring factor gets multiplied by the spring-constant. You can put as many spring-factor points as you want (just increase the spring-factor- number for each additional point). Note that displacement values are relative to the "zero g", "zero force" position. For best results, start VDrift with the -debug option and observe suspension displacements during maneuvering to determine where you want to put your points.

The bounce and rebound parameters are the damping coefficients for compression and expansion of the suspension, respectively, in units of N/m/s. The damper-factor-1 and 2 parameters define a curve for the damper response. These can be omitted if desired, in which case a factor of 1.0 will be used everywhere. Points are defined by specifying an x,y pair where x is an absolute value of suspension velocity in m/s and y is the factor to be applied to the damping coefficient. In this example, the damper factor will be 1.0 when the compression velocity absolute value is between 0 and 0.08 m/s, and then the damper factor will change linearly to 0.7 at 0.1 m/s (and beyond). The damper factor gets applied to the bonce or rebound damper coefficient, depending on the direction of travel. You can put as many damper-factor points as you want (just increase the damper-factor- number for each additional point).

The hinge is the center of the wheel's path as the suspension moves. The location of the hinge is determined by suspension geometry, and may be outside of the car itself.

Wheel alignment is set with the camber, caster, and toe tags. All angles are in degrees.

Note that the suspension position parameter and the max-compression-velocity parameters are no longer used and can be omitted.

==Tire==
Front/rear parameters are broken into two fields. In the example below the front tire section is shown.
<pre>
radius = 0.29
rolling-resistance = 1.3e-2, 6.5e-6
rotational-inertia = 10.0
tread = 0.0
# Lateral force
a0=1.6
a1=-38
a2=1201
a3=1914
a4=8.7
a5=0.014
a6=-0.24
a7=1.0
a8=-0.03
a9=-0.0013
a10=-0.15
a111=-8.5
a112=-0.29
a12=17.8
a13=-2.4
# Longitudinal force
b0=1.7
b1=-80
b2=1571
b3=23.3
b4=300
b5=0
b6=0.0068
b7=0.055
b8=-0.024
b9=0.014
b10=0.26
b11=-86
b12=350
# Aligning moment
c0=2.3
c1=-3.8
c2=-3.14
c3=-1.16
c4=-7.2
c5=0.0
c6=0.0
c7=0.044
c8=-0.58
c9=0.18
c10=0.043
c11=0.048
c12=-0.0035
c13=-0.18
c14=0.14
c15=-1.029
c16=0.27
c17=-1.1
</pre>
The two elements of rolling-resistance are the constant and velocity-squared terms, respectively. Radius defines the radius of the tire. The tread parameter ranges over arbitrary values of 0.0 to 1.0, where 0.0 is a road tire and 1.0 is an off-road tire. The longitudinal, transverse, and aligning section each contain a vector of “magic formula” coefficients as presented in Motor Vehicle Dynamics, Genta (1997). A description is shown below:
<pre>
Shape factor ........................................... A0
Load infl. on lat. friction coeff (*1000)... (1/kN) .... A1
Lateral friction coefficient at load = 0 (*1000) ....... A2
Maximum stiffness ........................ (N/deg) ..... A3
Load at maximum stiffness ................ (kN) ........ A4
Camber infiuence on stiffness ............ (%/deg/100) . A5
Curvature change with load ............................. A6
Curvature at load = 0 .................................. A7
Horizontal shift because of camber ........(deg/deg).... A8
Load influence on horizontal shift ........(deg/kN)..... A9
Horizontal shift at load = 0 ..............(deg)........ A10
Camber influence on vertical shift ........(N/deg/kN)... A111
Camber influence on vertical shift ........(N/deg/kN**2) A112
Load influence on vertical shift ..........(N/kN)....... A12
Vertical shift at load = 0 ................(N).......... A13

Shape factor ........................................... B0
Load infl. on long. friction coeff (*1000)... (1/kN) ... B1
Longitudinal friction coefficient at load = 0 (*1000)... B2
Curvature factor of stiffness ............ (N/%/kN**2) . B3
Change of stiffness with load at load = 0 (N/%/kN) ..... B4
Change of progressivity of stiffness/load (1/kN) ....... B5
Curvature change with load ............................. B6
Curvature change with load ............................. B7
Curvature at load = 0 .................................. B8
Load influence on horizontal shift ....... (%/kN) ...... B9
Horizontal shift at load = 0 ............. (%) ......... B10
Load influence on vertical shift ......... (N/kN) ...... B11
Vertical shift at load = 0 ............... (N) ......... B12

Shape factor ........................................... C0
Load influence of peak value ............ (Nm/kN**2) ... C1
Load influence of peak value ............ (Nm/kN) ...... C2
Curvature factor of stiffness ........... (Nm/deg/kN**2) C3
Change of stiffness with load at load = 0 (Nm/deg/kN) .. C4
Change of progressivity of stiffness/load (1/kN) ....... C5
Camber influence on stiffness ........... (%/deg/100) .. C6
Curvature change with load ............................. C7
Curvature change with load ............................. C8
Curvature at load = 0 .................................. C9
Camber influence of stiffness .......................... C10
Camber influence on horizontal shift......(deg/deg)..... C11
Load influence on horizontal shift........(deg/kN)...... C12
Horizontal shift at load = 0..............(deg)......... C13
Camber influence on vertical shift........(Nm/deg/kN**2) C14
Camber influence on vertical shift........(Nm/deg/kN)... C15
Load influence on vertical shift..........(Nm/kN)....... C16
Vertical shift at load = 0................(Nm).......... C17
</pre>
More information can be found at http://members.xoom.virgilio.it/adiaforo/epcjk.htm

==Brakes==
Front/rear parameters are broken into two fields. In the example below the front section is shown.
<pre>
friction = 0.73
max-pressure = 4.0e6
bias = 0.60
radius = 0.14
area = 0.015
</pre>
The bias parameter is the fraction of braking pressure applied to the front brakes (in the front brake section) or the rear brakes (in the rear brake section). To make sense, the rear value should equal 1.0 minus the front value. The maximum brake torque is calculated as friction * area * bias * max-pressure * radius. Some fraction of this value is applied based on the brake pedal.

==Driver==
<pre>
position = -0.62, -0.35, -0.12
mass = 90.0
view-position = -0.64, 0.35, 0.30
hood-mounted-view-position = 0.55, 0, 0.17
view-stiffness = 0.0
</pre>
The position and mass affect the weight distribution of the car. The view positions define 3D coordinates for camera placement. The view-stiffness parameter defines the stiffness of the camera bounce effect, where 0.0 is a sports car and 1.0 is F1-ish.

==Drag==
<pre>
position = 0.0, 0.0, 0.2
frontal-area = 2
drag-coefficient = 0.3
</pre>
The frontal area and coefficient of drag, set with frontal-area and drag-coefficient, are used to calculate the drag force.

==Wing==
Front/rear parameters are broken into two fields. In the example below the front section is shown.
<pre>
position = 1.9, 0.0, 0.60
frontal-area = 0.2
drag-coefficient = 0.0
surface-area = 0.3
lift-coefficient = -0.5
efficiency = 0.95
</pre>
Downforce can be added with wings. The amount of downforce is determined by the value in the lift-coefficient tag. If the lift coefficient is positive, upforce is generated. This is usually undesirable for cars. The efficiency determines how much drag is added as downforce increases. The surface-area is the surface area of the wing. This value is also used in the drag calculation.

==Wheel==
Per-wheel parameters are broken into four fields. In the example below the front left wheel is shown.
<pre>
position = 1.14, 0.76, -0.47
roll-height = 0.29
mass = 18.14
restitution = 0.1
</pre>

==Contact-points==
<pre>
mass = 0.05
position-00 = 1.96, 0.37, -0.24
position-01 = 1.96, -0.37, -0.24
position-02 = 1.52, 0.83, 0.16
position-03 = 1.52, -0.83, 0.16
position-04 = -0.10, 0.89, -0.24
position-05 = -0.10, -0.89, -0.24
position-06 = -2.18, -0.83, -0.10
position-07 = -2.18, 0.83, -0.10
</pre>
These values are used for weight distribution and balance only. They no longer perform any contact-related function. So, contact-points are the same as particles (defined below), but the syntax is slightly different.

==Particle==
These parameters are broken into a series of values starting at 00 and going to some number less than 100. The particle-00 is shown below.
<pre>
mass = 30.0
position = -1.28, 0.0, -0.36
</pre>
These values are used for weight distribution and balance.

Car parameters for vdrift-2009-06-15 and older

2009-08-01T17:55:14Z

Venzon: /* Suspension */

The units are all in [http://scienceworld.wolfram.com/physics/MKS.html MKS] (meters, kilograms, seconds). It might also help to read [http://www.miata.net/sport/Physics/ ''The Physics of Racing''] by Brian Beckman.
For unit conversion you can go to: [http://www.sonar-equipment.com/useful_conversion_factors_table1_p00.htm ''This Site''].

The .car file contains several sections. Each section will now be described, along with example values from the XS.car file. The XS has performance comparable to the Honda S2000.

==Coordinate system==
A vector of 3 floats ( 1.0, 3.0, 1.5 ) will be interpreted as distances from the car body model origin. See [[Coordinate systems]] for a detailed description.

==Top level parameters==
<pre>
drive = RWD
</pre>
The "drive" parameter accepts values "RWD", "FWD", "AWD" that correspond to rear wheel drive, front wheel drive, and all wheel drive, respectively.

<pre>
version = 2
</pre>
The file format version. The only change between version 1 and version 2 is the move to coordinate system version 2, which is described in [[Coordinate systems]]. If no version is specified version 1 is assumed. VDrift is backward compatible with previous file formats. VDrift is not forward compatible with new file formats -- that is, VDrift will refuse to load a file specifying format version 3 if VDrift's code only supports version 2.

==Steering==
<pre>
max-angle = 33.19
</pre>
This defines the maximum angle that the wheels will turn in each direction. For the XS, when the steering wheel is full left, the wheels would be at -33.19 degrees.

==Engine==
<pre>
position = 0.86, 0.0, -0.21
mass = 140.0
max-power = 1.79e5
peak-engine-rpm = 7800.0
rpm-limit = 9000.0
inertia = 0.25
idle = 0.02
start-rpm = 1000
stall-rpm = 350
fuel-consumption = 1e-9
torque-friction = 0.0003
torque-curve-00 = 1000, 140.0
torque-curve-01 = 2000, 149.14
torque-curve-02 = 2200, 145.07
torque-curve-03 = 2500, 147.78
torque-curve-04 = 3000, 169.50
torque-curve-05 = 3300, 172.19
torque-curve-06 = 4000, 169.50
torque-curve-07 = 4500, 166.77
torque-curve-08 = 5600, 172.19
torque-curve-09 = 5800, 170.83
torque-curve-10 = 6000, 168.12
torque-curve-11 = 6100, 177.61
torque-curve-12 = 6200, 186.42
torque-curve-13 = 6300, 192.53
torque-curve-14 = 6500, 195.92
torque-curve-15 = 6700, 195.92
torque-curve-16 = 7000, 195.24
torque-curve-17 = 7600, 190.49
torque-curve-18 = 8000, 184.39
torque-curve-19 = 8200, 183.04
torque-curve-20 = 8300, 146.43
torque-curve-21 = 9500, 146.43
</pre>
The position and mass parameters affect the weight distribution of the car. The torque curve is calculated from max-power and peak-engine-rpm using a polynomial expression given in Motor Vehicle Dynamics, Genta (1997), where peak-engine-rpm is the engine speed at which the maximum power output (max-power) is achieved. Alternatively, the torque curve can be explicitly defined, as in the example above. A rev limit can be set with rpm-limit. The rotational inertia of the moving parts is inertia. idle is the throttle position at idle. Starting the engine initially sets the engine speed to start-rpm. Letting the engine speed drop below stall-rpm makes the engine stall. The rate of fuel consumption is set with fuel-consumption. The actual fuel consumed each second (in units of liters) is the fuel-consumption parameter times RPM times throttle (throttle is from 0.0 to 1.0, where 1.0 is full throttle).

==Clutch==
<pre>
sliding = 0.27
radius = 0.15
area = 0.75
max-pressure = 11079.26
</pre>
The torque on the clutch is found by multiplying the clutch pressure by the value in the area tag, the radius, and the sliding (friction) parameters.

==Transmission==
<pre>
gears = 6
gear-ratio-r = -2.8
gear-ratio-1 = 3.133
gear-ratio-2 = 2.045
gear-ratio-3 = 1.481
gear-ratio-4 = 1.161
gear-ratio-5 = 0.943
gear-ratio-6 = 0.763
shift-time = 0.2
</pre>
The number of forward gears is set with the gears parameter. The gear ration for reverse and all of the forward gears is then defined. The shift-time tag tells how long it takes, in total seconds, to change gears (when autoclutch is enabled). Half the time is spent changing the gear and the other half is spent letting the clutch out. This parameter is not required and defaults to 0.2 seconds, which is a reasonable value for a manual transmission. F1 cars take about 50 ms, by comparison.

==Differential==
<pre>
final-drive = 4.100
anti-slip = 600.0
anti-slip-torque = 1
anti-slip-torque-deceleration-factor = 0
</pre>
The final drive provides an additional gear reduction. The anti-slip parameter defines the maximum anti-slip torque. For speed-sensitive differentials, it also defines the anti-slip torque per radian per second of speed difference between the wheels. If the differential is speed-sensitive, the anti-slip-torque and anti-slip-torque-deceleration-factor parameters must be omitted or set to zero. If the differential is torque-sensitive, then anti-slip-torque defines the amount of anti-slip torque per input torque. The anti-slip-torque-deceleration-factor defines the amount of anti-slip torque per negative input torque. For a 1-way torque-sensitive LSD, set anti-slip-torque-deceleration-factor to zero, for a 2-way torque-sensitive LSD, set anti-slip-torque-deceleration-factor to 1.0, for 1.5-way, set it between 0.0 and 1.0.

==Fuel tank==
<pre>
position = -0.8, -0.1, -0.26
capacity = 0.0492
volume = 0.0492
fuel-density = 730.0
</pre>
The fuel tank's position, the current volume of fuel and the density of the fuel affect the car's weight distribution. The capacity tag sets the maximum volume of fuel that the tank can hold. The initial volume is set with the volume tag. The density of the fuel is set with fuel-density.

==Suspension==
Front/rear parameters are broken into two fields. Per-wheel parameters are broken into four fields. In the example below the front suspension is shown, followed by the front left wheel suspension parameters.
<pre>
[ suspension-front ]
spring-constant = 49131.9
spring-factor-1 = 0.052, 1.0
spring-factor-2 = 0.055, 1.2
bounce = 2588
rebound = 2612
damper-factor-1 = 0.08,1.0
damper-factor-2 = 0.1, 0.7
travel = 0.19
camber = -1.33
caster = 6.12
toe = 0.0
anti-roll = 8000.0
</pre>
<pre>
[ suspension-FL ]
hinge = 0,0,0
</pre>
The spring-constant is the '''wheel rate''' in N/m. The spring-factor-1 and 2 parameters define a curve for the spring response. These can be omitted if desired, in which case a factor of 1.0 will be used everywhere. Points are defined by specifying an x,y pair where x is the suspension displacement in meters and y is the factor to be applied to the spring coefficient. In this example, the spring factor will be 1.0 when the displacement is between 0 and 0.052 m, and then the spring factor will change linearly to 1.2 at 0.055 m (and beyond). The spring factor gets multiplied by the spring-constant. You can put as many spring-factor points as you want (just increase the spring-factor- number for each additional point).

The bounce and rebound parameters are the damping coefficients for compression and expansion of the suspension, respectively, in units of N/m/s. The damper-factor-1 and 2 parameters define a curve for the damper response. These can be omitted if desired, in which case a factor of 1.0 will be used everywhere. Points are defined by specifying an x,y pair where x is an absolute value of suspension velocity in m/s and y is the factor to be applied to the damping coefficient. In this example, the damper factor will be 1.0 when the compression velocity absolute value is between 0 and 0.08 m/s, and then the damper factor will change linearly to 0.7 at 0.1 m/s (and beyond). The damper factor gets applied to the bonce or rebound damper coefficient, depending on the direction of travel. You can put as many damper-factor points as you want (just increase the damper-factor- number for each additional point).

The hinge is the center of the wheel's path as the suspension moves. The location of the hinge is determined by suspension geometry, and may be outside of the car itself.

Wheel alignment is set with the camber, caster, and toe tags. All angles are in degrees.

Note that the suspension position parameter and the max-compression-velocity parameters are no longer used and can be omitted.

==Tire==
Front/rear parameters are broken into two fields. In the example below the front tire section is shown.
<pre>
radius = 0.29
rolling-resistance = 1.3e-2, 6.5e-6
rotational-inertia = 10.0
tread = 0.0
# Lateral force
a0=1.6
a1=-38
a2=1201
a3=1914
a4=8.7
a5=0.014
a6=-0.24
a7=1.0
a8=-0.03
a9=-0.0013
a10=-0.15
a111=-8.5
a112=-0.29
a12=17.8
a13=-2.4
# Longitudinal force
b0=1.7
b1=-80
b2=1571
b3=23.3
b4=300
b5=0
b6=0.0068
b7=0.055
b8=-0.024
b9=0.014
b10=0.26
b11=-86
b12=350
# Aligning moment
c0=2.3
c1=-3.8
c2=-3.14
c3=-1.16
c4=-7.2
c5=0.0
c6=0.0
c7=0.044
c8=-0.58
c9=0.18
c10=0.043
c11=0.048
c12=-0.0035
c13=-0.18
c14=0.14
c15=-1.029
c16=0.27
c17=-1.1
</pre>
The two elements of rolling-resistance are the constant and velocity-squared terms, respectively. Radius defines the radius of the tire. The tread parameter ranges over arbitrary values of 0.0 to 1.0, where 0.0 is a road tire and 1.0 is an off-road tire. The longitudinal, transverse, and aligning section each contain a vector of “magic formula” coefficients as presented in Motor Vehicle Dynamics, Genta (1997). A description is shown below:
<pre>
Shape factor ........................................... A0
Load infl. on lat. friction coeff (*1000)... (1/kN) .... A1
Lateral friction coefficient at load = 0 (*1000) ....... A2
Maximum stiffness ........................ (N/deg) ..... A3
Load at maximum stiffness ................ (kN) ........ A4
Camber infiuence on stiffness ............ (%/deg/100) . A5
Curvature change with load ............................. A6
Curvature at load = 0 .................................. A7
Horizontal shift because of camber ........(deg/deg).... A8
Load influence on horizontal shift ........(deg/kN)..... A9
Horizontal shift at load = 0 ..............(deg)........ A10
Camber influence on vertical shift ........(N/deg/kN)... A111
Camber influence on vertical shift ........(N/deg/kN**2) A112
Load influence on vertical shift ..........(N/kN)....... A12
Vertical shift at load = 0 ................(N).......... A13

Shape factor ........................................... B0
Load infl. on long. friction coeff (*1000)... (1/kN) ... B1
Longitudinal friction coefficient at load = 0 (*1000)... B2
Curvature factor of stiffness ............ (N/%/kN**2) . B3
Change of stiffness with load at load = 0 (N/%/kN) ..... B4
Change of progressivity of stiffness/load (1/kN) ....... B5
Curvature change with load ............................. B6
Curvature change with load ............................. B7
Curvature at load = 0 .................................. B8
Load influence on horizontal shift ....... (%/kN) ...... B9
Horizontal shift at load = 0 ............. (%) ......... B10
Load influence on vertical shift ......... (N/kN) ...... B11
Vertical shift at load = 0 ............... (N) ......... B12

Shape factor ........................................... C0
Load influence of peak value ............ (Nm/kN**2) ... C1
Load influence of peak value ............ (Nm/kN) ...... C2
Curvature factor of stiffness ........... (Nm/deg/kN**2) C3
Change of stiffness with load at load = 0 (Nm/deg/kN) .. C4
Change of progressivity of stiffness/load (1/kN) ....... C5
Camber influence on stiffness ........... (%/deg/100) .. C6
Curvature change with load ............................. C7
Curvature change with load ............................. C8
Curvature at load = 0 .................................. C9
Camber influence of stiffness .......................... C10
Camber influence on horizontal shift......(deg/deg)..... C11
Load influence on horizontal shift........(deg/kN)...... C12
Horizontal shift at load = 0..............(deg)......... C13
Camber influence on vertical shift........(Nm/deg/kN**2) C14
Camber influence on vertical shift........(Nm/deg/kN)... C15
Load influence on vertical shift..........(Nm/kN)....... C16
Vertical shift at load = 0................(Nm).......... C17
</pre>
More information can be found at http://members.xoom.virgilio.it/adiaforo/epcjk.htm

==Brakes==
Front/rear parameters are broken into two fields. In the example below the front section is shown.
<pre>
friction = 0.73
max-pressure = 4.0e6
bias = 0.60
radius = 0.14
area = 0.015
</pre>
The bias parameter is the fraction of braking pressure applied to the front brakes (in the front brake section) or the rear brakes (in the rear brake section). To make sense, the rear value should equal 1.0 minus the front value. The maximum brake torque is calculated as friction * area * bias * max-pressure * radius. Some fraction of this value is applied based on the brake pedal.

==Driver==
<pre>
position = -0.62, -0.35, -0.12
mass = 90.0
view-position = -0.64, 0.35, 0.30
hood-mounted-view-position = 0.55, 0, 0.17
view-stiffness = 0.0
</pre>
The position and mass affect the weight distribution of the car. The view positions define 3D coordinates for camera placement. The view-stiffness parameter defines the stiffness of the camera bounce effect, where 0.0 is a sports car and 1.0 is F1-ish.

==Drag==
<pre>
position = 0.0, 0.0, 0.2
frontal-area = 2
drag-coefficient = 0.3
</pre>
The frontal area and coefficient of drag, set with frontal-area and drag-coefficient, are used to calculate the drag force.

==Wing==
Front/rear parameters are broken into two fields. In the example below the front section is shown.
<pre>
position = 1.9, 0.0, 0.60
frontal-area = 0.2
drag-coefficient = 0.0
surface-area = 0.3
lift-coefficient = -0.5
efficiency = 0.95
</pre>
Downforce can be added with wings. The amount of downforce is determined by the value in the lift-coefficient tag. If the lift coefficient is positive, upforce is generated. This is usually undesirable for cars. The efficiency determines how much drag is added as downforce increases. The surface-area is the surface area of the wing. This value is also used in the drag calculation.

==Wheel==
Per-wheel parameters are broken into four fields. In the example below the front left wheel is shown.
<pre>
position = 1.14, 0.76, -0.47
roll-height = 0.29
mass = 18.14
restitution = 0.1
</pre>

==Contact-points==
<pre>
mass = 0.05
position-00 = 1.96, 0.37, -0.24
position-01 = 1.96, -0.37, -0.24
position-02 = 1.52, 0.83, 0.16
position-03 = 1.52, -0.83, 0.16
position-04 = -0.10, 0.89, -0.24
position-05 = -0.10, -0.89, -0.24
position-06 = -2.18, -0.83, -0.10
position-07 = -2.18, 0.83, -0.10
</pre>
These values are used for weight distribution and balance only. They no longer perform any contact-related function. So, contact-points are the same as particles (defined below), but the syntax is slightly different.

==Particle==
These parameters are broken into a series of values starting at 00 and going to some number less than 100. The particle-00 is shown below.
<pre>
mass = 30.0
position = -1.28, 0.0, -0.36
</pre>
These values are used for weight distribution and balance.

Car parameters for vdrift-2009-06-15 and older

2009-08-01T17:28:32Z

Venzon: /* Suspension */

The units are all in [http://scienceworld.wolfram.com/physics/MKS.html MKS] (meters, kilograms, seconds). It might also help to read [http://www.miata.net/sport/Physics/ ''The Physics of Racing''] by Brian Beckman.
For unit conversion you can go to: [http://www.sonar-equipment.com/useful_conversion_factors_table1_p00.htm ''This Site''].

The .car file contains several sections. Each section will now be described, along with example values from the XS.car file. The XS has performance comparable to the Honda S2000.

==Coordinate system==
A vector of 3 floats ( 1.0, 3.0, 1.5 ) will be interpreted as distances from the car body model origin. See [[Coordinate systems]] for a detailed description.

==Top level parameters==
<pre>
drive = RWD
</pre>
The "drive" parameter accepts values "RWD", "FWD", "AWD" that correspond to rear wheel drive, front wheel drive, and all wheel drive, respectively.

<pre>
version = 2
</pre>
The file format version. The only change between version 1 and version 2 is the move to coordinate system version 2, which is described in [[Coordinate systems]]. If no version is specified version 1 is assumed. VDrift is backward compatible with previous file formats. VDrift is not forward compatible with new file formats -- that is, VDrift will refuse to load a file specifying format version 3 if VDrift's code only supports version 2.

==Steering==
<pre>
max-angle = 33.19
</pre>
This defines the maximum angle that the wheels will turn in each direction. For the XS, when the steering wheel is full left, the wheels would be at -33.19 degrees.

==Engine==
<pre>
position = 0.86, 0.0, -0.21
mass = 140.0
max-power = 1.79e5
peak-engine-rpm = 7800.0
rpm-limit = 9000.0
inertia = 0.25
idle = 0.02
start-rpm = 1000
stall-rpm = 350
fuel-consumption = 1e-9
torque-friction = 0.0003
torque-curve-00 = 1000, 140.0
torque-curve-01 = 2000, 149.14
torque-curve-02 = 2200, 145.07
torque-curve-03 = 2500, 147.78
torque-curve-04 = 3000, 169.50
torque-curve-05 = 3300, 172.19
torque-curve-06 = 4000, 169.50
torque-curve-07 = 4500, 166.77
torque-curve-08 = 5600, 172.19
torque-curve-09 = 5800, 170.83
torque-curve-10 = 6000, 168.12
torque-curve-11 = 6100, 177.61
torque-curve-12 = 6200, 186.42
torque-curve-13 = 6300, 192.53
torque-curve-14 = 6500, 195.92
torque-curve-15 = 6700, 195.92
torque-curve-16 = 7000, 195.24
torque-curve-17 = 7600, 190.49
torque-curve-18 = 8000, 184.39
torque-curve-19 = 8200, 183.04
torque-curve-20 = 8300, 146.43
torque-curve-21 = 9500, 146.43
</pre>
The position and mass parameters affect the weight distribution of the car. The torque curve is calculated from max-power and peak-engine-rpm using a polynomial expression given in Motor Vehicle Dynamics, Genta (1997), where peak-engine-rpm is the engine speed at which the maximum power output (max-power) is achieved. Alternatively, the torque curve can be explicitly defined, as in the example above. A rev limit can be set with rpm-limit. The rotational inertia of the moving parts is inertia. idle is the throttle position at idle. Starting the engine initially sets the engine speed to start-rpm. Letting the engine speed drop below stall-rpm makes the engine stall. The rate of fuel consumption is set with fuel-consumption. The actual fuel consumed each second (in units of liters) is the fuel-consumption parameter times RPM times throttle (throttle is from 0.0 to 1.0, where 1.0 is full throttle).

==Clutch==
<pre>
sliding = 0.27
radius = 0.15
area = 0.75
max-pressure = 11079.26
</pre>
The torque on the clutch is found by multiplying the clutch pressure by the value in the area tag, the radius, and the sliding (friction) parameters.

==Transmission==
<pre>
gears = 6
gear-ratio-r = -2.8
gear-ratio-1 = 3.133
gear-ratio-2 = 2.045
gear-ratio-3 = 1.481
gear-ratio-4 = 1.161
gear-ratio-5 = 0.943
gear-ratio-6 = 0.763
shift-time = 0.2
</pre>
The number of forward gears is set with the gears parameter. The gear ration for reverse and all of the forward gears is then defined. The shift-time tag tells how long it takes, in total seconds, to change gears (when autoclutch is enabled). Half the time is spent changing the gear and the other half is spent letting the clutch out. This parameter is not required and defaults to 0.2 seconds, which is a reasonable value for a manual transmission. F1 cars take about 50 ms, by comparison.

==Differential==
<pre>
final-drive = 4.100
anti-slip = 600.0
anti-slip-torque = 1
anti-slip-torque-deceleration-factor = 0
</pre>
The final drive provides an additional gear reduction. The anti-slip parameter defines the maximum anti-slip torque. For speed-sensitive differentials, it also defines the anti-slip torque per radian per second of speed difference between the wheels. If the differential is speed-sensitive, the anti-slip-torque and anti-slip-torque-deceleration-factor parameters must be omitted or set to zero. If the differential is torque-sensitive, then anti-slip-torque defines the amount of anti-slip torque per input torque. The anti-slip-torque-deceleration-factor defines the amount of anti-slip torque per negative input torque. For a 1-way torque-sensitive LSD, set anti-slip-torque-deceleration-factor to zero, for a 2-way torque-sensitive LSD, set anti-slip-torque-deceleration-factor to 1.0, for 1.5-way, set it between 0.0 and 1.0.

==Fuel tank==
<pre>
position = -0.8, -0.1, -0.26
capacity = 0.0492
volume = 0.0492
fuel-density = 730.0
</pre>
The fuel tank's position, the current volume of fuel and the density of the fuel affect the car's weight distribution. The capacity tag sets the maximum volume of fuel that the tank can hold. The initial volume is set with the volume tag. The density of the fuel is set with fuel-density.

==Suspension==
Front/rear parameters are broken into two fields. Per-wheel parameters are broken into four fields. In the example below the front suspension is shown, followed by the front left wheel suspension parameters.
<pre>
[ suspension-front ]
spring-constant = 49131.9
bounce = 2588
rebound = 2612
damper-factor-1 = 0.08,1.0
damper-factor-2 = 0.1, 0.7
travel = 0.19
camber = -1.33
caster = 6.12
toe = 0.0
anti-roll = 8000.0
</pre>
<pre>
[ suspension-FL ]
hinge = 0,0,0
</pre>
The spring-constant is the '''wheel rate''' in N/m. The hinge is the center of the wheel's path as the suspension moves. The location of the hinge is determined by suspension geometry, and may be outside of the car itself. Note that the suspension position parameter and the max-compression-velocity parameters are no longer used and can be omitted.

The bounce and rebound parameters are the damping coefficients for compression and expansion of the suspension, respectively, in units of N/m/s. The damper-factor-1 and 2 parameters define a curve for the damper response. Points are defined by specifying an x,y pair where x is an absolute value of suspension velocity in m/s and y is the factor to be applied to the damping coefficient. In this example, the damper factor will be 1.0 when the compression velocity absolute value is between 0 and 0.08 m/s, and then the damper factor will change linearly to 0.7 at 0.1 m/s (and beyond). The damper factor gets applied to the bonce or rebound damper coefficient, depending on the direction of travel. You can put as many damper-factor points as you want (just increase the damper-factor- number for each additional point).

Wheel alignment is set with the camber, caster, and toe tags. All angles are in degrees.

==Tire==
Front/rear parameters are broken into two fields. In the example below the front tire section is shown.
<pre>
radius = 0.29
rolling-resistance = 1.3e-2, 6.5e-6
rotational-inertia = 10.0
tread = 0.0
# Lateral force
a0=1.6
a1=-38
a2=1201
a3=1914
a4=8.7
a5=0.014
a6=-0.24
a7=1.0
a8=-0.03
a9=-0.0013
a10=-0.15
a111=-8.5
a112=-0.29
a12=17.8
a13=-2.4
# Longitudinal force
b0=1.7
b1=-80
b2=1571
b3=23.3
b4=300
b5=0
b6=0.0068
b7=0.055
b8=-0.024
b9=0.014
b10=0.26
b11=-86
b12=350
# Aligning moment
c0=2.3
c1=-3.8
c2=-3.14
c3=-1.16
c4=-7.2
c5=0.0
c6=0.0
c7=0.044
c8=-0.58
c9=0.18
c10=0.043
c11=0.048
c12=-0.0035
c13=-0.18
c14=0.14
c15=-1.029
c16=0.27
c17=-1.1
</pre>
The two elements of rolling-resistance are the constant and velocity-squared terms, respectively. Radius defines the radius of the tire. The tread parameter ranges over arbitrary values of 0.0 to 1.0, where 0.0 is a road tire and 1.0 is an off-road tire. The longitudinal, transverse, and aligning section each contain a vector of “magic formula” coefficients as presented in Motor Vehicle Dynamics, Genta (1997). A description is shown below:
<pre>
Shape factor ........................................... A0
Load infl. on lat. friction coeff (*1000)... (1/kN) .... A1
Lateral friction coefficient at load = 0 (*1000) ....... A2
Maximum stiffness ........................ (N/deg) ..... A3
Load at maximum stiffness ................ (kN) ........ A4
Camber infiuence on stiffness ............ (%/deg/100) . A5
Curvature change with load ............................. A6
Curvature at load = 0 .................................. A7
Horizontal shift because of camber ........(deg/deg).... A8
Load influence on horizontal shift ........(deg/kN)..... A9
Horizontal shift at load = 0 ..............(deg)........ A10
Camber influence on vertical shift ........(N/deg/kN)... A111
Camber influence on vertical shift ........(N/deg/kN**2) A112
Load influence on vertical shift ..........(N/kN)....... A12
Vertical shift at load = 0 ................(N).......... A13

Shape factor ........................................... B0
Load infl. on long. friction coeff (*1000)... (1/kN) ... B1
Longitudinal friction coefficient at load = 0 (*1000)... B2
Curvature factor of stiffness ............ (N/%/kN**2) . B3
Change of stiffness with load at load = 0 (N/%/kN) ..... B4
Change of progressivity of stiffness/load (1/kN) ....... B5
Curvature change with load ............................. B6
Curvature change with load ............................. B7
Curvature at load = 0 .................................. B8
Load influence on horizontal shift ....... (%/kN) ...... B9
Horizontal shift at load = 0 ............. (%) ......... B10
Load influence on vertical shift ......... (N/kN) ...... B11
Vertical shift at load = 0 ............... (N) ......... B12

Shape factor ........................................... C0
Load influence of peak value ............ (Nm/kN**2) ... C1
Load influence of peak value ............ (Nm/kN) ...... C2
Curvature factor of stiffness ........... (Nm/deg/kN**2) C3
Change of stiffness with load at load = 0 (Nm/deg/kN) .. C4
Change of progressivity of stiffness/load (1/kN) ....... C5
Camber influence on stiffness ........... (%/deg/100) .. C6
Curvature change with load ............................. C7
Curvature change with load ............................. C8
Curvature at load = 0 .................................. C9
Camber influence of stiffness .......................... C10
Camber influence on horizontal shift......(deg/deg)..... C11
Load influence on horizontal shift........(deg/kN)...... C12
Horizontal shift at load = 0..............(deg)......... C13
Camber influence on vertical shift........(Nm/deg/kN**2) C14
Camber influence on vertical shift........(Nm/deg/kN)... C15
Load influence on vertical shift..........(Nm/kN)....... C16
Vertical shift at load = 0................(Nm).......... C17
</pre>
More information can be found at http://members.xoom.virgilio.it/adiaforo/epcjk.htm

==Brakes==
Front/rear parameters are broken into two fields. In the example below the front section is shown.
<pre>
friction = 0.73
max-pressure = 4.0e6
bias = 0.60
radius = 0.14
area = 0.015
</pre>
The bias parameter is the fraction of braking pressure applied to the front brakes (in the front brake section) or the rear brakes (in the rear brake section). To make sense, the rear value should equal 1.0 minus the front value. The maximum brake torque is calculated as friction * area * bias * max-pressure * radius. Some fraction of this value is applied based on the brake pedal.

==Driver==
<pre>
position = -0.62, -0.35, -0.12
mass = 90.0
view-position = -0.64, 0.35, 0.30
hood-mounted-view-position = 0.55, 0, 0.17
view-stiffness = 0.0
</pre>
The position and mass affect the weight distribution of the car. The view positions define 3D coordinates for camera placement. The view-stiffness parameter defines the stiffness of the camera bounce effect, where 0.0 is a sports car and 1.0 is F1-ish.

==Drag==
<pre>
position = 0.0, 0.0, 0.2
frontal-area = 2
drag-coefficient = 0.3
</pre>
The frontal area and coefficient of drag, set with frontal-area and drag-coefficient, are used to calculate the drag force.

==Wing==
Front/rear parameters are broken into two fields. In the example below the front section is shown.
<pre>
position = 1.9, 0.0, 0.60
frontal-area = 0.2
drag-coefficient = 0.0
surface-area = 0.3
lift-coefficient = -0.5
efficiency = 0.95
</pre>
Downforce can be added with wings. The amount of downforce is determined by the value in the lift-coefficient tag. If the lift coefficient is positive, upforce is generated. This is usually undesirable for cars. The efficiency determines how much drag is added as downforce increases. The surface-area is the surface area of the wing. This value is also used in the drag calculation.

==Wheel==
Per-wheel parameters are broken into four fields. In the example below the front left wheel is shown.
<pre>
position = 1.14, 0.76, -0.47
roll-height = 0.29
mass = 18.14
restitution = 0.1
</pre>

==Contact-points==
<pre>
mass = 0.05
position-00 = 1.96, 0.37, -0.24
position-01 = 1.96, -0.37, -0.24
position-02 = 1.52, 0.83, 0.16
position-03 = 1.52, -0.83, 0.16
position-04 = -0.10, 0.89, -0.24
position-05 = -0.10, -0.89, -0.24
position-06 = -2.18, -0.83, -0.10
position-07 = -2.18, 0.83, -0.10
</pre>
These values are used for weight distribution and balance only. They no longer perform any contact-related function. So, contact-points are the same as particles (defined below), but the syntax is slightly different.

==Particle==
These parameters are broken into a series of values starting at 00 and going to some number less than 100. The particle-00 is shown below.
<pre>
mass = 30.0
position = -1.28, 0.0, -0.36
</pre>
These values are used for weight distribution and balance.

Car parameters for vdrift-2009-06-15 and older

2009-08-01T17:28:01Z

Venzon: /* Suspension */

The units are all in [http://scienceworld.wolfram.com/physics/MKS.html MKS] (meters, kilograms, seconds). It might also help to read [http://www.miata.net/sport/Physics/ ''The Physics of Racing''] by Brian Beckman.
For unit conversion you can go to: [http://www.sonar-equipment.com/useful_conversion_factors_table1_p00.htm ''This Site''].

The .car file contains several sections. Each section will now be described, along with example values from the XS.car file. The XS has performance comparable to the Honda S2000.

==Coordinate system==
A vector of 3 floats ( 1.0, 3.0, 1.5 ) will be interpreted as distances from the car body model origin. See [[Coordinate systems]] for a detailed description.

==Top level parameters==
<pre>
drive = RWD
</pre>
The "drive" parameter accepts values "RWD", "FWD", "AWD" that correspond to rear wheel drive, front wheel drive, and all wheel drive, respectively.

<pre>
version = 2
</pre>
The file format version. The only change between version 1 and version 2 is the move to coordinate system version 2, which is described in [[Coordinate systems]]. If no version is specified version 1 is assumed. VDrift is backward compatible with previous file formats. VDrift is not forward compatible with new file formats -- that is, VDrift will refuse to load a file specifying format version 3 if VDrift's code only supports version 2.

==Steering==
<pre>
max-angle = 33.19
</pre>
This defines the maximum angle that the wheels will turn in each direction. For the XS, when the steering wheel is full left, the wheels would be at -33.19 degrees.

==Engine==
<pre>
position = 0.86, 0.0, -0.21
mass = 140.0
max-power = 1.79e5
peak-engine-rpm = 7800.0
rpm-limit = 9000.0
inertia = 0.25
idle = 0.02
start-rpm = 1000
stall-rpm = 350
fuel-consumption = 1e-9
torque-friction = 0.0003
torque-curve-00 = 1000, 140.0
torque-curve-01 = 2000, 149.14
torque-curve-02 = 2200, 145.07
torque-curve-03 = 2500, 147.78
torque-curve-04 = 3000, 169.50
torque-curve-05 = 3300, 172.19
torque-curve-06 = 4000, 169.50
torque-curve-07 = 4500, 166.77
torque-curve-08 = 5600, 172.19
torque-curve-09 = 5800, 170.83
torque-curve-10 = 6000, 168.12
torque-curve-11 = 6100, 177.61
torque-curve-12 = 6200, 186.42
torque-curve-13 = 6300, 192.53
torque-curve-14 = 6500, 195.92
torque-curve-15 = 6700, 195.92
torque-curve-16 = 7000, 195.24
torque-curve-17 = 7600, 190.49
torque-curve-18 = 8000, 184.39
torque-curve-19 = 8200, 183.04
torque-curve-20 = 8300, 146.43
torque-curve-21 = 9500, 146.43
</pre>
The position and mass parameters affect the weight distribution of the car. The torque curve is calculated from max-power and peak-engine-rpm using a polynomial expression given in Motor Vehicle Dynamics, Genta (1997), where peak-engine-rpm is the engine speed at which the maximum power output (max-power) is achieved. Alternatively, the torque curve can be explicitly defined, as in the example above. A rev limit can be set with rpm-limit. The rotational inertia of the moving parts is inertia. idle is the throttle position at idle. Starting the engine initially sets the engine speed to start-rpm. Letting the engine speed drop below stall-rpm makes the engine stall. The rate of fuel consumption is set with fuel-consumption. The actual fuel consumed each second (in units of liters) is the fuel-consumption parameter times RPM times throttle (throttle is from 0.0 to 1.0, where 1.0 is full throttle).

==Clutch==
<pre>
sliding = 0.27
radius = 0.15
area = 0.75
max-pressure = 11079.26
</pre>
The torque on the clutch is found by multiplying the clutch pressure by the value in the area tag, the radius, and the sliding (friction) parameters.

==Transmission==
<pre>
gears = 6
gear-ratio-r = -2.8
gear-ratio-1 = 3.133
gear-ratio-2 = 2.045
gear-ratio-3 = 1.481
gear-ratio-4 = 1.161
gear-ratio-5 = 0.943
gear-ratio-6 = 0.763
shift-time = 0.2
</pre>
The number of forward gears is set with the gears parameter. The gear ration for reverse and all of the forward gears is then defined. The shift-time tag tells how long it takes, in total seconds, to change gears (when autoclutch is enabled). Half the time is spent changing the gear and the other half is spent letting the clutch out. This parameter is not required and defaults to 0.2 seconds, which is a reasonable value for a manual transmission. F1 cars take about 50 ms, by comparison.

==Differential==
<pre>
final-drive = 4.100
anti-slip = 600.0
anti-slip-torque = 1
anti-slip-torque-deceleration-factor = 0
</pre>
The final drive provides an additional gear reduction. The anti-slip parameter defines the maximum anti-slip torque. For speed-sensitive differentials, it also defines the anti-slip torque per radian per second of speed difference between the wheels. If the differential is speed-sensitive, the anti-slip-torque and anti-slip-torque-deceleration-factor parameters must be omitted or set to zero. If the differential is torque-sensitive, then anti-slip-torque defines the amount of anti-slip torque per input torque. The anti-slip-torque-deceleration-factor defines the amount of anti-slip torque per negative input torque. For a 1-way torque-sensitive LSD, set anti-slip-torque-deceleration-factor to zero, for a 2-way torque-sensitive LSD, set anti-slip-torque-deceleration-factor to 1.0, for 1.5-way, set it between 0.0 and 1.0.

==Fuel tank==
<pre>
position = -0.8, -0.1, -0.26
capacity = 0.0492
volume = 0.0492
fuel-density = 730.0
</pre>
The fuel tank's position, the current volume of fuel and the density of the fuel affect the car's weight distribution. The capacity tag sets the maximum volume of fuel that the tank can hold. The initial volume is set with the volume tag. The density of the fuel is set with fuel-density.

==Suspension==
Front/rear parameters are broken into two fields. Per-wheel parameters are broken into four fields. In the example below the front suspension is shown, followed by the front left wheel suspension parameters.
<pre>
[ suspension-front ]
spring-constant = 49131.9
bounce = 2588
rebound = 2612
damper-factor-1 = 0.08,1.0
damper-factor-2 = 0.1, 0.7
travel = 0.19
camber = -1.33
caster = 6.12
toe = 0.0
anti-roll = 8000.0
</pre>
<pre>
[ suspension-FL ]
hinge = 0,0,0
</pre>
The spring-constant is the [[wheel rate]] in N/m. The hinge is the center of the wheel's path as the suspension moves. The location of the hinge is determined by suspension geometry, and may be outside of the car itself. Note that the suspension position parameter and the max-compression-velocity parameters are no longer used and can be omitted.

The bounce and rebound parameters are the damping coefficients for compression and expansion of the suspension, respectively, in units of N/m/s. The damper-factor-1 and 2 parameters define a curve for the damper response. Points are defined by specifying an x,y pair where x is an absolute value of suspension velocity in m/s and y is the factor to be applied to the damping coefficient. In this example, the damper factor will be 1.0 when the compression velocity absolute value is between 0 and 0.08 m/s, and then the damper factor will change linearly to 0.7 at 0.1 m/s (and beyond). The damper factor gets applied to the bonce or rebound damper coefficient, depending on the direction of travel. You can put as many damper-factor points as you want (just increase the damper-factor- number for each additional point).

Wheel alignment is set with the camber, caster, and toe tags. All angles are in degrees.

==Tire==
Front/rear parameters are broken into two fields. In the example below the front tire section is shown.
<pre>
radius = 0.29
rolling-resistance = 1.3e-2, 6.5e-6
rotational-inertia = 10.0
tread = 0.0
# Lateral force
a0=1.6
a1=-38
a2=1201
a3=1914
a4=8.7
a5=0.014
a6=-0.24
a7=1.0
a8=-0.03
a9=-0.0013
a10=-0.15
a111=-8.5
a112=-0.29
a12=17.8
a13=-2.4
# Longitudinal force
b0=1.7
b1=-80
b2=1571
b3=23.3
b4=300
b5=0
b6=0.0068
b7=0.055
b8=-0.024
b9=0.014
b10=0.26
b11=-86
b12=350
# Aligning moment
c0=2.3
c1=-3.8
c2=-3.14
c3=-1.16
c4=-7.2
c5=0.0
c6=0.0
c7=0.044
c8=-0.58
c9=0.18
c10=0.043
c11=0.048
c12=-0.0035
c13=-0.18
c14=0.14
c15=-1.029
c16=0.27
c17=-1.1
</pre>
The two elements of rolling-resistance are the constant and velocity-squared terms, respectively. Radius defines the radius of the tire. The tread parameter ranges over arbitrary values of 0.0 to 1.0, where 0.0 is a road tire and 1.0 is an off-road tire. The longitudinal, transverse, and aligning section each contain a vector of “magic formula” coefficients as presented in Motor Vehicle Dynamics, Genta (1997). A description is shown below:
<pre>
Shape factor ........................................... A0
Load infl. on lat. friction coeff (*1000)... (1/kN) .... A1
Lateral friction coefficient at load = 0 (*1000) ....... A2
Maximum stiffness ........................ (N/deg) ..... A3
Load at maximum stiffness ................ (kN) ........ A4
Camber infiuence on stiffness ............ (%/deg/100) . A5
Curvature change with load ............................. A6
Curvature at load = 0 .................................. A7
Horizontal shift because of camber ........(deg/deg).... A8
Load influence on horizontal shift ........(deg/kN)..... A9
Horizontal shift at load = 0 ..............(deg)........ A10
Camber influence on vertical shift ........(N/deg/kN)... A111
Camber influence on vertical shift ........(N/deg/kN**2) A112
Load influence on vertical shift ..........(N/kN)....... A12
Vertical shift at load = 0 ................(N).......... A13

Shape factor ........................................... B0
Load infl. on long. friction coeff (*1000)... (1/kN) ... B1
Longitudinal friction coefficient at load = 0 (*1000)... B2
Curvature factor of stiffness ............ (N/%/kN**2) . B3
Change of stiffness with load at load = 0 (N/%/kN) ..... B4
Change of progressivity of stiffness/load (1/kN) ....... B5
Curvature change with load ............................. B6
Curvature change with load ............................. B7
Curvature at load = 0 .................................. B8
Load influence on horizontal shift ....... (%/kN) ...... B9
Horizontal shift at load = 0 ............. (%) ......... B10
Load influence on vertical shift ......... (N/kN) ...... B11
Vertical shift at load = 0 ............... (N) ......... B12

Shape factor ........................................... C0
Load influence of peak value ............ (Nm/kN**2) ... C1
Load influence of peak value ............ (Nm/kN) ...... C2
Curvature factor of stiffness ........... (Nm/deg/kN**2) C3
Change of stiffness with load at load = 0 (Nm/deg/kN) .. C4
Change of progressivity of stiffness/load (1/kN) ....... C5
Camber influence on stiffness ........... (%/deg/100) .. C6
Curvature change with load ............................. C7
Curvature change with load ............................. C8
Curvature at load = 0 .................................. C9
Camber influence of stiffness .......................... C10
Camber influence on horizontal shift......(deg/deg)..... C11
Load influence on horizontal shift........(deg/kN)...... C12
Horizontal shift at load = 0..............(deg)......... C13
Camber influence on vertical shift........(Nm/deg/kN**2) C14
Camber influence on vertical shift........(Nm/deg/kN)... C15
Load influence on vertical shift..........(Nm/kN)....... C16
Vertical shift at load = 0................(Nm).......... C17
</pre>
More information can be found at http://members.xoom.virgilio.it/adiaforo/epcjk.htm

==Brakes==
Front/rear parameters are broken into two fields. In the example below the front section is shown.
<pre>
friction = 0.73
max-pressure = 4.0e6
bias = 0.60
radius = 0.14
area = 0.015
</pre>
The bias parameter is the fraction of braking pressure applied to the front brakes (in the front brake section) or the rear brakes (in the rear brake section). To make sense, the rear value should equal 1.0 minus the front value. The maximum brake torque is calculated as friction * area * bias * max-pressure * radius. Some fraction of this value is applied based on the brake pedal.

==Driver==
<pre>
position = -0.62, -0.35, -0.12
mass = 90.0
view-position = -0.64, 0.35, 0.30
hood-mounted-view-position = 0.55, 0, 0.17
view-stiffness = 0.0
</pre>
The position and mass affect the weight distribution of the car. The view positions define 3D coordinates for camera placement. The view-stiffness parameter defines the stiffness of the camera bounce effect, where 0.0 is a sports car and 1.0 is F1-ish.

==Drag==
<pre>
position = 0.0, 0.0, 0.2
frontal-area = 2
drag-coefficient = 0.3
</pre>
The frontal area and coefficient of drag, set with frontal-area and drag-coefficient, are used to calculate the drag force.

==Wing==
Front/rear parameters are broken into two fields. In the example below the front section is shown.
<pre>
position = 1.9, 0.0, 0.60
frontal-area = 0.2
drag-coefficient = 0.0
surface-area = 0.3
lift-coefficient = -0.5
efficiency = 0.95
</pre>
Downforce can be added with wings. The amount of downforce is determined by the value in the lift-coefficient tag. If the lift coefficient is positive, upforce is generated. This is usually undesirable for cars. The efficiency determines how much drag is added as downforce increases. The surface-area is the surface area of the wing. This value is also used in the drag calculation.

==Wheel==
Per-wheel parameters are broken into four fields. In the example below the front left wheel is shown.
<pre>
position = 1.14, 0.76, -0.47
roll-height = 0.29
mass = 18.14
restitution = 0.1
</pre>

==Contact-points==
<pre>
mass = 0.05
position-00 = 1.96, 0.37, -0.24
position-01 = 1.96, -0.37, -0.24
position-02 = 1.52, 0.83, 0.16
position-03 = 1.52, -0.83, 0.16
position-04 = -0.10, 0.89, -0.24
position-05 = -0.10, -0.89, -0.24
position-06 = -2.18, -0.83, -0.10
position-07 = -2.18, 0.83, -0.10
</pre>
These values are used for weight distribution and balance only. They no longer perform any contact-related function. So, contact-points are the same as particles (defined below), but the syntax is slightly different.

==Particle==
These parameters are broken into a series of values starting at 00 and going to some number less than 100. The particle-00 is shown below.
<pre>
mass = 30.0
position = -1.28, 0.0, -0.36
</pre>
These values are used for weight distribution and balance.

Car parameters for vdrift-2009-06-15 and older

2009-08-01T16:43:09Z

Venzon: /* Suspension */

The units are all in [http://scienceworld.wolfram.com/physics/MKS.html MKS] (meters, kilograms, seconds). It might also help to read [http://www.miata.net/sport/Physics/ ''The Physics of Racing''] by Brian Beckman.
For unit conversion you can go to: [http://www.sonar-equipment.com/useful_conversion_factors_table1_p00.htm ''This Site''].

The .car file contains several sections. Each section will now be described, along with example values from the XS.car file. The XS has performance comparable to the Honda S2000.

==Coordinate system==
A vector of 3 floats ( 1.0, 3.0, 1.5 ) will be interpreted as distances from the car body model origin. See [[Coordinate systems]] for a detailed description.

==Top level parameters==
<pre>
drive = RWD
</pre>
The "drive" parameter accepts values "RWD", "FWD", "AWD" that correspond to rear wheel drive, front wheel drive, and all wheel drive, respectively.

<pre>
version = 2
</pre>
The file format version. The only change between version 1 and version 2 is the move to coordinate system version 2, which is described in [[Coordinate systems]]. If no version is specified version 1 is assumed. VDrift is backward compatible with previous file formats. VDrift is not forward compatible with new file formats -- that is, VDrift will refuse to load a file specifying format version 3 if VDrift's code only supports version 2.

==Steering==
<pre>
max-angle = 33.19
</pre>
This defines the maximum angle that the wheels will turn in each direction. For the XS, when the steering wheel is full left, the wheels would be at -33.19 degrees.

==Engine==
<pre>
position = 0.86, 0.0, -0.21
mass = 140.0
max-power = 1.79e5
peak-engine-rpm = 7800.0
rpm-limit = 9000.0
inertia = 0.25
idle = 0.02
start-rpm = 1000
stall-rpm = 350
fuel-consumption = 1e-9
torque-friction = 0.0003
torque-curve-00 = 1000, 140.0
torque-curve-01 = 2000, 149.14
torque-curve-02 = 2200, 145.07
torque-curve-03 = 2500, 147.78
torque-curve-04 = 3000, 169.50
torque-curve-05 = 3300, 172.19
torque-curve-06 = 4000, 169.50
torque-curve-07 = 4500, 166.77
torque-curve-08 = 5600, 172.19
torque-curve-09 = 5800, 170.83
torque-curve-10 = 6000, 168.12
torque-curve-11 = 6100, 177.61
torque-curve-12 = 6200, 186.42
torque-curve-13 = 6300, 192.53
torque-curve-14 = 6500, 195.92
torque-curve-15 = 6700, 195.92
torque-curve-16 = 7000, 195.24
torque-curve-17 = 7600, 190.49
torque-curve-18 = 8000, 184.39
torque-curve-19 = 8200, 183.04
torque-curve-20 = 8300, 146.43
torque-curve-21 = 9500, 146.43
</pre>
The position and mass parameters affect the weight distribution of the car. The torque curve is calculated from max-power and peak-engine-rpm using a polynomial expression given in Motor Vehicle Dynamics, Genta (1997), where peak-engine-rpm is the engine speed at which the maximum power output (max-power) is achieved. Alternatively, the torque curve can be explicitly defined, as in the example above. A rev limit can be set with rpm-limit. The rotational inertia of the moving parts is inertia. idle is the throttle position at idle. Starting the engine initially sets the engine speed to start-rpm. Letting the engine speed drop below stall-rpm makes the engine stall. The rate of fuel consumption is set with fuel-consumption. The actual fuel consumed each second (in units of liters) is the fuel-consumption parameter times RPM times throttle (throttle is from 0.0 to 1.0, where 1.0 is full throttle).

==Clutch==
<pre>
sliding = 0.27
radius = 0.15
area = 0.75
max-pressure = 11079.26
</pre>
The torque on the clutch is found by multiplying the clutch pressure by the value in the area tag, the radius, and the sliding (friction) parameters.

==Transmission==
<pre>
gears = 6
gear-ratio-r = -2.8
gear-ratio-1 = 3.133
gear-ratio-2 = 2.045
gear-ratio-3 = 1.481
gear-ratio-4 = 1.161
gear-ratio-5 = 0.943
gear-ratio-6 = 0.763
shift-time = 0.2
</pre>
The number of forward gears is set with the gears parameter. The gear ration for reverse and all of the forward gears is then defined. The shift-time tag tells how long it takes, in total seconds, to change gears (when autoclutch is enabled). Half the time is spent changing the gear and the other half is spent letting the clutch out. This parameter is not required and defaults to 0.2 seconds, which is a reasonable value for a manual transmission. F1 cars take about 50 ms, by comparison.

==Differential==
<pre>
final-drive = 4.100
anti-slip = 600.0
anti-slip-torque = 1
anti-slip-torque-deceleration-factor = 0
</pre>
The final drive provides an additional gear reduction. The anti-slip parameter defines the maximum anti-slip torque. For speed-sensitive differentials, it also defines the anti-slip torque per radian per second of speed difference between the wheels. If the differential is speed-sensitive, the anti-slip-torque and anti-slip-torque-deceleration-factor parameters must be omitted or set to zero. If the differential is torque-sensitive, then anti-slip-torque defines the amount of anti-slip torque per input torque. The anti-slip-torque-deceleration-factor defines the amount of anti-slip torque per negative input torque. For a 1-way torque-sensitive LSD, set anti-slip-torque-deceleration-factor to zero, for a 2-way torque-sensitive LSD, set anti-slip-torque-deceleration-factor to 1.0, for 1.5-way, set it between 0.0 and 1.0.

==Fuel tank==
<pre>
position = -0.8, -0.1, -0.26
capacity = 0.0492
volume = 0.0492
fuel-density = 730.0
</pre>
The fuel tank's position, the current volume of fuel and the density of the fuel affect the car's weight distribution. The capacity tag sets the maximum volume of fuel that the tank can hold. The initial volume is set with the volume tag. The density of the fuel is set with fuel-density.

==Suspension==
Front/rear parameters are broken into two fields. Per-wheel parameters are broken into four fields. In the example below the front suspension is shown, followed by the front left wheel suspension parameters.
<pre>
[ suspension-front ]
spring-constant = 49131.9
bounce = 2588
rebound = 2612
damper-factor-1 = 0.08,1.0
damper-factor-2 = 0.1, 0.7
travel = 0.19
camber = -1.33
caster = 6.12
toe = 0.0
anti-roll = 8000.0
</pre>
<pre>
[ suspension-FL ]
hinge = 0,0,0
</pre>
The spring-constant is the wheel rate in N/m. The hinge is the center of the wheel's path as the suspension moves. The location of the hinge is determined by suspension geometry, and may be outside of the car itself. Note that the suspension position parameter and the max-compression-velocity parameters are no longer used and can be omitted.

The bounce and rebound parameters are the damping coefficients for compression and expansion of the suspension, respectively, in units of N/m/s. The damper-factor-1 and 2 parameters define a curve for the damper response. Points are defined by specifying an x,y pair where x is an absolute value of suspension velocity in m/s and y is the factor to be applied to the damping coefficient. In this example, the damper factor will be 1.0 when the compression velocity absolute value is between 0 and 0.08 m/s, and then the damper factor will change linearly to 0.7 at 0.1 m/s (and beyond). The damper factor gets applied to the bonce or rebound damper coefficient, depending on the direction of travel. You can put as many damper-factor points as you want (just increase the damper-factor- number for each additional point).

Wheel alignment is set with the camber, caster, and toe tags. All angles are in degrees.

==Tire==
Front/rear parameters are broken into two fields. In the example below the front tire section is shown.
<pre>
radius = 0.29
rolling-resistance = 1.3e-2, 6.5e-6
rotational-inertia = 10.0
tread = 0.0
# Lateral force
a0=1.6
a1=-38
a2=1201
a3=1914
a4=8.7
a5=0.014
a6=-0.24
a7=1.0
a8=-0.03
a9=-0.0013
a10=-0.15
a111=-8.5
a112=-0.29
a12=17.8
a13=-2.4
# Longitudinal force
b0=1.7
b1=-80
b2=1571
b3=23.3
b4=300
b5=0
b6=0.0068
b7=0.055
b8=-0.024
b9=0.014
b10=0.26
b11=-86
b12=350
# Aligning moment
c0=2.3
c1=-3.8
c2=-3.14
c3=-1.16
c4=-7.2
c5=0.0
c6=0.0
c7=0.044
c8=-0.58
c9=0.18
c10=0.043
c11=0.048
c12=-0.0035
c13=-0.18
c14=0.14
c15=-1.029
c16=0.27
c17=-1.1
</pre>
The two elements of rolling-resistance are the constant and velocity-squared terms, respectively. Radius defines the radius of the tire. The tread parameter ranges over arbitrary values of 0.0 to 1.0, where 0.0 is a road tire and 1.0 is an off-road tire. The longitudinal, transverse, and aligning section each contain a vector of “magic formula” coefficients as presented in Motor Vehicle Dynamics, Genta (1997). A description is shown below:
<pre>
Shape factor ........................................... A0
Load infl. on lat. friction coeff (*1000)... (1/kN) .... A1
Lateral friction coefficient at load = 0 (*1000) ....... A2
Maximum stiffness ........................ (N/deg) ..... A3
Load at maximum stiffness ................ (kN) ........ A4
Camber infiuence on stiffness ............ (%/deg/100) . A5
Curvature change with load ............................. A6
Curvature at load = 0 .................................. A7
Horizontal shift because of camber ........(deg/deg).... A8
Load influence on horizontal shift ........(deg/kN)..... A9
Horizontal shift at load = 0 ..............(deg)........ A10
Camber influence on vertical shift ........(N/deg/kN)... A111
Camber influence on vertical shift ........(N/deg/kN**2) A112
Load influence on vertical shift ..........(N/kN)....... A12
Vertical shift at load = 0 ................(N).......... A13

Shape factor ........................................... B0
Load infl. on long. friction coeff (*1000)... (1/kN) ... B1
Longitudinal friction coefficient at load = 0 (*1000)... B2
Curvature factor of stiffness ............ (N/%/kN**2) . B3
Change of stiffness with load at load = 0 (N/%/kN) ..... B4
Change of progressivity of stiffness/load (1/kN) ....... B5
Curvature change with load ............................. B6
Curvature change with load ............................. B7
Curvature at load = 0 .................................. B8
Load influence on horizontal shift ....... (%/kN) ...... B9
Horizontal shift at load = 0 ............. (%) ......... B10
Load influence on vertical shift ......... (N/kN) ...... B11
Vertical shift at load = 0 ............... (N) ......... B12

Shape factor ........................................... C0
Load influence of peak value ............ (Nm/kN**2) ... C1
Load influence of peak value ............ (Nm/kN) ...... C2
Curvature factor of stiffness ........... (Nm/deg/kN**2) C3
Change of stiffness with load at load = 0 (Nm/deg/kN) .. C4
Change of progressivity of stiffness/load (1/kN) ....... C5
Camber influence on stiffness ........... (%/deg/100) .. C6
Curvature change with load ............................. C7
Curvature change with load ............................. C8
Curvature at load = 0 .................................. C9
Camber influence of stiffness .......................... C10
Camber influence on horizontal shift......(deg/deg)..... C11
Load influence on horizontal shift........(deg/kN)...... C12
Horizontal shift at load = 0..............(deg)......... C13
Camber influence on vertical shift........(Nm/deg/kN**2) C14
Camber influence on vertical shift........(Nm/deg/kN)... C15
Load influence on vertical shift..........(Nm/kN)....... C16
Vertical shift at load = 0................(Nm).......... C17
</pre>
More information can be found at http://members.xoom.virgilio.it/adiaforo/epcjk.htm

==Brakes==
Front/rear parameters are broken into two fields. In the example below the front section is shown.
<pre>
friction = 0.73
max-pressure = 4.0e6
bias = 0.60
radius = 0.14
area = 0.015
</pre>
The bias parameter is the fraction of braking pressure applied to the front brakes (in the front brake section) or the rear brakes (in the rear brake section). To make sense, the rear value should equal 1.0 minus the front value. The maximum brake torque is calculated as friction * area * bias * max-pressure * radius. Some fraction of this value is applied based on the brake pedal.

==Driver==
<pre>
position = -0.62, -0.35, -0.12
mass = 90.0
view-position = -0.64, 0.35, 0.30
hood-mounted-view-position = 0.55, 0, 0.17
view-stiffness = 0.0
</pre>
The position and mass affect the weight distribution of the car. The view positions define 3D coordinates for camera placement. The view-stiffness parameter defines the stiffness of the camera bounce effect, where 0.0 is a sports car and 1.0 is F1-ish.

==Drag==
<pre>
position = 0.0, 0.0, 0.2
frontal-area = 2
drag-coefficient = 0.3
</pre>
The frontal area and coefficient of drag, set with frontal-area and drag-coefficient, are used to calculate the drag force.

==Wing==
Front/rear parameters are broken into two fields. In the example below the front section is shown.
<pre>
position = 1.9, 0.0, 0.60
frontal-area = 0.2
drag-coefficient = 0.0
surface-area = 0.3
lift-coefficient = -0.5
efficiency = 0.95
</pre>
Downforce can be added with wings. The amount of downforce is determined by the value in the lift-coefficient tag. If the lift coefficient is positive, upforce is generated. This is usually undesirable for cars. The efficiency determines how much drag is added as downforce increases. The surface-area is the surface area of the wing. This value is also used in the drag calculation.

==Wheel==
Per-wheel parameters are broken into four fields. In the example below the front left wheel is shown.
<pre>
position = 1.14, 0.76, -0.47
roll-height = 0.29
mass = 18.14
restitution = 0.1
</pre>

==Contact-points==
<pre>
mass = 0.05
position-00 = 1.96, 0.37, -0.24
position-01 = 1.96, -0.37, -0.24
position-02 = 1.52, 0.83, 0.16
position-03 = 1.52, -0.83, 0.16
position-04 = -0.10, 0.89, -0.24
position-05 = -0.10, -0.89, -0.24
position-06 = -2.18, -0.83, -0.10
position-07 = -2.18, 0.83, -0.10
</pre>
These values are used for weight distribution and balance only. They no longer perform any contact-related function. So, contact-points are the same as particles (defined below), but the syntax is slightly different.

==Particle==
These parameters are broken into a series of values starting at 00 and going to some number less than 100. The particle-00 is shown below.
<pre>
mass = 30.0
position = -1.28, 0.0, -0.36
</pre>
These values are used for weight distribution and balance.

Car parameters for vdrift-2009-06-15 and older

2009-08-01T16:38:44Z

Venzon: /* Suspension */

The units are all in [http://scienceworld.wolfram.com/physics/MKS.html MKS] (meters, kilograms, seconds). It might also help to read [http://www.miata.net/sport/Physics/ ''The Physics of Racing''] by Brian Beckman.
For unit conversion you can go to: [http://www.sonar-equipment.com/useful_conversion_factors_table1_p00.htm ''This Site''].

The .car file contains several sections. Each section will now be described, along with example values from the XS.car file. The XS has performance comparable to the Honda S2000.

==Coordinate system==
A vector of 3 floats ( 1.0, 3.0, 1.5 ) will be interpreted as distances from the car body model origin. See [[Coordinate systems]] for a detailed description.

==Top level parameters==
<pre>
drive = RWD
</pre>
The "drive" parameter accepts values "RWD", "FWD", "AWD" that correspond to rear wheel drive, front wheel drive, and all wheel drive, respectively.

<pre>
version = 2
</pre>
The file format version. The only change between version 1 and version 2 is the move to coordinate system version 2, which is described in [[Coordinate systems]]. If no version is specified version 1 is assumed. VDrift is backward compatible with previous file formats. VDrift is not forward compatible with new file formats -- that is, VDrift will refuse to load a file specifying format version 3 if VDrift's code only supports version 2.

==Steering==
<pre>
max-angle = 33.19
</pre>
This defines the maximum angle that the wheels will turn in each direction. For the XS, when the steering wheel is full left, the wheels would be at -33.19 degrees.

==Engine==
<pre>
position = 0.86, 0.0, -0.21
mass = 140.0
max-power = 1.79e5
peak-engine-rpm = 7800.0
rpm-limit = 9000.0
inertia = 0.25
idle = 0.02
start-rpm = 1000
stall-rpm = 350
fuel-consumption = 1e-9
torque-friction = 0.0003
torque-curve-00 = 1000, 140.0
torque-curve-01 = 2000, 149.14
torque-curve-02 = 2200, 145.07
torque-curve-03 = 2500, 147.78
torque-curve-04 = 3000, 169.50
torque-curve-05 = 3300, 172.19
torque-curve-06 = 4000, 169.50
torque-curve-07 = 4500, 166.77
torque-curve-08 = 5600, 172.19
torque-curve-09 = 5800, 170.83
torque-curve-10 = 6000, 168.12
torque-curve-11 = 6100, 177.61
torque-curve-12 = 6200, 186.42
torque-curve-13 = 6300, 192.53
torque-curve-14 = 6500, 195.92
torque-curve-15 = 6700, 195.92
torque-curve-16 = 7000, 195.24
torque-curve-17 = 7600, 190.49
torque-curve-18 = 8000, 184.39
torque-curve-19 = 8200, 183.04
torque-curve-20 = 8300, 146.43
torque-curve-21 = 9500, 146.43
</pre>
The position and mass parameters affect the weight distribution of the car. The torque curve is calculated from max-power and peak-engine-rpm using a polynomial expression given in Motor Vehicle Dynamics, Genta (1997), where peak-engine-rpm is the engine speed at which the maximum power output (max-power) is achieved. Alternatively, the torque curve can be explicitly defined, as in the example above. A rev limit can be set with rpm-limit. The rotational inertia of the moving parts is inertia. idle is the throttle position at idle. Starting the engine initially sets the engine speed to start-rpm. Letting the engine speed drop below stall-rpm makes the engine stall. The rate of fuel consumption is set with fuel-consumption. The actual fuel consumed each second (in units of liters) is the fuel-consumption parameter times RPM times throttle (throttle is from 0.0 to 1.0, where 1.0 is full throttle).

==Clutch==
<pre>
sliding = 0.27
radius = 0.15
area = 0.75
max-pressure = 11079.26
</pre>
The torque on the clutch is found by multiplying the clutch pressure by the value in the area tag, the radius, and the sliding (friction) parameters.

==Transmission==
<pre>
gears = 6
gear-ratio-r = -2.8
gear-ratio-1 = 3.133
gear-ratio-2 = 2.045
gear-ratio-3 = 1.481
gear-ratio-4 = 1.161
gear-ratio-5 = 0.943
gear-ratio-6 = 0.763
shift-time = 0.2
</pre>
The number of forward gears is set with the gears parameter. The gear ration for reverse and all of the forward gears is then defined. The shift-time tag tells how long it takes, in total seconds, to change gears (when autoclutch is enabled). Half the time is spent changing the gear and the other half is spent letting the clutch out. This parameter is not required and defaults to 0.2 seconds, which is a reasonable value for a manual transmission. F1 cars take about 50 ms, by comparison.

==Differential==
<pre>
final-drive = 4.100
anti-slip = 600.0
anti-slip-torque = 1
anti-slip-torque-deceleration-factor = 0
</pre>
The final drive provides an additional gear reduction. The anti-slip parameter defines the maximum anti-slip torque. For speed-sensitive differentials, it also defines the anti-slip torque per radian per second of speed difference between the wheels. If the differential is speed-sensitive, the anti-slip-torque and anti-slip-torque-deceleration-factor parameters must be omitted or set to zero. If the differential is torque-sensitive, then anti-slip-torque defines the amount of anti-slip torque per input torque. The anti-slip-torque-deceleration-factor defines the amount of anti-slip torque per negative input torque. For a 1-way torque-sensitive LSD, set anti-slip-torque-deceleration-factor to zero, for a 2-way torque-sensitive LSD, set anti-slip-torque-deceleration-factor to 1.0, for 1.5-way, set it between 0.0 and 1.0.

==Fuel tank==
<pre>
position = -0.8, -0.1, -0.26
capacity = 0.0492
volume = 0.0492
fuel-density = 730.0
</pre>
The fuel tank's position, the current volume of fuel and the density of the fuel affect the car's weight distribution. The capacity tag sets the maximum volume of fuel that the tank can hold. The initial volume is set with the volume tag. The density of the fuel is set with fuel-density.

==Suspension==
Front/rear parameters are broken into two fields. Per-wheel parameters are broken into four fields. In the example below the front suspension is shown, followed by the front left wheel suspension parameters.
<pre>
[ suspension-front ]
spring-constant = 49131.9
bounce = 2588
rebound = 2612
damper-factor-1 = 0.08,1.0
damper-factor-2 = 0.1, 0.7
travel = 0.19
camber = -1.33
caster = 6.12
toe = 0.0
anti-roll = 8000.0
</pre>
<pre>
[ suspension-FL ]
hinge = 0,0,0
</pre>
The spring-constant is the wheel rate in N/m. The hinge is the center of the wheel's path as the suspension moves. The location of the hinge is determined by suspension geometry, and may be outside of the car itself. Note that the suspension position parameter and the max-compression-velocity parameters are no longer used and can be omitted.

The bounce and rebound parameters are the damping coefficients for compression and expansion of the suspension, respectively, in units of N/m/s. The damper-factor-1 and 2 parameters define a curve for the damper response. Points are defined by specifying an x,y pair where x is an absolute value of suspension velocity in m/s and y is the factor to be applied to the damping coefficient. In this example, the damper factor will be 1.0 when the compression velocity absolute value is between 0 and 0.08 m/s, and then the damper factor will change linearly to 0.7 at 0.1 m/s (and beyond).

Wheel alignment is set with the camber, caster, and toe tags. All angles are in degrees.

==Tire==
Front/rear parameters are broken into two fields. In the example below the front tire section is shown.
<pre>
radius = 0.29
rolling-resistance = 1.3e-2, 6.5e-6
rotational-inertia = 10.0
tread = 0.0
# Lateral force
a0=1.6
a1=-38
a2=1201
a3=1914
a4=8.7
a5=0.014
a6=-0.24
a7=1.0
a8=-0.03
a9=-0.0013
a10=-0.15
a111=-8.5
a112=-0.29
a12=17.8
a13=-2.4
# Longitudinal force
b0=1.7
b1=-80
b2=1571
b3=23.3
b4=300
b5=0
b6=0.0068
b7=0.055
b8=-0.024
b9=0.014
b10=0.26
b11=-86
b12=350
# Aligning moment
c0=2.3
c1=-3.8
c2=-3.14
c3=-1.16
c4=-7.2
c5=0.0
c6=0.0
c7=0.044
c8=-0.58
c9=0.18
c10=0.043
c11=0.048
c12=-0.0035
c13=-0.18
c14=0.14
c15=-1.029
c16=0.27
c17=-1.1
</pre>
The two elements of rolling-resistance are the constant and velocity-squared terms, respectively. Radius defines the radius of the tire. The tread parameter ranges over arbitrary values of 0.0 to 1.0, where 0.0 is a road tire and 1.0 is an off-road tire. The longitudinal, transverse, and aligning section each contain a vector of “magic formula” coefficients as presented in Motor Vehicle Dynamics, Genta (1997). A description is shown below:
<pre>
Shape factor ........................................... A0
Load infl. on lat. friction coeff (*1000)... (1/kN) .... A1
Lateral friction coefficient at load = 0 (*1000) ....... A2
Maximum stiffness ........................ (N/deg) ..... A3
Load at maximum stiffness ................ (kN) ........ A4
Camber infiuence on stiffness ............ (%/deg/100) . A5
Curvature change with load ............................. A6
Curvature at load = 0 .................................. A7
Horizontal shift because of camber ........(deg/deg).... A8
Load influence on horizontal shift ........(deg/kN)..... A9
Horizontal shift at load = 0 ..............(deg)........ A10
Camber influence on vertical shift ........(N/deg/kN)... A111
Camber influence on vertical shift ........(N/deg/kN**2) A112
Load influence on vertical shift ..........(N/kN)....... A12
Vertical shift at load = 0 ................(N).......... A13

Shape factor ........................................... B0
Load infl. on long. friction coeff (*1000)... (1/kN) ... B1
Longitudinal friction coefficient at load = 0 (*1000)... B2
Curvature factor of stiffness ............ (N/%/kN**2) . B3
Change of stiffness with load at load = 0 (N/%/kN) ..... B4
Change of progressivity of stiffness/load (1/kN) ....... B5
Curvature change with load ............................. B6
Curvature change with load ............................. B7
Curvature at load = 0 .................................. B8
Load influence on horizontal shift ....... (%/kN) ...... B9
Horizontal shift at load = 0 ............. (%) ......... B10
Load influence on vertical shift ......... (N/kN) ...... B11
Vertical shift at load = 0 ............... (N) ......... B12

Shape factor ........................................... C0
Load influence of peak value ............ (Nm/kN**2) ... C1
Load influence of peak value ............ (Nm/kN) ...... C2
Curvature factor of stiffness ........... (Nm/deg/kN**2) C3
Change of stiffness with load at load = 0 (Nm/deg/kN) .. C4
Change of progressivity of stiffness/load (1/kN) ....... C5
Camber influence on stiffness ........... (%/deg/100) .. C6
Curvature change with load ............................. C7
Curvature change with load ............................. C8
Curvature at load = 0 .................................. C9
Camber influence of stiffness .......................... C10
Camber influence on horizontal shift......(deg/deg)..... C11
Load influence on horizontal shift........(deg/kN)...... C12
Horizontal shift at load = 0..............(deg)......... C13
Camber influence on vertical shift........(Nm/deg/kN**2) C14
Camber influence on vertical shift........(Nm/deg/kN)... C15
Load influence on vertical shift..........(Nm/kN)....... C16
Vertical shift at load = 0................(Nm).......... C17
</pre>
More information can be found at http://members.xoom.virgilio.it/adiaforo/epcjk.htm

==Brakes==
Front/rear parameters are broken into two fields. In the example below the front section is shown.
<pre>
friction = 0.73
max-pressure = 4.0e6
bias = 0.60
radius = 0.14
area = 0.015
</pre>
The bias parameter is the fraction of braking pressure applied to the front brakes (in the front brake section) or the rear brakes (in the rear brake section). To make sense, the rear value should equal 1.0 minus the front value. The maximum brake torque is calculated as friction * area * bias * max-pressure * radius. Some fraction of this value is applied based on the brake pedal.

==Driver==
<pre>
position = -0.62, -0.35, -0.12
mass = 90.0
view-position = -0.64, 0.35, 0.30
hood-mounted-view-position = 0.55, 0, 0.17
view-stiffness = 0.0
</pre>
The position and mass affect the weight distribution of the car. The view positions define 3D coordinates for camera placement. The view-stiffness parameter defines the stiffness of the camera bounce effect, where 0.0 is a sports car and 1.0 is F1-ish.

==Drag==
<pre>
position = 0.0, 0.0, 0.2
frontal-area = 2
drag-coefficient = 0.3
</pre>
The frontal area and coefficient of drag, set with frontal-area and drag-coefficient, are used to calculate the drag force.

==Wing==
Front/rear parameters are broken into two fields. In the example below the front section is shown.
<pre>
position = 1.9, 0.0, 0.60
frontal-area = 0.2
drag-coefficient = 0.0
surface-area = 0.3
lift-coefficient = -0.5
efficiency = 0.95
</pre>
Downforce can be added with wings. The amount of downforce is determined by the value in the lift-coefficient tag. If the lift coefficient is positive, upforce is generated. This is usually undesirable for cars. The efficiency determines how much drag is added as downforce increases. The surface-area is the surface area of the wing. This value is also used in the drag calculation.

==Wheel==
Per-wheel parameters are broken into four fields. In the example below the front left wheel is shown.
<pre>
position = 1.14, 0.76, -0.47
roll-height = 0.29
mass = 18.14
restitution = 0.1
</pre>

==Contact-points==
<pre>
mass = 0.05
position-00 = 1.96, 0.37, -0.24
position-01 = 1.96, -0.37, -0.24
position-02 = 1.52, 0.83, 0.16
position-03 = 1.52, -0.83, 0.16
position-04 = -0.10, 0.89, -0.24
position-05 = -0.10, -0.89, -0.24
position-06 = -2.18, -0.83, -0.10
position-07 = -2.18, 0.83, -0.10
</pre>
These values are used for weight distribution and balance only. They no longer perform any contact-related function. So, contact-points are the same as particles (defined below), but the syntax is slightly different.

==Particle==
These parameters are broken into a series of values starting at 00 and going to some number less than 100. The particle-00 is shown below.
<pre>
mass = 30.0
position = -1.28, 0.0, -0.36
</pre>
These values are used for weight distribution and balance.

Car parameters for vdrift-2009-06-15 and older

2009-07-19T17:36:52Z

Venzon: /* Differential */

The units are all in [http://scienceworld.wolfram.com/physics/MKS.html MKS] (meters, kilograms, seconds). It might also help to read [http://www.miata.net/sport/Physics/ ''The Physics of Racing''] by Brian Beckman.
For unit conversion you can go to: [http://www.sonar-equipment.com/useful_conversion_factors_table1_p00.htm ''This Site''].

The .car file contains several sections. Each section will now be described, along with example values from the XS.car file. The XS has performance comparable to the Honda S2000.

==Coordinate system==
A vector of 3 floats ( 1.0, 3.0, 1.5 ) will be interpreted as distances from the car body model origin. See [[Coordinate systems]] for a detailed description.

==Top level parameters==
<pre>
drive = RWD
</pre>
The "drive" parameter accepts values "RWD", "FWD", "AWD" that correspond to rear wheel drive, front wheel drive, and all wheel drive, respectively.

<pre>
version = 2
</pre>
The file format version. The only change between version 1 and version 2 is the move to coordinate system version 2, which is described in [[Coordinate systems]]. If no version is specified version 1 is assumed. VDrift is backward compatible with previous file formats. VDrift is not forward compatible with new file formats -- that is, VDrift will refuse to load a file specifying format version 3 if VDrift's code only supports version 2.

==Steering==
<pre>
max-angle = 33.19
</pre>
This defines the maximum angle that the wheels will turn in each direction. For the XS, when the steering wheel is full left, the wheels would be at -33.19 degrees.

==Engine==
<pre>
position = 0.86, 0.0, -0.21
mass = 140.0
max-power = 1.79e5
peak-engine-rpm = 7800.0
rpm-limit = 9000.0
inertia = 0.25
idle = 0.02
start-rpm = 1000
stall-rpm = 350
fuel-consumption = 1e-9
torque-friction = 0.0003
torque-curve-00 = 1000, 140.0
torque-curve-01 = 2000, 149.14
torque-curve-02 = 2200, 145.07
torque-curve-03 = 2500, 147.78
torque-curve-04 = 3000, 169.50
torque-curve-05 = 3300, 172.19
torque-curve-06 = 4000, 169.50
torque-curve-07 = 4500, 166.77
torque-curve-08 = 5600, 172.19
torque-curve-09 = 5800, 170.83
torque-curve-10 = 6000, 168.12
torque-curve-11 = 6100, 177.61
torque-curve-12 = 6200, 186.42
torque-curve-13 = 6300, 192.53
torque-curve-14 = 6500, 195.92
torque-curve-15 = 6700, 195.92
torque-curve-16 = 7000, 195.24
torque-curve-17 = 7600, 190.49
torque-curve-18 = 8000, 184.39
torque-curve-19 = 8200, 183.04
torque-curve-20 = 8300, 146.43
torque-curve-21 = 9500, 146.43
</pre>
The position and mass parameters affect the weight distribution of the car. The torque curve is calculated from max-power and peak-engine-rpm using a polynomial expression given in Motor Vehicle Dynamics, Genta (1997), where peak-engine-rpm is the engine speed at which the maximum power output (max-power) is achieved. Alternatively, the torque curve can be explicitly defined, as in the example above. A rev limit can be set with rpm-limit. The rotational inertia of the moving parts is inertia. idle is the throttle position at idle. Starting the engine initially sets the engine speed to start-rpm. Letting the engine speed drop below stall-rpm makes the engine stall. The rate of fuel consumption is set with fuel-consumption. The actual fuel consumed each second (in units of liters) is the fuel-consumption parameter times RPM times throttle (throttle is from 0.0 to 1.0, where 1.0 is full throttle).

==Clutch==
<pre>
sliding = 0.27
radius = 0.15
area = 0.75
max-pressure = 11079.26
</pre>
The torque on the clutch is found by multiplying the clutch pressure by the value in the area tag, the radius, and the sliding (friction) parameters.

==Transmission==
<pre>
gears = 6
gear-ratio-r = -2.8
gear-ratio-1 = 3.133
gear-ratio-2 = 2.045
gear-ratio-3 = 1.481
gear-ratio-4 = 1.161
gear-ratio-5 = 0.943
gear-ratio-6 = 0.763
shift-time = 0.2
</pre>
The number of forward gears is set with the gears parameter. The gear ration for reverse and all of the forward gears is then defined. The shift-time tag tells how long it takes, in total seconds, to change gears (when autoclutch is enabled). Half the time is spent changing the gear and the other half is spent letting the clutch out. This parameter is not required and defaults to 0.2 seconds, which is a reasonable value for a manual transmission. F1 cars take about 50 ms, by comparison.

==Differential==
<pre>
final-drive = 4.100
anti-slip = 600.0
anti-slip-torque = 1
anti-slip-torque-deceleration-factor = 0
</pre>
The final drive provides an additional gear reduction. The anti-slip parameter defines the maximum anti-slip torque. For speed-sensitive differentials, it also defines the anti-slip torque per radian per second of speed difference between the wheels. If the differential is speed-sensitive, the anti-slip-torque and anti-slip-torque-deceleration-factor parameters must be omitted or set to zero. If the differential is torque-sensitive, then anti-slip-torque defines the amount of anti-slip torque per input torque. The anti-slip-torque-deceleration-factor defines the amount of anti-slip torque per negative input torque. For a 1-way torque-sensitive LSD, set anti-slip-torque-deceleration-factor to zero, for a 2-way torque-sensitive LSD, set anti-slip-torque-deceleration-factor to 1.0, for 1.5-way, set it between 0.0 and 1.0.

==Fuel tank==
<pre>
position = -0.8, -0.1, -0.26
capacity = 0.0492
volume = 0.0492
fuel-density = 730.0
</pre>
The fuel tank's position, the current volume of fuel and the density of the fuel affect the car's weight distribution. The capacity tag sets the maximum volume of fuel that the tank can hold. The initial volume is set with the volume tag. The density of the fuel is set with fuel-density.

==Suspension==
Front/rear parameters are broken into two fields. Per-wheel parameters are broken into four fields. In the example below the front suspension is shown, followed by the front left wheel suspension parameters.
<pre>
[ suspension-front ]
spring-constant = 49131.9
bounce = 2588
rebound = 2612
travel = 0.19
max-compression-velocity = 10.0
camber = -1.33
caster = 6.12
toe = 0.0
anti-roll = 8000.0
</pre>
<pre>
[ suspension-FL ]
hinge = 0,0,0
</pre>
The spring-constant is the wheel rate in N/m. The hinge is the center of the wheel's path as the suspension moves. The location of the hinge is determined by suspension geometry, and may be outside of the car itself. Note that the suspension position parameter is no longer used and can be omitted. bounce and rebound are the damping coefficients for compression and expansion of the suspension, respectively. If the speed at which the suspension is compressed, or expanded exceeds the value in max-compression-velocity, the dampers “lock up.” Wheel alignment is set with the camber, caster, and toe tags. All angles are in degrees.

==Tire==
Front/rear parameters are broken into two fields. In the example below the front tire section is shown.
<pre>
radius = 0.29
rolling-resistance = 1.3e-2, 6.5e-6
rotational-inertia = 10.0
tread = 0.0
# Lateral force
a0=1.6
a1=-38
a2=1201
a3=1914
a4=8.7
a5=0.014
a6=-0.24
a7=1.0
a8=-0.03
a9=-0.0013
a10=-0.15
a111=-8.5
a112=-0.29
a12=17.8
a13=-2.4
# Longitudinal force
b0=1.7
b1=-80
b2=1571
b3=23.3
b4=300
b5=0
b6=0.0068
b7=0.055
b8=-0.024
b9=0.014
b10=0.26
b11=-86
b12=350
# Aligning moment
c0=2.3
c1=-3.8
c2=-3.14
c3=-1.16
c4=-7.2
c5=0.0
c6=0.0
c7=0.044
c8=-0.58
c9=0.18
c10=0.043
c11=0.048
c12=-0.0035
c13=-0.18
c14=0.14
c15=-1.029
c16=0.27
c17=-1.1
</pre>
The two elements of rolling-resistance are the constant and velocity-squared terms, respectively. Radius defines the radius of the tire. The tread parameter ranges over arbitrary values of 0.0 to 1.0, where 0.0 is a road tire and 1.0 is an off-road tire. The longitudinal, transverse, and aligning section each contain a vector of “magic formula” coefficients as presented in Motor Vehicle Dynamics, Genta (1997). A description is shown below:
<pre>
Shape factor ........................................... A0
Load infl. on lat. friction coeff (*1000)... (1/kN) .... A1
Lateral friction coefficient at load = 0 (*1000) ....... A2
Maximum stiffness ........................ (N/deg) ..... A3
Load at maximum stiffness ................ (kN) ........ A4
Camber infiuence on stiffness ............ (%/deg/100) . A5
Curvature change with load ............................. A6
Curvature at load = 0 .................................. A7
Horizontal shift because of camber ........(deg/deg).... A8
Load influence on horizontal shift ........(deg/kN)..... A9
Horizontal shift at load = 0 ..............(deg)........ A10
Camber influence on vertical shift ........(N/deg/kN)... A111
Camber influence on vertical shift ........(N/deg/kN**2) A112
Load influence on vertical shift ..........(N/kN)....... A12
Vertical shift at load = 0 ................(N).......... A13

Shape factor ........................................... B0
Load infl. on long. friction coeff (*1000)... (1/kN) ... B1
Longitudinal friction coefficient at load = 0 (*1000)... B2
Curvature factor of stiffness ............ (N/%/kN**2) . B3
Change of stiffness with load at load = 0 (N/%/kN) ..... B4
Change of progressivity of stiffness/load (1/kN) ....... B5
Curvature change with load ............................. B6
Curvature change with load ............................. B7
Curvature at load = 0 .................................. B8
Load influence on horizontal shift ....... (%/kN) ...... B9
Horizontal shift at load = 0 ............. (%) ......... B10
Load influence on vertical shift ......... (N/kN) ...... B11
Vertical shift at load = 0 ............... (N) ......... B12

Shape factor ........................................... C0
Load influence of peak value ............ (Nm/kN**2) ... C1
Load influence of peak value ............ (Nm/kN) ...... C2
Curvature factor of stiffness ........... (Nm/deg/kN**2) C3
Change of stiffness with load at load = 0 (Nm/deg/kN) .. C4
Change of progressivity of stiffness/load (1/kN) ....... C5
Camber influence on stiffness ........... (%/deg/100) .. C6
Curvature change with load ............................. C7
Curvature change with load ............................. C8
Curvature at load = 0 .................................. C9
Camber influence of stiffness .......................... C10
Camber influence on horizontal shift......(deg/deg)..... C11
Load influence on horizontal shift........(deg/kN)...... C12
Horizontal shift at load = 0..............(deg)......... C13
Camber influence on vertical shift........(Nm/deg/kN**2) C14
Camber influence on vertical shift........(Nm/deg/kN)... C15
Load influence on vertical shift..........(Nm/kN)....... C16
Vertical shift at load = 0................(Nm).......... C17
</pre>
More information can be found at http://members.xoom.virgilio.it/adiaforo/epcjk.htm

==Brakes==
Front/rear parameters are broken into two fields. In the example below the front section is shown.
<pre>
friction = 0.73
max-pressure = 4.0e6
bias = 0.60
radius = 0.14
area = 0.015
</pre>
The bias parameter is the fraction of braking pressure applied to the front brakes (in the front brake section) or the rear brakes (in the rear brake section). To make sense, the rear value should equal 1.0 minus the front value. The maximum brake torque is calculated as friction * area * bias * max-pressure * radius. Some fraction of this value is applied based on the brake pedal.

==Driver==
<pre>
position = -0.62, -0.35, -0.12
mass = 90.0
view-position = -0.64, 0.35, 0.30
hood-mounted-view-position = 0.55, 0, 0.17
view-stiffness = 0.0
</pre>
The position and mass affect the weight distribution of the car. The view positions define 3D coordinates for camera placement. The view-stiffness parameter defines the stiffness of the camera bounce effect, where 0.0 is a sports car and 1.0 is F1-ish.

==Drag==
<pre>
position = 0.0, 0.0, 0.2
frontal-area = 2
drag-coefficient = 0.3
</pre>
The frontal area and coefficient of drag, set with frontal-area and drag-coefficient, are used to calculate the drag force.

==Wing==
Front/rear parameters are broken into two fields. In the example below the front section is shown.
<pre>
position = 1.9, 0.0, 0.60
frontal-area = 0.2
drag-coefficient = 0.0
surface-area = 0.3
lift-coefficient = -0.5
efficiency = 0.95
</pre>
Downforce can be added with wings. The amount of downforce is determined by the value in the lift-coefficient tag. If the lift coefficient is positive, upforce is generated. This is usually undesirable for cars. The efficiency determines how much drag is added as downforce increases. The surface-area is the surface area of the wing. This value is also used in the drag calculation.

==Wheel==
Per-wheel parameters are broken into four fields. In the example below the front left wheel is shown.
<pre>
position = 1.14, 0.76, -0.47
roll-height = 0.29
mass = 18.14
restitution = 0.1
</pre>

==Contact-points==
<pre>
mass = 0.05
position-00 = 1.96, 0.37, -0.24
position-01 = 1.96, -0.37, -0.24
position-02 = 1.52, 0.83, 0.16
position-03 = 1.52, -0.83, 0.16
position-04 = -0.10, 0.89, -0.24
position-05 = -0.10, -0.89, -0.24
position-06 = -2.18, -0.83, -0.10
position-07 = -2.18, 0.83, -0.10
</pre>
These values are used for weight distribution and balance only. They no longer perform any contact-related function. So, contact-points are the same as particles (defined below), but the syntax is slightly different.

==Particle==
These parameters are broken into a series of values starting at 00 and going to some number less than 100. The particle-00 is shown below.
<pre>
mass = 30.0
position = -1.28, 0.0, -0.36
</pre>
These values are used for weight distribution and balance.

Car parameters for vdrift-2009-06-15 and older

2009-07-19T17:14:52Z

Venzon: /* Clutch */

The units are all in [http://scienceworld.wolfram.com/physics/MKS.html MKS] (meters, kilograms, seconds). It might also help to read [http://www.miata.net/sport/Physics/ ''The Physics of Racing''] by Brian Beckman.
For unit conversion you can go to: [http://www.sonar-equipment.com/useful_conversion_factors_table1_p00.htm ''This Site''].

The .car file contains several sections. Each section will now be described, along with example values from the XS.car file. The XS has performance comparable to the Honda S2000.

==Coordinate system==
A vector of 3 floats ( 1.0, 3.0, 1.5 ) will be interpreted as distances from the car body model origin. See [[Coordinate systems]] for a detailed description.

==Top level parameters==
<pre>
drive = RWD
</pre>
The "drive" parameter accepts values "RWD", "FWD", "AWD" that correspond to rear wheel drive, front wheel drive, and all wheel drive, respectively.

<pre>
version = 2
</pre>
The file format version. The only change between version 1 and version 2 is the move to coordinate system version 2, which is described in [[Coordinate systems]]. If no version is specified version 1 is assumed. VDrift is backward compatible with previous file formats. VDrift is not forward compatible with new file formats -- that is, VDrift will refuse to load a file specifying format version 3 if VDrift's code only supports version 2.

==Steering==
<pre>
max-angle = 33.19
</pre>
This defines the maximum angle that the wheels will turn in each direction. For the XS, when the steering wheel is full left, the wheels would be at -33.19 degrees.

==Engine==
<pre>
position = 0.86, 0.0, -0.21
mass = 140.0
max-power = 1.79e5
peak-engine-rpm = 7800.0
rpm-limit = 9000.0
inertia = 0.25
idle = 0.02
start-rpm = 1000
stall-rpm = 350
fuel-consumption = 1e-9
torque-friction = 0.0003
torque-curve-00 = 1000, 140.0
torque-curve-01 = 2000, 149.14
torque-curve-02 = 2200, 145.07
torque-curve-03 = 2500, 147.78
torque-curve-04 = 3000, 169.50
torque-curve-05 = 3300, 172.19
torque-curve-06 = 4000, 169.50
torque-curve-07 = 4500, 166.77
torque-curve-08 = 5600, 172.19
torque-curve-09 = 5800, 170.83
torque-curve-10 = 6000, 168.12
torque-curve-11 = 6100, 177.61
torque-curve-12 = 6200, 186.42
torque-curve-13 = 6300, 192.53
torque-curve-14 = 6500, 195.92
torque-curve-15 = 6700, 195.92
torque-curve-16 = 7000, 195.24
torque-curve-17 = 7600, 190.49
torque-curve-18 = 8000, 184.39
torque-curve-19 = 8200, 183.04
torque-curve-20 = 8300, 146.43
torque-curve-21 = 9500, 146.43
</pre>
The position and mass parameters affect the weight distribution of the car. The torque curve is calculated from max-power and peak-engine-rpm using a polynomial expression given in Motor Vehicle Dynamics, Genta (1997), where peak-engine-rpm is the engine speed at which the maximum power output (max-power) is achieved. Alternatively, the torque curve can be explicitly defined, as in the example above. A rev limit can be set with rpm-limit. The rotational inertia of the moving parts is inertia. idle is the throttle position at idle. Starting the engine initially sets the engine speed to start-rpm. Letting the engine speed drop below stall-rpm makes the engine stall. The rate of fuel consumption is set with fuel-consumption. The actual fuel consumed each second (in units of liters) is the fuel-consumption parameter times RPM times throttle (throttle is from 0.0 to 1.0, where 1.0 is full throttle).

==Clutch==
<pre>
sliding = 0.27
radius = 0.15
area = 0.75
max-pressure = 11079.26
</pre>
The torque on the clutch is found by multiplying the clutch pressure by the value in the area tag, the radius, and the sliding (friction) parameters.

==Transmission==
<pre>
gears = 6
gear-ratio-r = -2.8
gear-ratio-1 = 3.133
gear-ratio-2 = 2.045
gear-ratio-3 = 1.481
gear-ratio-4 = 1.161
gear-ratio-5 = 0.943
gear-ratio-6 = 0.763
shift-time = 0.2
</pre>
The number of forward gears is set with the gears parameter. The gear ration for reverse and all of the forward gears is then defined. The shift-time tag tells how long it takes, in total seconds, to change gears (when autoclutch is enabled). Half the time is spent changing the gear and the other half is spent letting the clutch out. This parameter is not required and defaults to 0.2 seconds, which is a reasonable value for a manual transmission. F1 cars take about 50 ms, by comparison.

==Differential==
<pre>
final-drive = 4.100
anti-slip = 600.0
anti-slip-torque = 1
anti-slip-torque-deceleration-factor = 0
</pre>
The final drive provides an additional gear reduction. The anti-slip parameter defines the maximum anti-slip torque. For speed-sensitive differentials, it also defines the anti-slip torque per radian per second of speed difference between the wheels. If the differential is speed-sensitive, the anti-slip-torque and anti-slip-torque-deceleration-factor parameters can be omitted or set to zero. If the differential is torque-sensitive, then anti-slip-torque defines the amount of anti-slip torque per input torque. The anti-slip-torque-deceleration-factor defines the amount of anti-slip torque per negative input torque. For a 1-way torque-sensitive LSD, set anti-slip-torque-deceleration-factor to zero, for a 2-way torque-sensitive LSD, set anti-slip-torque-deceleration-factor to 1.0, for 1.5-way, set it between 0.0 and 1.0.

==Fuel tank==
<pre>
position = -0.8, -0.1, -0.26
capacity = 0.0492
volume = 0.0492
fuel-density = 730.0
</pre>
The fuel tank's position, the current volume of fuel and the density of the fuel affect the car's weight distribution. The capacity tag sets the maximum volume of fuel that the tank can hold. The initial volume is set with the volume tag. The density of the fuel is set with fuel-density.

==Suspension==
Front/rear parameters are broken into two fields. Per-wheel parameters are broken into four fields. In the example below the front suspension is shown, followed by the front left wheel suspension parameters.
<pre>
[ suspension-front ]
spring-constant = 49131.9
bounce = 2588
rebound = 2612
travel = 0.19
max-compression-velocity = 10.0
camber = -1.33
caster = 6.12
toe = 0.0
anti-roll = 8000.0
</pre>
<pre>
[ suspension-FL ]
hinge = 0,0,0
</pre>
The spring-constant is the wheel rate in N/m. The hinge is the center of the wheel's path as the suspension moves. The location of the hinge is determined by suspension geometry, and may be outside of the car itself. Note that the suspension position parameter is no longer used and can be omitted. bounce and rebound are the damping coefficients for compression and expansion of the suspension, respectively. If the speed at which the suspension is compressed, or expanded exceeds the value in max-compression-velocity, the dampers “lock up.” Wheel alignment is set with the camber, caster, and toe tags. All angles are in degrees.

==Tire==
Front/rear parameters are broken into two fields. In the example below the front tire section is shown.
<pre>
radius = 0.29
rolling-resistance = 1.3e-2, 6.5e-6
rotational-inertia = 10.0
tread = 0.0
# Lateral force
a0=1.6
a1=-38
a2=1201
a3=1914
a4=8.7
a5=0.014
a6=-0.24
a7=1.0
a8=-0.03
a9=-0.0013
a10=-0.15
a111=-8.5
a112=-0.29
a12=17.8
a13=-2.4
# Longitudinal force
b0=1.7
b1=-80
b2=1571
b3=23.3
b4=300
b5=0
b6=0.0068
b7=0.055
b8=-0.024
b9=0.014
b10=0.26
b11=-86
b12=350
# Aligning moment
c0=2.3
c1=-3.8
c2=-3.14
c3=-1.16
c4=-7.2
c5=0.0
c6=0.0
c7=0.044
c8=-0.58
c9=0.18
c10=0.043
c11=0.048
c12=-0.0035
c13=-0.18
c14=0.14
c15=-1.029
c16=0.27
c17=-1.1
</pre>
The two elements of rolling-resistance are the constant and velocity-squared terms, respectively. Radius defines the radius of the tire. The tread parameter ranges over arbitrary values of 0.0 to 1.0, where 0.0 is a road tire and 1.0 is an off-road tire. The longitudinal, transverse, and aligning section each contain a vector of “magic formula” coefficients as presented in Motor Vehicle Dynamics, Genta (1997). A description is shown below:
<pre>
Shape factor ........................................... A0
Load infl. on lat. friction coeff (*1000)... (1/kN) .... A1
Lateral friction coefficient at load = 0 (*1000) ....... A2
Maximum stiffness ........................ (N/deg) ..... A3
Load at maximum stiffness ................ (kN) ........ A4
Camber infiuence on stiffness ............ (%/deg/100) . A5
Curvature change with load ............................. A6
Curvature at load = 0 .................................. A7
Horizontal shift because of camber ........(deg/deg).... A8
Load influence on horizontal shift ........(deg/kN)..... A9
Horizontal shift at load = 0 ..............(deg)........ A10
Camber influence on vertical shift ........(N/deg/kN)... A111
Camber influence on vertical shift ........(N/deg/kN**2) A112
Load influence on vertical shift ..........(N/kN)....... A12
Vertical shift at load = 0 ................(N).......... A13

Shape factor ........................................... B0
Load infl. on long. friction coeff (*1000)... (1/kN) ... B1
Longitudinal friction coefficient at load = 0 (*1000)... B2
Curvature factor of stiffness ............ (N/%/kN**2) . B3
Change of stiffness with load at load = 0 (N/%/kN) ..... B4
Change of progressivity of stiffness/load (1/kN) ....... B5
Curvature change with load ............................. B6
Curvature change with load ............................. B7
Curvature at load = 0 .................................. B8
Load influence on horizontal shift ....... (%/kN) ...... B9
Horizontal shift at load = 0 ............. (%) ......... B10
Load influence on vertical shift ......... (N/kN) ...... B11
Vertical shift at load = 0 ............... (N) ......... B12

Shape factor ........................................... C0
Load influence of peak value ............ (Nm/kN**2) ... C1
Load influence of peak value ............ (Nm/kN) ...... C2
Curvature factor of stiffness ........... (Nm/deg/kN**2) C3
Change of stiffness with load at load = 0 (Nm/deg/kN) .. C4
Change of progressivity of stiffness/load (1/kN) ....... C5
Camber influence on stiffness ........... (%/deg/100) .. C6
Curvature change with load ............................. C7
Curvature change with load ............................. C8
Curvature at load = 0 .................................. C9
Camber influence of stiffness .......................... C10
Camber influence on horizontal shift......(deg/deg)..... C11
Load influence on horizontal shift........(deg/kN)...... C12
Horizontal shift at load = 0..............(deg)......... C13
Camber influence on vertical shift........(Nm/deg/kN**2) C14
Camber influence on vertical shift........(Nm/deg/kN)... C15
Load influence on vertical shift..........(Nm/kN)....... C16
Vertical shift at load = 0................(Nm).......... C17
</pre>
More information can be found at http://members.xoom.virgilio.it/adiaforo/epcjk.htm

==Brakes==
Front/rear parameters are broken into two fields. In the example below the front section is shown.
<pre>
friction = 0.73
max-pressure = 4.0e6
bias = 0.60
radius = 0.14
area = 0.015
</pre>
The bias parameter is the fraction of braking pressure applied to the front brakes (in the front brake section) or the rear brakes (in the rear brake section). To make sense, the rear value should equal 1.0 minus the front value. The maximum brake torque is calculated as friction * area * bias * max-pressure * radius. Some fraction of this value is applied based on the brake pedal.

==Driver==
<pre>
position = -0.62, -0.35, -0.12
mass = 90.0
view-position = -0.64, 0.35, 0.30
hood-mounted-view-position = 0.55, 0, 0.17
view-stiffness = 0.0
</pre>
The position and mass affect the weight distribution of the car. The view positions define 3D coordinates for camera placement. The view-stiffness parameter defines the stiffness of the camera bounce effect, where 0.0 is a sports car and 1.0 is F1-ish.

==Drag==
<pre>
position = 0.0, 0.0, 0.2
frontal-area = 2
drag-coefficient = 0.3
</pre>
The frontal area and coefficient of drag, set with frontal-area and drag-coefficient, are used to calculate the drag force.

==Wing==
Front/rear parameters are broken into two fields. In the example below the front section is shown.
<pre>
position = 1.9, 0.0, 0.60
frontal-area = 0.2
drag-coefficient = 0.0
surface-area = 0.3
lift-coefficient = -0.5
efficiency = 0.95
</pre>
Downforce can be added with wings. The amount of downforce is determined by the value in the lift-coefficient tag. If the lift coefficient is positive, upforce is generated. This is usually undesirable for cars. The efficiency determines how much drag is added as downforce increases. The surface-area is the surface area of the wing. This value is also used in the drag calculation.

==Wheel==
Per-wheel parameters are broken into four fields. In the example below the front left wheel is shown.
<pre>
position = 1.14, 0.76, -0.47
roll-height = 0.29
mass = 18.14
restitution = 0.1
</pre>

==Contact-points==
<pre>
mass = 0.05
position-00 = 1.96, 0.37, -0.24
position-01 = 1.96, -0.37, -0.24
position-02 = 1.52, 0.83, 0.16
position-03 = 1.52, -0.83, 0.16
position-04 = -0.10, 0.89, -0.24
position-05 = -0.10, -0.89, -0.24
position-06 = -2.18, -0.83, -0.10
position-07 = -2.18, 0.83, -0.10
</pre>
These values are used for weight distribution and balance only. They no longer perform any contact-related function. So, contact-points are the same as particles (defined below), but the syntax is slightly different.

==Particle==
These parameters are broken into a series of values starting at 00 and going to some number less than 100. The particle-00 is shown below.
<pre>
mass = 30.0
position = -1.28, 0.0, -0.36
</pre>
These values are used for weight distribution and balance.

Compiling VDrift

2009-06-17T04:01:32Z

Venzon: /* Linux */

Compiling VDrift is different depending on the operating system on which it is compiled.

==Linux==
===Prerequisites===
Make sure you have all the required libraries and build tools. Make sure you also have the development files for each of the libraries.

The required build tools include:

* '''g++''' - The GNU C++ compiler
* '''scons''' - A replacement for Make

The required libraries include:

* '''libsdl''' - Simple Direct Media Layer
* '''libglew''' - OpenGL extension utilities
* '''sdl-gfx''' - Graphics drawing primitives library for SDL
* '''sdl-image''' - Image file loading library for SDL
* '''vorbisfile''' - File loading library for the ogg vorbis format
* '''libvorbis''' - The Vorbis General Audio Compression Codec
* Boost C++ Libraries (header-file-only)
* ASIO C++ Libraries (header-file-only)

Your Linux distribution may have different package names and/or bundled differently. The list above should give enough information to search for applicable packages within your distribution's package manager.

For Ubuntu, all the required packages may be installed using this command:
sudo apt-get install g++ scons libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libvorbis-dev libglew-dev libasio-dev

====Bullet====
As of SVN R2358 (2009-06-15 release and later), no steps are required to build bullet and you can continue to the next section.

For the 2009-02-15 release, the only step required is to expand the Bullet source archive:
tar zxvf bullet-2.73-sp1.tgz

{{note|For older versions of VDrift, you will need to follow the [[Old Method of Compiling Bullet]].}}

====SCons====
As of the 2005-10-02 release, VDrift no longer uses ./configure, make, etc. (autotools). Now the project is built with [http://scons.org/ SCons]. You may want to read a little about [[Using SCons]].

There are two ways to use SCons. The first way is to install scons on your system through your package manager, then you can use it simply by the name of the program, "scons". If you followed the directions for installing prerequisites for Ubuntu above, then you're done and can continue on to the next section. The second way is to use the scons-local package (included with VDrift) which will do the same thing but doesn't require that you install scons on your system. To do this, you must move the scons-local-0.96.95.tar.gz archive from tools to the root vdrift folder, un-tar the archive, and then use the <code>./scons.py</code> command instead of <code>scons</code>.

===Get the Code===
You can get the code from a source package for a particular version, or you can [[Getting the development version|get the development version]].
====Source Package====
[http://sourceforge.net/project/showfiles.php?group_id=137283 Download] the latest VDrift Linux source package. All the files in the package are in a directory called vdrift-'''version'''-src where '''version''' is something like 2009-06-15.

Unpack the archive.

tar jxvf vdrift-2009-06-15-src.tar.bz2

=====Enter directory=====
Now change directories into the location of your newly created VDrift source tree.
cd vdrift-2009-06-15

====Optional: Using scons-local instead of installing SCons====
If you have decided not to install SCons on your system, you can use scons-local. To set it up, do the following:

tar zxvf tools/scons-local-0.96.1.tar.gz

{{note|Some of the following steps refer to the <code>scons</code> command, you should now replace that with <code>./scons.py</code>.}}

===Compiling===
To compile VDrift, just use the <code>scons</code> command.
scons

====Optional: Compile Options====
You can use one or more compile options. To compile with optimization for a certain platform, you can use the '''arch''' option.
scons arch=a64
Compiling VDrift in '''release''' mode will turn off debugging options, and enable more compiler optimizations. VDrift runs much more quickly in release mode.
scons release=1
{{note|These options are probably best left off the first time you compile. If you have problems compiling or running VDrift, it is easier to debug with them off. Once you verify that VDrift is compiling, then recompile with these optimizations to improve performance.}}

===Installing===
VDrift does not need to be installed to work and you can run it from the folder where you compiled it. If you do want to install, use the SCons build target '''install'''. This command must be run as root.
sudo scons install
{{note|The <code>scons install</code> process was broken for several releases including the 2009-02-15 release and may fail to install needed datafiles. If you have release 2009-02-15 or earlier, run "sudo scons install" as noted above and then manually re-copy the data files to the installed destination folder:
sudo cp -r data/* /usr/share/games/vdrift/data}}

====Optional: Installation Location====
You can change the installation prefix. For example, if you want VDrift to go in <code>/usr/local/share/games/vdrift</code>, you can change the '''prefix''' setting.
scons install prefix=/usr/local

{{note|There are many more build and install options, see the [[Using SCons]] page for more information.}}

===Running===
For release 2009-02-15 and earlier, if you used the default install locations, VDrift can be run with the command:
/usr/share/games/vdrift/bin/vdrift
For release 2009-06-15 and later, if you used the default install locations, VDrift can be run with the command:
/usr/local/bin/vdrift

==Mac OS X==
===Prerequisites===
The VDrift Mac OS X project requires Xcode version 2.2 with the "10.4 Universal SDK" and the "X11 SDK" installed.

===Download===
Get the VDrift source code, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Mac OS X|development version]].

===Build===
Finally open ''tools/osx/vdrift.xcodeproj'' and hit "Build" from XCode's "Build" menu.

==Windows==
In order to build VDrift for Windows, you must set up the tools to build the software, build Bullet and VDrift, and then install VDrift into a runtime folder.

===Install and Configure Build Tools===
To build VDrift on Windows you'll need working installations of [http://www.mingw.org/ MinGW], [http://www.mingw.org/msys.shtml MSYS and MSYS-DTK], [http://www.python.org/ Python], and [http://www.scons.org/ SCons].
{{note|The versions listed for these tools were the ones used at time of this writing (current stable versions of all packages), there may be new versions. This is a known working configuration.}}
====MinGW====
* [http://downloads.sourceforge.net/mingw/MinGW-5.1.3.exe?modtime=1168811236&big_mirror=1 Download MinGW 5.1.3]
* Run the installer.
* When asked to select components for install, you only need the base system and the g++ compiler.
* Choose the default install location.
====MSYS====
* [http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe?modtime=1079444447&big_mirror=1 Download MSYS 1.0.10]
* Run the installer.
* Choose the default install location.
* When presented with a terminal asking if you want to continue with the post-install, type '''y''', then press enter.
* When asked if MinGW is installed, enter '''C:/MinGW''', then press enter.
* The MSYS post install script should find your MinGW installation now and configure itself.
====MSYS DTK====
* [http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe?modtime=1041430674&big_mirror=1 Download MSYS-DTK 1.01]
* Run the installer and accept all the defaults.
====Python====
* [http://www.python.org/ftp/python/2.5.1/python-2.5.1.msi Download Python 2.5.1]
* Run the installer and accept all the defaults.
====SCons====
* [http://www.scons.org/ SCons 0.97]
* Run the installer. It should find your Python installation, accept all defaults.

===Download VDrift Source and Data===
Get the VDrift source code and data, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Windows|development version]].

{{note|From this point on the directory in which you checked out VDrift will be referred to as the root VDrift directory. The development environment setup script puts this in an environment variable $VDRIFT_DIR.}}

===Building===
====Boost====
Download a Boost distribution from this link:

http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041&release_id=679861

Uncompress Boost, and move the boost_1_39_0/boost folder to VDrift/tools/win/include

====ASIO====
Download the ASIO distribution from this link:

http://sourceforge.net/project/showfiles.php?group_id=122478&package_id=134200&release_id=665620

Uncompress ASIO, and move asio-1.4.1/include/* to VDrift/tools/win/include

====VDrift====
To build VDrift you must use the MSYS terminal, compile the Bullet library, and compile VDrift itself.
* Launch MSYS by clicking '''Start''' -> '''Programs''' -> '''MinGW''' -> '''MSYS''' -> '''msys'''.
* Change directories to the spot where you checked VDrift out. If your username is '''Administrator''' and you put it on your Desktop in a directory named '''VDrift''', you would enter this command:
cd /c/Documents\ and\ Settings/Administrator/Desktop/VDrift
* Now, to build VDrift, run the command:
build_vdrift.sh

===Run VDrift===
* Move or copy the VDrift data to a directory named data within the root VDrift directory. This can be done in a few different ways, depending on how you obtained the VDrift data. You could check it out directly here, or you could check it out in another place and use TortoiseSVN to export it to this location. If you downloaded a VDrift data archive you can extract it here, or extract it elsewhere and then move or copy the necessary files to runtime. In the end, just make sure you have a directory structure with paths like '''VDrift/data/cars/''', '''VDrift/data/tracks/''', etc.
===Running===
Now, to run VDrift, you just need to double-click on the file '''vdrift.exe''' within the root VDrift directory.

Compiling VDrift

2009-06-08T03:41:22Z

Venzon: /* Building */

Compiling VDrift is different depending on the operating system on which it is compiled.

==Linux==
===Prerequisites===
Make sure you have all the required libraries and build tools. Make sure you also have the development files for each of the libraries.

The required build tools include:

* '''g++''' - The GNU C++ compiler
* '''scons''' - A replacement for Make

The required libraries include:

* '''libsdl''' - Simple Direct Media Layer
* '''libglew''' - OpenGL extension utilities
* '''sdl-gfx''' - Graphics drawing primitives library for SDL
* '''sdl-image''' - Image file loading library for SDL
* '''vorbisfile''' - File loading library for the ogg vorbis format
* '''libvorbis''' - The Vorbis General Audio Compression Codec
* '''libboost''' - Boost C++ Libraries

Your Linux distribution may have different package names and/or bundled differently. The list above should give enough information to search for applicable packages within your distribution's package manager.

For Ubuntu, all the required packages may be installed using this command:
sudo apt-get install g++ scons libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libvorbis-dev libglew-dev libasio-dev

====Bullet====
As of SVN R2358, no steps are required to build bullet and you can continue to the next section.

For the 2009-02-15 release, the only step required is to expand the Bullet source archive:
tar zxvf bullet-2.73-sp1.tgz

{{note|For older versions of VDrift, you will need to follow the [[Old Method of Compiling Bullet]].}}

====SCons====
As of the 2005-10-02 release, VDrift no longer uses ./configure, make, etc. (autotools). Now the project is built with [http://scons.org/ SCons]. You may want to read a little about [[Using SCons]].

There are two ways to use SCons. The first way is to install scons on your system through your package manager, then you can use it simply by the name of the program, "scons". If you followed the directions for installing prerequisites for Ubuntu above, then you're done and can continue on to the next section. The second way is to use the scons-local package (included with VDrift) which will do the same thing but doesn't require that you install scons on your system. To do this, you must move the scons-local-0.96.95.tar.gz archive from tools to the root vdrift folder, un-tar the archive, and then use the <code>./scons.py</code> command instead of <code>scons</code>.

===Get the Code===
You can get the code from a source package for a particular version, or you can [[Getting the development version|get the development version]].
====Source Package====
[http://sourceforge.net/project/showfiles.php?group_id=137283 Download] the latest VDrift Linux source package. All the files in the package are in a directory called vdrift-'''version'''-src where '''version''' is something like 2009-02-15.

Unpack the archive.

tar jxvf vdrift-2009-02-15-src.tar.bz2

=====Enter directory=====
Now change directories into the location of your newly created VDrift source tree.
cd vdrift-2009-02-15

====Optional: Using scons-local instead of installing SCons====
If you have decided not to install SCons on your system, you can use scons-local. To set it up, do the following:

tar zxvf tools/scons-local-0.96.1.tar.gz

{{note|Some of the following steps refer to the <code>scons</code> command, you should now replace that with <code>./scons.py</code>.}}

===Compiling===
To compile VDrift, just use the <code>scons</code> command.
scons

====Optional: Compile Options====
You can use one or more compile options. To compile with optimization for a certain platform, you can use the '''arch''' option.
scons arch=a64
Compiling VDrift in '''release''' mode will turn off debugging options, and enable more compiler optimizations. VDrift runs much more quickly in release mode.
scons release=1
{{note|These options are probably best left off the first time you compile. If you have problems compiling or running VDrift, it is easier to debug with them off. Once you verify that VDrift is compiling, then recompile with these optimizations to improve performance.}}

===Installing===
VDrift does not need to be installed to work and you can run it from the folder where you compiled it. If you do want to install, use the SCons build target '''install'''. This command must be run as root.
sudo scons install
{{note|The <code>scons install</code> process was broken for several releases including the 2009-02-15 release and may fail to install needed datafiles. If you have release 2009-02-15 or earlier, run "sudo scons install" as noted above and then manually re-copy the data files to the installed destination folder:
sudo cp -r data/* /usr/share/games/vdrift/data}}

====Optional: Installation Location====
You can change the installation prefix. For example, if you want VDrift to go in <code>/usr/local/share/games/vdrift</code>, you can change the '''prefix''' setting.
scons install prefix=/usr/local

{{note|There are many more build and install options, see the [[Using SCons]] page for more information.}}

===Running===
For release 2009-02-15 and earlier, if you used the default install locations, VDrift can be run with the command:
/usr/share/games/vdrift/bin/vdrift

==Mac OS X==
===Prerequisites===
The VDrift Mac OS X project requires Xcode version 2.2 with the "10.4 Universal SDK" and the "X11 SDK" installed.

===Download===
Get the VDrift source code, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Mac OS X|development version]].

===Build===
Finally open ''tools/osx/vdrift.xcodeproj'' and hit "Build" from XCode's "Build" menu.

==Windows==
In order to build VDrift for Windows, you must set up the tools to build the software, build Bullet and VDrift, and then install VDrift into a runtime folder.

===Install and Configure Build Tools===
To build VDrift on Windows you'll need working installations of [http://www.mingw.org/ MinGW], [http://www.mingw.org/msys.shtml MSYS and MSYS-DTK], [http://www.python.org/ Python], and [http://www.scons.org/ SCons].
{{note|The versions listed for these tools were the ones used at time of this writing (current stable versions of all packages), there may be new versions. This is a known working configuration.}}
====MinGW====
* [http://downloads.sourceforge.net/mingw/MinGW-5.1.3.exe?modtime=1168811236&big_mirror=1 Download MinGW 5.1.3]
* Run the installer.
* When asked to select components for install, you only need the base system and the g++ compiler.
* Choose the default install location.
====MSYS====
* [http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe?modtime=1079444447&big_mirror=1 Download MSYS 1.0.10]
* Run the installer.
* Choose the default install location.
* When presented with a terminal asking if you want to continue with the post-install, type '''y''', then press enter.
* When asked if MinGW is installed, enter '''C:/MinGW''', then press enter.
* The MSYS post install script should find your MinGW installation now and configure itself.
====MSYS DTK====
* [http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe?modtime=1041430674&big_mirror=1 Download MSYS-DTK 1.01]
* Run the installer and accept all the defaults.
====Python====
* [http://www.python.org/ftp/python/2.5.1/python-2.5.1.msi Download Python 2.5.1]
* Run the installer and accept all the defaults.
====SCons====
* [http://www.scons.org/ SCons 0.97]
* Run the installer. It should find your Python installation, accept all defaults.

===Download VDrift Source and Data===
Get the VDrift source code and data, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Windows|development version]].

{{note|From this point on the directory in which you checked out VDrift will be referred to as the root VDrift directory. The development environment setup script puts this in an environment variable $VDRIFT_DIR.}}

===Building===
====Boost====
Download a Boost distribution from this link:

http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041&release_id=679861

Uncompress Boost, and move the boost_1_39_0/boost folder to VDrift/tools/win/include

====ASIO====
Download the ASIO distribution from this link:

http://sourceforge.net/project/showfiles.php?group_id=122478&package_id=134200&release_id=665620

Uncompress ASIO, and move asio-1.4.1/include/* to VDrift/tools/win/include

====VDrift====
To build VDrift you must use the MSYS terminal, compile the Bullet library, and compile VDrift itself.
* Launch MSYS by clicking '''Start''' -> '''Programs''' -> '''MinGW''' -> '''MSYS''' -> '''msys'''.
* Change directories to the spot where you checked VDrift out. If your username is '''Administrator''' and you put it on your Desktop in a directory named '''VDrift''', you would enter this command:
cd /c/Documents\ and\ Settings/Administrator/Desktop/VDrift
* Now, to build VDrift, run the command:
build_vdrift.sh

===Run VDrift===
* Move or copy the VDrift data to a directory named data within the root VDrift directory. This can be done in a few different ways, depending on how you obtained the VDrift data. You could check it out directly here, or you could check it out in another place and use TortoiseSVN to export it to this location. If you downloaded a VDrift data archive you can extract it here, or extract it elsewhere and then move or copy the necessary files to runtime. In the end, just make sure you have a directory structure with paths like '''VDrift/data/cars/''', '''VDrift/data/tracks/''', etc.
===Running===
Now, to run VDrift, you just need to double-click on the file '''vdrift.exe''' within the root VDrift directory.

Compiling VDrift

2009-06-08T03:38:45Z

Venzon: /* Building */

Compiling VDrift is different depending on the operating system on which it is compiled.

==Linux==
===Prerequisites===
Make sure you have all the required libraries and build tools. Make sure you also have the development files for each of the libraries.

The required build tools include:

* '''g++''' - The GNU C++ compiler
* '''scons''' - A replacement for Make

The required libraries include:

* '''libsdl''' - Simple Direct Media Layer
* '''libglew''' - OpenGL extension utilities
* '''sdl-gfx''' - Graphics drawing primitives library for SDL
* '''sdl-image''' - Image file loading library for SDL
* '''vorbisfile''' - File loading library for the ogg vorbis format
* '''libvorbis''' - The Vorbis General Audio Compression Codec
* '''libboost''' - Boost C++ Libraries

Your Linux distribution may have different package names and/or bundled differently. The list above should give enough information to search for applicable packages within your distribution's package manager.

For Ubuntu, all the required packages may be installed using this command:
sudo apt-get install g++ scons libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libvorbis-dev libglew-dev libasio-dev

====Bullet====
As of SVN R2358, no steps are required to build bullet and you can continue to the next section.

For the 2009-02-15 release, the only step required is to expand the Bullet source archive:
tar zxvf bullet-2.73-sp1.tgz

{{note|For older versions of VDrift, you will need to follow the [[Old Method of Compiling Bullet]].}}

====SCons====
As of the 2005-10-02 release, VDrift no longer uses ./configure, make, etc. (autotools). Now the project is built with [http://scons.org/ SCons]. You may want to read a little about [[Using SCons]].

There are two ways to use SCons. The first way is to install scons on your system through your package manager, then you can use it simply by the name of the program, "scons". If you followed the directions for installing prerequisites for Ubuntu above, then you're done and can continue on to the next section. The second way is to use the scons-local package (included with VDrift) which will do the same thing but doesn't require that you install scons on your system. To do this, you must move the scons-local-0.96.95.tar.gz archive from tools to the root vdrift folder, un-tar the archive, and then use the <code>./scons.py</code> command instead of <code>scons</code>.

===Get the Code===
You can get the code from a source package for a particular version, or you can [[Getting the development version|get the development version]].
====Source Package====
[http://sourceforge.net/project/showfiles.php?group_id=137283 Download] the latest VDrift Linux source package. All the files in the package are in a directory called vdrift-'''version'''-src where '''version''' is something like 2009-02-15.

Unpack the archive.

tar jxvf vdrift-2009-02-15-src.tar.bz2

=====Enter directory=====
Now change directories into the location of your newly created VDrift source tree.
cd vdrift-2009-02-15

====Optional: Using scons-local instead of installing SCons====
If you have decided not to install SCons on your system, you can use scons-local. To set it up, do the following:

tar zxvf tools/scons-local-0.96.1.tar.gz

{{note|Some of the following steps refer to the <code>scons</code> command, you should now replace that with <code>./scons.py</code>.}}

===Compiling===
To compile VDrift, just use the <code>scons</code> command.
scons

====Optional: Compile Options====
You can use one or more compile options. To compile with optimization for a certain platform, you can use the '''arch''' option.
scons arch=a64
Compiling VDrift in '''release''' mode will turn off debugging options, and enable more compiler optimizations. VDrift runs much more quickly in release mode.
scons release=1
{{note|These options are probably best left off the first time you compile. If you have problems compiling or running VDrift, it is easier to debug with them off. Once you verify that VDrift is compiling, then recompile with these optimizations to improve performance.}}

===Installing===
VDrift does not need to be installed to work and you can run it from the folder where you compiled it. If you do want to install, use the SCons build target '''install'''. This command must be run as root.
sudo scons install
{{note|The <code>scons install</code> process was broken for several releases including the 2009-02-15 release and may fail to install needed datafiles. If you have release 2009-02-15 or earlier, run "sudo scons install" as noted above and then manually re-copy the data files to the installed destination folder:
sudo cp -r data/* /usr/share/games/vdrift/data}}

====Optional: Installation Location====
You can change the installation prefix. For example, if you want VDrift to go in <code>/usr/local/share/games/vdrift</code>, you can change the '''prefix''' setting.
scons install prefix=/usr/local

{{note|There are many more build and install options, see the [[Using SCons]] page for more information.}}

===Running===
For release 2009-02-15 and earlier, if you used the default install locations, VDrift can be run with the command:
/usr/share/games/vdrift/bin/vdrift

==Mac OS X==
===Prerequisites===
The VDrift Mac OS X project requires Xcode version 2.2 with the "10.4 Universal SDK" and the "X11 SDK" installed.

===Download===
Get the VDrift source code, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Mac OS X|development version]].

===Build===
Finally open ''tools/osx/vdrift.xcodeproj'' and hit "Build" from XCode's "Build" menu.

==Windows==
In order to build VDrift for Windows, you must set up the tools to build the software, build Bullet and VDrift, and then install VDrift into a runtime folder.

===Install and Configure Build Tools===
To build VDrift on Windows you'll need working installations of [http://www.mingw.org/ MinGW], [http://www.mingw.org/msys.shtml MSYS and MSYS-DTK], [http://www.python.org/ Python], and [http://www.scons.org/ SCons].
{{note|The versions listed for these tools were the ones used at time of this writing (current stable versions of all packages), there may be new versions. This is a known working configuration.}}
====MinGW====
* [http://downloads.sourceforge.net/mingw/MinGW-5.1.3.exe?modtime=1168811236&big_mirror=1 Download MinGW 5.1.3]
* Run the installer.
* When asked to select components for install, you only need the base system and the g++ compiler.
* Choose the default install location.
====MSYS====
* [http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe?modtime=1079444447&big_mirror=1 Download MSYS 1.0.10]
* Run the installer.
* Choose the default install location.
* When presented with a terminal asking if you want to continue with the post-install, type '''y''', then press enter.
* When asked if MinGW is installed, enter '''C:/MinGW''', then press enter.
* The MSYS post install script should find your MinGW installation now and configure itself.
====MSYS DTK====
* [http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe?modtime=1041430674&big_mirror=1 Download MSYS-DTK 1.01]
* Run the installer and accept all the defaults.
====Python====
* [http://www.python.org/ftp/python/2.5.1/python-2.5.1.msi Download Python 2.5.1]
* Run the installer and accept all the defaults.
====SCons====
* [http://www.scons.org/ SCons 0.97]
* Run the installer. It should find your Python installation, accept all defaults.

===Download VDrift Source and Data===
Get the VDrift source code and data, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Windows|development version]].

{{note|From this point on the directory in which you checked out VDrift will be referred to as the root VDrift directory. The development environment setup script puts this in an environment variable $VDRIFT_DIR.}}

===Building===
====Boost====
Download a Boost distribution from this link:

http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041&release_id=679861

Uncompress Boost, and move the boost_1_39_0/boost folder to VDrift/tools/win/include

====ASIO====
Download the ASIO distribution from this link:

http://sourceforge.net/project/showfiles.php?group_id=122478&package_id=134200&release_id=665620

Uncompress ASIO, and move the contents to VDrift/tools/win/include

====VDrift====
To build VDrift you must use the MSYS terminal, compile the Bullet library, and compile VDrift itself.
* Launch MSYS by clicking '''Start''' -> '''Programs''' -> '''MinGW''' -> '''MSYS''' -> '''msys'''.
* Change directories to the spot where you checked VDrift out. If your username is '''Administrator''' and you put it on your Desktop in a directory named '''VDrift''', you would enter this command:
cd /c/Documents\ and\ Settings/Administrator/Desktop/VDrift
* Now, to build VDrift, run the command:
build_vdrift.sh

===Run VDrift===
* Move or copy the VDrift data to a directory named data within the root VDrift directory. This can be done in a few different ways, depending on how you obtained the VDrift data. You could check it out directly here, or you could check it out in another place and use TortoiseSVN to export it to this location. If you downloaded a VDrift data archive you can extract it here, or extract it elsewhere and then move or copy the necessary files to runtime. In the end, just make sure you have a directory structure with paths like '''VDrift/data/cars/''', '''VDrift/data/tracks/''', etc.
===Running===
Now, to run VDrift, you just need to double-click on the file '''vdrift.exe''' within the root VDrift directory.

Compiling VDrift

2009-06-07T15:51:04Z

Venzon: /* Prerequisites */

Compiling VDrift is different depending on the operating system on which it is compiled.

==Linux==
===Prerequisites===
Make sure you have all the required libraries and build tools. Make sure you also have the development files for each of the libraries.

The required build tools include:

* '''g++''' - The GNU C++ compiler
* '''scons''' - A replacement for Make

The required libraries include:

* '''libsdl''' - Simple Direct Media Layer
* '''libglew''' - OpenGL extension utilities
* '''sdl-gfx''' - Graphics drawing primitives library for SDL
* '''sdl-image''' - Image file loading library for SDL
* '''vorbisfile''' - File loading library for the ogg vorbis format
* '''libvorbis''' - The Vorbis General Audio Compression Codec
* '''libboost''' - Boost C++ Libraries

Your Linux distribution may have different package names and/or bundled differently. The list above should give enough information to search for applicable packages within your distribution's package manager.

For Ubuntu, all the required packages may be installed using this command:
sudo apt-get install g++ scons libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libvorbis-dev libglew-dev libasio-dev

====Bullet====
As of SVN R2358, no steps are required to build bullet and you can continue to the next section.

For the 2009-02-15 release, the only step required is to expand the Bullet source archive:
tar zxvf bullet-2.73-sp1.tgz

{{note|For older versions of VDrift, you will need to follow the [[Old Method of Compiling Bullet]].}}

====SCons====
As of the 2005-10-02 release, VDrift no longer uses ./configure, make, etc. (autotools). Now the project is built with [http://scons.org/ SCons]. You may want to read a little about [[Using SCons]].

There are two ways to use SCons. The first way is to install scons on your system through your package manager, then you can use it simply by the name of the program, "scons". If you followed the directions for installing prerequisites for Ubuntu above, then you're done and can continue on to the next section. The second way is to use the scons-local package (included with VDrift) which will do the same thing but doesn't require that you install scons on your system. To do this, you must move the scons-local-0.96.95.tar.gz archive from tools to the root vdrift folder, un-tar the archive, and then use the <code>./scons.py</code> command instead of <code>scons</code>.

===Get the Code===
You can get the code from a source package for a particular version, or you can [[Getting the development version|get the development version]].
====Source Package====
[http://sourceforge.net/project/showfiles.php?group_id=137283 Download] the latest VDrift Linux source package. All the files in the package are in a directory called vdrift-'''version'''-src where '''version''' is something like 2009-02-15.

Unpack the archive.

tar jxvf vdrift-2009-02-15-src.tar.bz2

=====Enter directory=====
Now change directories into the location of your newly created VDrift source tree.
cd vdrift-2009-02-15

====Optional: Using scons-local instead of installing SCons====
If you have decided not to install SCons on your system, you can use scons-local. To set it up, do the following:

tar zxvf tools/scons-local-0.96.1.tar.gz

{{note|Some of the following steps refer to the <code>scons</code> command, you should now replace that with <code>./scons.py</code>.}}

===Compiling===
To compile VDrift, just use the <code>scons</code> command.
scons

====Optional: Compile Options====
You can use one or more compile options. To compile with optimization for a certain platform, you can use the '''arch''' option.
scons arch=a64
Compiling VDrift in '''release''' mode will turn off debugging options, and enable more compiler optimizations. VDrift runs much more quickly in release mode.
scons release=1
{{note|These options are probably best left off the first time you compile. If you have problems compiling or running VDrift, it is easier to debug with them off. Once you verify that VDrift is compiling, then recompile with these optimizations to improve performance.}}

===Installing===
VDrift does not need to be installed to work and you can run it from the folder where you compiled it. If you do want to install, use the SCons build target '''install'''. This command must be run as root.
sudo scons install
{{note|The <code>scons install</code> process was broken for several releases including the 2009-02-15 release and may fail to install needed datafiles. If you have release 2009-02-15 or earlier, run "sudo scons install" as noted above and then manually re-copy the data files to the installed destination folder:
sudo cp -r data/* /usr/share/games/vdrift/data}}

====Optional: Installation Location====
You can change the installation prefix. For example, if you want VDrift to go in <code>/usr/local/share/games/vdrift</code>, you can change the '''prefix''' setting.
scons install prefix=/usr/local

{{note|There are many more build and install options, see the [[Using SCons]] page for more information.}}

===Running===
For release 2009-02-15 and earlier, if you used the default install locations, VDrift can be run with the command:
/usr/share/games/vdrift/bin/vdrift

==Mac OS X==
===Prerequisites===
The VDrift Mac OS X project requires Xcode version 2.2 with the "10.4 Universal SDK" and the "X11 SDK" installed.

===Download===
Get the VDrift source code, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Mac OS X|development version]].

===Build===
Finally open ''tools/osx/vdrift.xcodeproj'' and hit "Build" from XCode's "Build" menu.

==Windows==
In order to build VDrift for Windows, you must set up the tools to build the software, build Bullet and VDrift, and then install VDrift into a runtime folder.

===Install and Configure Build Tools===
To build VDrift on Windows you'll need working installations of [http://www.mingw.org/ MinGW], [http://www.mingw.org/msys.shtml MSYS and MSYS-DTK], [http://www.python.org/ Python], and [http://www.scons.org/ SCons].
{{note|The versions listed for these tools were the ones used at time of this writing (current stable versions of all packages), there may be new versions. This is a known working configuration.}}
====MinGW====
* [http://downloads.sourceforge.net/mingw/MinGW-5.1.3.exe?modtime=1168811236&big_mirror=1 Download MinGW 5.1.3]
* Run the installer.
* When asked to select components for install, you only need the base system and the g++ compiler.
* Choose the default install location.
====MSYS====
* [http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe?modtime=1079444447&big_mirror=1 Download MSYS 1.0.10]
* Run the installer.
* Choose the default install location.
* When presented with a terminal asking if you want to continue with the post-install, type '''y''', then press enter.
* When asked if MinGW is installed, enter '''C:/MinGW''', then press enter.
* The MSYS post install script should find your MinGW installation now and configure itself.
====MSYS DTK====
* [http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe?modtime=1041430674&big_mirror=1 Download MSYS-DTK 1.01]
* Run the installer and accept all the defaults.
====Python====
* [http://www.python.org/ftp/python/2.5.1/python-2.5.1.msi Download Python 2.5.1]
* Run the installer and accept all the defaults.
====SCons====
* [http://www.scons.org/ SCons 0.97]
* Run the installer. It should find your Python installation, accept all defaults.

===Download VDrift Source and Data===
Get the VDrift source code and data, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Windows|development version]].

{{note|From this point on the directory in which you checked out VDrift will be referred to as the root VDrift directory. The development environment setup script puts this in an environment variable $VDRIFT_DIR.}}

===Building===
====Boost====
Download a Boost distribution from this link:

http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041&release_id=679861

Uncompress Boost, and move the boost_1_39_0/boost folder to VDrift/tools/win/include

====VDrift====
To build VDrift you must use the MSYS terminal, compile the Bullet library, and compile VDrift itself.
* Launch MSYS by clicking '''Start''' -> '''Programs''' -> '''MinGW''' -> '''MSYS''' -> '''msys'''.
* Change directories to the spot where you checked VDrift out. If your username is '''Administrator''' and you put it on your Desktop in a directory named '''VDrift''', you would enter this command:
cd /c/Documents\ and\ Settings/Administrator/Desktop/VDrift
* Now, to build VDrift, run the command:
build_vdrift.sh

===Run VDrift===
* Move or copy the VDrift data to a directory named data within the root VDrift directory. This can be done in a few different ways, depending on how you obtained the VDrift data. You could check it out directly here, or you could check it out in another place and use TortoiseSVN to export it to this location. If you downloaded a VDrift data archive you can extract it here, or extract it elsewhere and then move or copy the necessary files to runtime. In the end, just make sure you have a directory structure with paths like '''VDrift/data/cars/''', '''VDrift/data/tracks/''', etc.
===Running===
Now, to run VDrift, you just need to double-click on the file '''vdrift.exe''' within the root VDrift directory.

Compiling VDrift

2009-06-07T15:50:54Z

Venzon: /* Prerequisites */

Compiling VDrift is different depending on the operating system on which it is compiled.

==Linux==
===Prerequisites===
Make sure you have all the required libraries and build tools. Make sure you also have the development files for each of the libraries.

The required build tools include:

* '''g++''' - The GNU C++ compiler
* '''scons''' - A replacement for Make

The required libraries include:

* '''libsdl''' - Simple Direct Media Layer
* '''libglew''' - OpenGL extension utilities
* '''sdl-gfx''' - Graphics drawing primitives library for SDL
* '''sdl-image''' - Image file loading library for SDL
* '''vorbisfile''' - File loading library for the ogg vorbis format
* '''libvorbis''' - The Vorbis General Audio Compression Codec
* '''libboost''' - Boost C++ Libraries

Your Linux distribution may have different package names and/or bundled differently. The list above should give enough information to search for applicable packages within your distribution's package manager.

For Ubuntu, all the required packages may be installed using this command:
sudo apt-get install g++ scons libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libvorbis-dev libglew-dev libasio-dev libboost-dev

On Ubuntu jaunty, rather use:
sudo apt-get install g++ scons libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libvorbis-dev libglew-dev libasio-dev

====Bullet====
As of SVN R2358, no steps are required to build bullet and you can continue to the next section.

For the 2009-02-15 release, the only step required is to expand the Bullet source archive:
tar zxvf bullet-2.73-sp1.tgz

{{note|For older versions of VDrift, you will need to follow the [[Old Method of Compiling Bullet]].}}

====SCons====
As of the 2005-10-02 release, VDrift no longer uses ./configure, make, etc. (autotools). Now the project is built with [http://scons.org/ SCons]. You may want to read a little about [[Using SCons]].

There are two ways to use SCons. The first way is to install scons on your system through your package manager, then you can use it simply by the name of the program, "scons". If you followed the directions for installing prerequisites for Ubuntu above, then you're done and can continue on to the next section. The second way is to use the scons-local package (included with VDrift) which will do the same thing but doesn't require that you install scons on your system. To do this, you must move the scons-local-0.96.95.tar.gz archive from tools to the root vdrift folder, un-tar the archive, and then use the <code>./scons.py</code> command instead of <code>scons</code>.

===Get the Code===
You can get the code from a source package for a particular version, or you can [[Getting the development version|get the development version]].
====Source Package====
[http://sourceforge.net/project/showfiles.php?group_id=137283 Download] the latest VDrift Linux source package. All the files in the package are in a directory called vdrift-'''version'''-src where '''version''' is something like 2009-02-15.

Unpack the archive.

tar jxvf vdrift-2009-02-15-src.tar.bz2

=====Enter directory=====
Now change directories into the location of your newly created VDrift source tree.
cd vdrift-2009-02-15

====Optional: Using scons-local instead of installing SCons====
If you have decided not to install SCons on your system, you can use scons-local. To set it up, do the following:

tar zxvf tools/scons-local-0.96.1.tar.gz

{{note|Some of the following steps refer to the <code>scons</code> command, you should now replace that with <code>./scons.py</code>.}}

===Compiling===
To compile VDrift, just use the <code>scons</code> command.
scons

====Optional: Compile Options====
You can use one or more compile options. To compile with optimization for a certain platform, you can use the '''arch''' option.
scons arch=a64
Compiling VDrift in '''release''' mode will turn off debugging options, and enable more compiler optimizations. VDrift runs much more quickly in release mode.
scons release=1
{{note|These options are probably best left off the first time you compile. If you have problems compiling or running VDrift, it is easier to debug with them off. Once you verify that VDrift is compiling, then recompile with these optimizations to improve performance.}}

===Installing===
VDrift does not need to be installed to work and you can run it from the folder where you compiled it. If you do want to install, use the SCons build target '''install'''. This command must be run as root.
sudo scons install
{{note|The <code>scons install</code> process was broken for several releases including the 2009-02-15 release and may fail to install needed datafiles. If you have release 2009-02-15 or earlier, run "sudo scons install" as noted above and then manually re-copy the data files to the installed destination folder:
sudo cp -r data/* /usr/share/games/vdrift/data}}

====Optional: Installation Location====
You can change the installation prefix. For example, if you want VDrift to go in <code>/usr/local/share/games/vdrift</code>, you can change the '''prefix''' setting.
scons install prefix=/usr/local

{{note|There are many more build and install options, see the [[Using SCons]] page for more information.}}

===Running===
For release 2009-02-15 and earlier, if you used the default install locations, VDrift can be run with the command:
/usr/share/games/vdrift/bin/vdrift

==Mac OS X==
===Prerequisites===
The VDrift Mac OS X project requires Xcode version 2.2 with the "10.4 Universal SDK" and the "X11 SDK" installed.

===Download===
Get the VDrift source code, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Mac OS X|development version]].

===Build===
Finally open ''tools/osx/vdrift.xcodeproj'' and hit "Build" from XCode's "Build" menu.

==Windows==
In order to build VDrift for Windows, you must set up the tools to build the software, build Bullet and VDrift, and then install VDrift into a runtime folder.

===Install and Configure Build Tools===
To build VDrift on Windows you'll need working installations of [http://www.mingw.org/ MinGW], [http://www.mingw.org/msys.shtml MSYS and MSYS-DTK], [http://www.python.org/ Python], and [http://www.scons.org/ SCons].
{{note|The versions listed for these tools were the ones used at time of this writing (current stable versions of all packages), there may be new versions. This is a known working configuration.}}
====MinGW====
* [http://downloads.sourceforge.net/mingw/MinGW-5.1.3.exe?modtime=1168811236&big_mirror=1 Download MinGW 5.1.3]
* Run the installer.
* When asked to select components for install, you only need the base system and the g++ compiler.
* Choose the default install location.
====MSYS====
* [http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe?modtime=1079444447&big_mirror=1 Download MSYS 1.0.10]
* Run the installer.
* Choose the default install location.
* When presented with a terminal asking if you want to continue with the post-install, type '''y''', then press enter.
* When asked if MinGW is installed, enter '''C:/MinGW''', then press enter.
* The MSYS post install script should find your MinGW installation now and configure itself.
====MSYS DTK====
* [http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe?modtime=1041430674&big_mirror=1 Download MSYS-DTK 1.01]
* Run the installer and accept all the defaults.
====Python====
* [http://www.python.org/ftp/python/2.5.1/python-2.5.1.msi Download Python 2.5.1]
* Run the installer and accept all the defaults.
====SCons====
* [http://www.scons.org/ SCons 0.97]
* Run the installer. It should find your Python installation, accept all defaults.

===Download VDrift Source and Data===
Get the VDrift source code and data, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Windows|development version]].

{{note|From this point on the directory in which you checked out VDrift will be referred to as the root VDrift directory. The development environment setup script puts this in an environment variable $VDRIFT_DIR.}}

===Building===
====Boost====
Download a Boost distribution from this link:

http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041&release_id=679861

Uncompress Boost, and move the boost_1_39_0/boost folder to VDrift/tools/win/include

====VDrift====
To build VDrift you must use the MSYS terminal, compile the Bullet library, and compile VDrift itself.
* Launch MSYS by clicking '''Start''' -> '''Programs''' -> '''MinGW''' -> '''MSYS''' -> '''msys'''.
* Change directories to the spot where you checked VDrift out. If your username is '''Administrator''' and you put it on your Desktop in a directory named '''VDrift''', you would enter this command:
cd /c/Documents\ and\ Settings/Administrator/Desktop/VDrift
* Now, to build VDrift, run the command:
build_vdrift.sh

===Run VDrift===
* Move or copy the VDrift data to a directory named data within the root VDrift directory. This can be done in a few different ways, depending on how you obtained the VDrift data. You could check it out directly here, or you could check it out in another place and use TortoiseSVN to export it to this location. If you downloaded a VDrift data archive you can extract it here, or extract it elsewhere and then move or copy the necessary files to runtime. In the end, just make sure you have a directory structure with paths like '''VDrift/data/cars/''', '''VDrift/data/tracks/''', etc.
===Running===
Now, to run VDrift, you just need to double-click on the file '''vdrift.exe''' within the root VDrift directory.

Compiling VDrift

2009-05-30T19:17:58Z

Venzon: /* Linux */

Compiling VDrift is different depending on the operating system on which it is compiled.

==Linux==
===Prerequisites===
Make sure you have all the required libraries and build tools. Make sure you also have the development files for each of the libraries.

The required build tools include:

* '''g++''' - The GNU C++ compiler
* '''scons''' - A replacement for Make

The required libraries include:

* '''libsdl''' - Simple Direct Media Layer
* '''libglew''' - OpenGL extension utilities
* '''sdl-gfx''' - Graphics drawing primitives library for SDL
* '''sdl-image''' - Image file loading library for SDL
* '''vorbisfile''' - File loading library for the ogg vorbis format
* '''libvorbis''' - The Vorbis General Audio Compression Codec
* '''libboost''' - Boost C++ Libraries

Your Linux distribution may have different package names and/or bundled differently. The list above should give enough information to search for applicable packages within your distribution's package manager.

For Ubuntu, all the required packages may be installed using this command:
sudo apt-get install g++ scons libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libvorbis-dev libglew-dev libboost-dev

On Ubuntu jaunty, rather use:
sudo apt-get install g++ scons libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libvorbis-dev libglew-dev libasio-dev

====Bullet====
As of SVN R2358, no steps are required to build bullet and you can continue to the next section.

For the 2009-02-15 release, the only step required is to expand the Bullet source archive:
tar zxvf bullet-2.73-sp1.tgz

{{note|For older versions of VDrift, you will need to follow the [[Old Method of Compiling Bullet]].}}

====SCons====
As of the 2005-10-02 release, VDrift no longer uses ./configure, make, etc. (autotools). Now the project is built with [http://scons.org/ SCons]. You may want to read a little about [[Using SCons]].

There are two ways to use SCons. The first way is to install scons on your system through your package manager, then you can use it simply by the name of the program, "scons". If you followed the directions for installing prerequisites for Ubuntu above, then you're done and can continue on to the next section. The second way is to use the scons-local package (included with VDrift) which will do the same thing but doesn't require that you install scons on your system. To do this, you must move the scons-local-0.96.95.tar.gz archive from tools to the root vdrift folder, un-tar the archive, and then use the <code>./scons.py</code> command instead of <code>scons</code>.

===Get the Code===
You can get the code from a source package for a particular version, or you can [[Getting the development version|get the development version]].
====Source Package====
[http://sourceforge.net/project/showfiles.php?group_id=137283 Download] the latest VDrift Linux source package. All the files in the package are in a directory called vdrift-'''version'''-src where '''version''' is something like 2009-02-15.

Unpack the archive.

tar jxvf vdrift-2009-02-15-src.tar.bz2

=====Enter directory=====
Now change directories into the location of your newly created VDrift source tree.
cd vdrift-2009-02-15

====Optional: Using scons-local instead of installing SCons====
If you have decided not to install SCons on your system, you can use scons-local. To set it up, do the following:

tar zxvf tools/scons-local-0.96.1.tar.gz

{{note|Some of the following steps refer to the <code>scons</code> command, you should now replace that with <code>./scons.py</code>.}}

===Compiling===
To compile VDrift, just use the <code>scons</code> command.
scons

====Optional: Compile Options====
You can use one or more compile options. To compile with optimization for a certain platform, you can use the '''arch''' option.
scons arch=a64
Compiling VDrift in '''release''' mode will turn off debugging options, and enable more compiler optimizations. VDrift runs much more quickly in release mode.
scons release=1
{{note|These options are probably best left off the first time you compile. If you have problems compiling or running VDrift, it is easier to debug with them off. Once you verify that VDrift is compiling, then recompile with these optimizations to improve performance.}}

===Installing===
VDrift does not need to be installed to work and you can run it from the folder where you compiled it. If you do want to install, use the SCons build target '''install'''. This command must be run as root.
sudo scons install
{{note|The <code>scons install</code> process was broken for several releases including the 2009-02-15 release and may fail to install needed datafiles. If you have release 2009-02-15 or earlier, run "sudo scons install" as noted above and then manually re-copy the data files to the installed destination folder:
sudo cp -r data/* /usr/share/games/vdrift/data}}

====Optional: Installation Location====
You can change the installation prefix. For example, if you want VDrift to go in <code>/usr/local/share/games/vdrift</code>, you can change the '''prefix''' setting.
scons install prefix=/usr/local

{{note|There are many more build and install options, see the [[Using SCons]] page for more information.}}

===Running===
For release 2009-02-15 and earlier, if you used the default install locations, VDrift can be run with the command:
/usr/share/games/vdrift/bin/vdrift

==Mac OS X==
===Prerequisites===
The VDrift Mac OS X project requires Xcode version 2.2 with the "10.4 Universal SDK" and the "X11 SDK" installed.

===Download===
Get the VDrift source code, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Mac OS X|development version]].

===Build===
Finally open ''tools/osx/vdrift.xcodeproj'' and hit "Build" from XCode's "Build" menu.

==Windows==
In order to build VDrift for Windows, you must set up the tools to build the software, build Bullet and VDrift, and then install VDrift into a runtime folder.

===Install and Configure Build Tools===
To build VDrift on Windows you'll need working installations of [http://www.mingw.org/ MinGW], [http://www.mingw.org/msys.shtml MSYS and MSYS-DTK], [http://www.python.org/ Python], and [http://www.scons.org/ SCons].
{{note|The versions listed for these tools were the ones used at time of this writing (current stable versions of all packages), there may be new versions. This is a known working configuration.}}
====MinGW====
* [http://downloads.sourceforge.net/mingw/MinGW-5.1.3.exe?modtime=1168811236&big_mirror=1 Download MinGW 5.1.3]
* Run the installer.
* When asked to select components for install, you only need the base system and the g++ compiler.
* Choose the default install location.
====MSYS====
* [http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe?modtime=1079444447&big_mirror=1 Download MSYS 1.0.10]
* Run the installer.
* Choose the default install location.
* When presented with a terminal asking if you want to continue with the post-install, type '''y''', then press enter.
* When asked if MinGW is installed, enter '''C:/MinGW''', then press enter.
* The MSYS post install script should find your MinGW installation now and configure itself.
====MSYS DTK====
* [http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe?modtime=1041430674&big_mirror=1 Download MSYS-DTK 1.01]
* Run the installer and accept all the defaults.
====Python====
* [http://www.python.org/ftp/python/2.5.1/python-2.5.1.msi Download Python 2.5.1]
* Run the installer and accept all the defaults.
====SCons====
* [http://www.scons.org/ SCons 0.97]
* Run the installer. It should find your Python installation, accept all defaults.

===Download VDrift Source and Data===
Get the VDrift source code and data, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Windows|development version]].

{{note|From this point on the directory in which you checked out VDrift will be referred to as the root VDrift directory. The development environment setup script puts this in an environment variable $VDRIFT_DIR.}}

===Building===
====Boost====
Download a Boost distribution from this link:

http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041&release_id=679861

Uncompress Boost, and move the boost_1_39_0/boost folder to VDrift/tools/win/include

====VDrift====
To build VDrift you must use the MSYS terminal, compile the Bullet library, and compile VDrift itself.
* Launch MSYS by clicking '''Start''' -> '''Programs''' -> '''MinGW''' -> '''MSYS''' -> '''msys'''.
* Change directories to the spot where you checked VDrift out. If your username is '''Administrator''' and you put it on your Desktop in a directory named '''VDrift''', you would enter this command:
cd /c/Documents\ and\ Settings/Administrator/Desktop/VDrift
* Now, to build VDrift, run the command:
build_vdrift.sh

===Run VDrift===
* Move or copy the VDrift data to a directory named data within the root VDrift directory. This can be done in a few different ways, depending on how you obtained the VDrift data. You could check it out directly here, or you could check it out in another place and use TortoiseSVN to export it to this location. If you downloaded a VDrift data archive you can extract it here, or extract it elsewhere and then move or copy the necessary files to runtime. In the end, just make sure you have a directory structure with paths like '''VDrift/data/cars/''', '''VDrift/data/tracks/''', etc.
===Running===
Now, to run VDrift, you just need to double-click on the file '''vdrift.exe''' within the root VDrift directory.

Compiling VDrift

2009-05-30T19:16:03Z

Venzon: /* Installation Options */

Compiling VDrift is different depending on the operating system on which it is compiled.

==Linux==
===Prerequisites===
Make sure you have all the required libraries and build tools. Make sure you also have the development files for each of the libraries.

The required build tools include:

* '''g++''' - The GNU C++ compiler
* '''scons''' - A replacement for Make

The required libraries include:

* '''libsdl''' - Simple Direct Media Layer
* '''libglew''' - OpenGL extension utilities
* '''sdl-gfx''' - Graphics drawing primitives library for SDL
* '''sdl-image''' - Image file loading library for SDL
* '''vorbisfile''' - File loading library for the ogg vorbis format
* '''libvorbis''' - The Vorbis General Audio Compression Codec
* '''libboost''' - Boost C++ Libraries

Your Linux distribution may have different package names and/or bundled differently. The list above should give enough information to search for applicable packages within your distribution's package manager.

For Ubuntu, all the required packages may be installed using this command:
sudo apt-get install g++ scons libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libvorbis-dev libglew-dev libboost-dev

On Ubuntu jaunty, rather use:
sudo apt-get install g++ scons libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libvorbis-dev libglew-dev libasio-dev

====Bullet====
As of SVN R2358, no steps are required to build bullet and you can continue to the next section.

For the 2009-02-15 release, the only step required is to expand the Bullet source archive:
tar zxvf bullet-2.73-sp1.tgz

{{note|For older versions of VDrift, you will need to follow the [[Old Method of Compiling Bullet]].}}

====SCons====
As of the 2005-10-02 release, VDrift no longer uses ./configure, make, etc. (autotools). Now the project is built with [http://scons.org/ SCons]. You may want to read a little about [[Using SCons]].

There are two ways to use SCons. The first way is to install scons on your system through your package manager, then you can use it simply by the name of the program, "scons". If you followed the directions for installing prerequisites for Ubuntu above, then you're done and can continue on to the next section. The second way is to use the scons-local package (included with VDrift) which will do the same thing but doesn't require that you install scons on your system. To do this, you must move the scons-local-0.96.95.tar.gz archive from tools to the root vdrift folder, un-tar the archive, and then use the <code>./scons.py</code> command instead of <code>scons</code>.

===Get the Code===
You can get the code from a source package for a particular version, or you can [[Getting the development version|get the development version]].
====Source Package====
[http://sourceforge.net/project/showfiles.php?group_id=137283 Download] the latest VDrift Linux source package. All the files in the package are in a directory called vdrift-'''version'''-src where '''version''' is something like 2009-02-15.

Unpack the archive.

tar jxvf vdrift-2009-02-15-src.tar.bz2

=====Enter directory=====
Now change directories into the location of your newly created VDrift source tree.
cd vdrift-2009-02-15

====Optional: Using scons-local instead of installing SCons====
If you have decided not to install SCons on your system, you can use scons-local. To set it up, do the following:

tar zxvf tools/scons-local-0.96.1.tar.gz

{{note|Some of the following steps refer to the <code>scons</code> command, you should now replace that with <code>./scons.py</code>.}}

===Compiling===
To compile VDrift, just use the <code>scons</code> command.
scons

====Optional: Compile Options====
You can use one or more compile options. To compile with optimization for a certain platform, you can use the '''arch''' option.
scons arch=a64
Compiling VDrift in '''release''' mode will turn off debugging options, and enable more compiler optimizations. VDrift runs much more quickly in release mode.
scons release=1
{{note|These options are probably best left off the first time you compile. If you have problems compiling or running VDrift, it is easier to debug with them off. Once you verify that VDrift is compiling, then recompile with these optimizations to improve performance.}}

===Installing===
VDrift does not need to be installed to work and you can run it from the folder where you compiled it. If you do want to install, use the SCons build target '''install'''. This command must be run as root.
sudo scons install
{{note|The <code>scons install</code> process was broken for several releases including the 2009-02-15 release and may fail to install needed datafiles. If you have release 2009-02-15 or earlier, run "sudo scons install" as noted above and then manually re-copy the data files to the installed destination folder:
sudo cp -r data/* /usr/share/games/vdrift/data}}

====Optional: Installation Location====
You can change the installation prefix. For example, if you want VDrift to go in <code>/usr/local/share/games/vdrift</code>, you can change the '''prefix''' setting.
scons install prefix=/usr/local

{{note|There are many more build and install options, see the [[Using SCons]] page for more information.}}

==Mac OS X==
===Prerequisites===
The VDrift Mac OS X project requires Xcode version 2.2 with the "10.4 Universal SDK" and the "X11 SDK" installed.

===Download===
Get the VDrift source code, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Mac OS X|development version]].

===Build===
Finally open ''tools/osx/vdrift.xcodeproj'' and hit "Build" from XCode's "Build" menu.

==Windows==
In order to build VDrift for Windows, you must set up the tools to build the software, build Bullet and VDrift, and then install VDrift into a runtime folder.

===Install and Configure Build Tools===
To build VDrift on Windows you'll need working installations of [http://www.mingw.org/ MinGW], [http://www.mingw.org/msys.shtml MSYS and MSYS-DTK], [http://www.python.org/ Python], and [http://www.scons.org/ SCons].
{{note|The versions listed for these tools were the ones used at time of this writing (current stable versions of all packages), there may be new versions. This is a known working configuration.}}
====MinGW====
* [http://downloads.sourceforge.net/mingw/MinGW-5.1.3.exe?modtime=1168811236&big_mirror=1 Download MinGW 5.1.3]
* Run the installer.
* When asked to select components for install, you only need the base system and the g++ compiler.
* Choose the default install location.
====MSYS====
* [http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe?modtime=1079444447&big_mirror=1 Download MSYS 1.0.10]
* Run the installer.
* Choose the default install location.
* When presented with a terminal asking if you want to continue with the post-install, type '''y''', then press enter.
* When asked if MinGW is installed, enter '''C:/MinGW''', then press enter.
* The MSYS post install script should find your MinGW installation now and configure itself.
====MSYS DTK====
* [http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe?modtime=1041430674&big_mirror=1 Download MSYS-DTK 1.01]
* Run the installer and accept all the defaults.
====Python====
* [http://www.python.org/ftp/python/2.5.1/python-2.5.1.msi Download Python 2.5.1]
* Run the installer and accept all the defaults.
====SCons====
* [http://www.scons.org/ SCons 0.97]
* Run the installer. It should find your Python installation, accept all defaults.

===Download VDrift Source and Data===
Get the VDrift source code and data, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Windows|development version]].

{{note|From this point on the directory in which you checked out VDrift will be referred to as the root VDrift directory. The development environment setup script puts this in an environment variable $VDRIFT_DIR.}}

===Building===
====Boost====
Download a Boost distribution from this link:

http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041&release_id=679861

Uncompress Boost, and move the boost_1_39_0/boost folder to VDrift/tools/win/include

====VDrift====
To build VDrift you must use the MSYS terminal, compile the Bullet library, and compile VDrift itself.
* Launch MSYS by clicking '''Start''' -> '''Programs''' -> '''MinGW''' -> '''MSYS''' -> '''msys'''.
* Change directories to the spot where you checked VDrift out. If your username is '''Administrator''' and you put it on your Desktop in a directory named '''VDrift''', you would enter this command:
cd /c/Documents\ and\ Settings/Administrator/Desktop/VDrift
* Now, to build VDrift, run the command:
build_vdrift.sh

===Run VDrift===
* Move or copy the VDrift data to a directory named data within the root VDrift directory. This can be done in a few different ways, depending on how you obtained the VDrift data. You could check it out directly here, or you could check it out in another place and use TortoiseSVN to export it to this location. If you downloaded a VDrift data archive you can extract it here, or extract it elsewhere and then move or copy the necessary files to runtime. In the end, just make sure you have a directory structure with paths like '''VDrift/data/cars/''', '''VDrift/data/tracks/''', etc.
===Running===
Now, to run VDrift, you just need to double-click on the file '''vdrift.exe''' within the root VDrift directory.

Compiling VDrift

2009-05-30T19:15:34Z

Venzon: /* Installing */

Compiling VDrift is different depending on the operating system on which it is compiled.

==Linux==
===Prerequisites===
Make sure you have all the required libraries and build tools. Make sure you also have the development files for each of the libraries.

The required build tools include:

* '''g++''' - The GNU C++ compiler
* '''scons''' - A replacement for Make

The required libraries include:

* '''libsdl''' - Simple Direct Media Layer
* '''libglew''' - OpenGL extension utilities
* '''sdl-gfx''' - Graphics drawing primitives library for SDL
* '''sdl-image''' - Image file loading library for SDL
* '''vorbisfile''' - File loading library for the ogg vorbis format
* '''libvorbis''' - The Vorbis General Audio Compression Codec
* '''libboost''' - Boost C++ Libraries

Your Linux distribution may have different package names and/or bundled differently. The list above should give enough information to search for applicable packages within your distribution's package manager.

For Ubuntu, all the required packages may be installed using this command:
sudo apt-get install g++ scons libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libvorbis-dev libglew-dev libboost-dev

On Ubuntu jaunty, rather use:
sudo apt-get install g++ scons libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libvorbis-dev libglew-dev libasio-dev

====Bullet====
As of SVN R2358, no steps are required to build bullet and you can continue to the next section.

For the 2009-02-15 release, the only step required is to expand the Bullet source archive:
tar zxvf bullet-2.73-sp1.tgz

{{note|For older versions of VDrift, you will need to follow the [[Old Method of Compiling Bullet]].}}

====SCons====
As of the 2005-10-02 release, VDrift no longer uses ./configure, make, etc. (autotools). Now the project is built with [http://scons.org/ SCons]. You may want to read a little about [[Using SCons]].

There are two ways to use SCons. The first way is to install scons on your system through your package manager, then you can use it simply by the name of the program, "scons". If you followed the directions for installing prerequisites for Ubuntu above, then you're done and can continue on to the next section. The second way is to use the scons-local package (included with VDrift) which will do the same thing but doesn't require that you install scons on your system. To do this, you must move the scons-local-0.96.95.tar.gz archive from tools to the root vdrift folder, un-tar the archive, and then use the <code>./scons.py</code> command instead of <code>scons</code>.

===Get the Code===
You can get the code from a source package for a particular version, or you can [[Getting the development version|get the development version]].
====Source Package====
[http://sourceforge.net/project/showfiles.php?group_id=137283 Download] the latest VDrift Linux source package. All the files in the package are in a directory called vdrift-'''version'''-src where '''version''' is something like 2009-02-15.

Unpack the archive.

tar jxvf vdrift-2009-02-15-src.tar.bz2

=====Enter directory=====
Now change directories into the location of your newly created VDrift source tree.
cd vdrift-2009-02-15

====Optional: Using scons-local instead of installing SCons====
If you have decided not to install SCons on your system, you can use scons-local. To set it up, do the following:

tar zxvf tools/scons-local-0.96.1.tar.gz

{{note|Some of the following steps refer to the <code>scons</code> command, you should now replace that with <code>./scons.py</code>.}}

===Compiling===
To compile VDrift, just use the <code>scons</code> command.
scons

====Optional: Compile Options====
You can use one or more compile options. To compile with optimization for a certain platform, you can use the '''arch''' option.
scons arch=a64
Compiling VDrift in '''release''' mode will turn off debugging options, and enable more compiler optimizations. VDrift runs much more quickly in release mode.
scons release=1
{{note|These options are probably best left off the first time you compile. If you have problems compiling or running VDrift, it is easier to debug with them off. Once you verify that VDrift is compiling, then recompile with these optimizations to improve performance.}}

===Installing===
VDrift does not need to be installed to work and you can run it from the folder where you compiled it. If you do want to install, use the SCons build target '''install'''. This command must be run as root.
sudo scons install
{{note|The <code>scons install</code> process was broken for several releases including the 2009-02-15 release and may fail to install needed datafiles. If you have release 2009-02-15 or earlier, run "sudo scons install" as noted above and then manually re-copy the data files to the installed destination folder:
sudo cp -r data/* /usr/share/games/vdrift/data}}

====Installation Options====
You can change the installation prefix. For example, if you want VDrift to go in <code>/usr/local/share/games/vdrift</code>, you can change the '''prefix''' setting.
scons install prefix=/usr/local

{{note|There are many more build and install options, see the [[Using SCons]] page for more information.}}

==Mac OS X==
===Prerequisites===
The VDrift Mac OS X project requires Xcode version 2.2 with the "10.4 Universal SDK" and the "X11 SDK" installed.

===Download===
Get the VDrift source code, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Mac OS X|development version]].

===Build===
Finally open ''tools/osx/vdrift.xcodeproj'' and hit "Build" from XCode's "Build" menu.

==Windows==
In order to build VDrift for Windows, you must set up the tools to build the software, build Bullet and VDrift, and then install VDrift into a runtime folder.

===Install and Configure Build Tools===
To build VDrift on Windows you'll need working installations of [http://www.mingw.org/ MinGW], [http://www.mingw.org/msys.shtml MSYS and MSYS-DTK], [http://www.python.org/ Python], and [http://www.scons.org/ SCons].
{{note|The versions listed for these tools were the ones used at time of this writing (current stable versions of all packages), there may be new versions. This is a known working configuration.}}
====MinGW====
* [http://downloads.sourceforge.net/mingw/MinGW-5.1.3.exe?modtime=1168811236&big_mirror=1 Download MinGW 5.1.3]
* Run the installer.
* When asked to select components for install, you only need the base system and the g++ compiler.
* Choose the default install location.
====MSYS====
* [http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe?modtime=1079444447&big_mirror=1 Download MSYS 1.0.10]
* Run the installer.
* Choose the default install location.
* When presented with a terminal asking if you want to continue with the post-install, type '''y''', then press enter.
* When asked if MinGW is installed, enter '''C:/MinGW''', then press enter.
* The MSYS post install script should find your MinGW installation now and configure itself.
====MSYS DTK====
* [http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe?modtime=1041430674&big_mirror=1 Download MSYS-DTK 1.01]
* Run the installer and accept all the defaults.
====Python====
* [http://www.python.org/ftp/python/2.5.1/python-2.5.1.msi Download Python 2.5.1]
* Run the installer and accept all the defaults.
====SCons====
* [http://www.scons.org/ SCons 0.97]
* Run the installer. It should find your Python installation, accept all defaults.

===Download VDrift Source and Data===
Get the VDrift source code and data, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Windows|development version]].

{{note|From this point on the directory in which you checked out VDrift will be referred to as the root VDrift directory. The development environment setup script puts this in an environment variable $VDRIFT_DIR.}}

===Building===
====Boost====
Download a Boost distribution from this link:

http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041&release_id=679861

Uncompress Boost, and move the boost_1_39_0/boost folder to VDrift/tools/win/include

====VDrift====
To build VDrift you must use the MSYS terminal, compile the Bullet library, and compile VDrift itself.
* Launch MSYS by clicking '''Start''' -> '''Programs''' -> '''MinGW''' -> '''MSYS''' -> '''msys'''.
* Change directories to the spot where you checked VDrift out. If your username is '''Administrator''' and you put it on your Desktop in a directory named '''VDrift''', you would enter this command:
cd /c/Documents\ and\ Settings/Administrator/Desktop/VDrift
* Now, to build VDrift, run the command:
build_vdrift.sh

===Run VDrift===
* Move or copy the VDrift data to a directory named data within the root VDrift directory. This can be done in a few different ways, depending on how you obtained the VDrift data. You could check it out directly here, or you could check it out in another place and use TortoiseSVN to export it to this location. If you downloaded a VDrift data archive you can extract it here, or extract it elsewhere and then move or copy the necessary files to runtime. In the end, just make sure you have a directory structure with paths like '''VDrift/data/cars/''', '''VDrift/data/tracks/''', etc.
===Running===
Now, to run VDrift, you just need to double-click on the file '''vdrift.exe''' within the root VDrift directory.

Compiling VDrift

2009-05-30T19:15:12Z

Venzon: /* Installing */

Compiling VDrift is different depending on the operating system on which it is compiled.

==Linux==
===Prerequisites===
Make sure you have all the required libraries and build tools. Make sure you also have the development files for each of the libraries.

The required build tools include:

* '''g++''' - The GNU C++ compiler
* '''scons''' - A replacement for Make

The required libraries include:

* '''libsdl''' - Simple Direct Media Layer
* '''libglew''' - OpenGL extension utilities
* '''sdl-gfx''' - Graphics drawing primitives library for SDL
* '''sdl-image''' - Image file loading library for SDL
* '''vorbisfile''' - File loading library for the ogg vorbis format
* '''libvorbis''' - The Vorbis General Audio Compression Codec
* '''libboost''' - Boost C++ Libraries

Your Linux distribution may have different package names and/or bundled differently. The list above should give enough information to search for applicable packages within your distribution's package manager.

For Ubuntu, all the required packages may be installed using this command:
sudo apt-get install g++ scons libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libvorbis-dev libglew-dev libboost-dev

On Ubuntu jaunty, rather use:
sudo apt-get install g++ scons libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libvorbis-dev libglew-dev libasio-dev

====Bullet====
As of SVN R2358, no steps are required to build bullet and you can continue to the next section.

For the 2009-02-15 release, the only step required is to expand the Bullet source archive:
tar zxvf bullet-2.73-sp1.tgz

{{note|For older versions of VDrift, you will need to follow the [[Old Method of Compiling Bullet]].}}

====SCons====
As of the 2005-10-02 release, VDrift no longer uses ./configure, make, etc. (autotools). Now the project is built with [http://scons.org/ SCons]. You may want to read a little about [[Using SCons]].

There are two ways to use SCons. The first way is to install scons on your system through your package manager, then you can use it simply by the name of the program, "scons". If you followed the directions for installing prerequisites for Ubuntu above, then you're done and can continue on to the next section. The second way is to use the scons-local package (included with VDrift) which will do the same thing but doesn't require that you install scons on your system. To do this, you must move the scons-local-0.96.95.tar.gz archive from tools to the root vdrift folder, un-tar the archive, and then use the <code>./scons.py</code> command instead of <code>scons</code>.

===Get the Code===
You can get the code from a source package for a particular version, or you can [[Getting the development version|get the development version]].
====Source Package====
[http://sourceforge.net/project/showfiles.php?group_id=137283 Download] the latest VDrift Linux source package. All the files in the package are in a directory called vdrift-'''version'''-src where '''version''' is something like 2009-02-15.

Unpack the archive.

tar jxvf vdrift-2009-02-15-src.tar.bz2

=====Enter directory=====
Now change directories into the location of your newly created VDrift source tree.
cd vdrift-2009-02-15

====Optional: Using scons-local instead of installing SCons====
If you have decided not to install SCons on your system, you can use scons-local. To set it up, do the following:

tar zxvf tools/scons-local-0.96.1.tar.gz

{{note|Some of the following steps refer to the <code>scons</code> command, you should now replace that with <code>./scons.py</code>.}}

===Compiling===
To compile VDrift, just use the <code>scons</code> command.
scons

====Optional: Compile Options====
You can use one or more compile options. To compile with optimization for a certain platform, you can use the '''arch''' option.
scons arch=a64
Compiling VDrift in '''release''' mode will turn off debugging options, and enable more compiler optimizations. VDrift runs much more quickly in release mode.
scons release=1
{{note|These options are probably best left off the first time you compile. If you have problems compiling or running VDrift, it is easier to debug with them off. Once you verify that VDrift is compiling, then recompile with these optimizations to improve performance.}}

===Installing===
VDrift does not need to be installed to work and you can run it from the folder where you compiled it. If you do want to install, use the SCons build target '''install'''. This command must be run as root.
sudo scons install
{{note|The <code>scons install</code> process was broken for several releases including the 2009-02-15 release and may fail to install needed datafiles. If you have release 2009-02-15 or earlier, run "sudo scons install" as noted above and then manually re-copy the data files to the installed destination folder:
sudo cp -r data /usr/share/games/vdrift/data}}

====Installation Options====
You can change the installation prefix. For example, if you want VDrift to go in <code>/usr/local/share/games/vdrift</code>, you can change the '''prefix''' setting.
scons install prefix=/usr/local

{{note|There are many more build and install options, see the [[Using SCons]] page for more information.}}

==Mac OS X==
===Prerequisites===
The VDrift Mac OS X project requires Xcode version 2.2 with the "10.4 Universal SDK" and the "X11 SDK" installed.

===Download===
Get the VDrift source code, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Mac OS X|development version]].

===Build===
Finally open ''tools/osx/vdrift.xcodeproj'' and hit "Build" from XCode's "Build" menu.

==Windows==
In order to build VDrift for Windows, you must set up the tools to build the software, build Bullet and VDrift, and then install VDrift into a runtime folder.

===Install and Configure Build Tools===
To build VDrift on Windows you'll need working installations of [http://www.mingw.org/ MinGW], [http://www.mingw.org/msys.shtml MSYS and MSYS-DTK], [http://www.python.org/ Python], and [http://www.scons.org/ SCons].
{{note|The versions listed for these tools were the ones used at time of this writing (current stable versions of all packages), there may be new versions. This is a known working configuration.}}
====MinGW====
* [http://downloads.sourceforge.net/mingw/MinGW-5.1.3.exe?modtime=1168811236&big_mirror=1 Download MinGW 5.1.3]
* Run the installer.
* When asked to select components for install, you only need the base system and the g++ compiler.
* Choose the default install location.
====MSYS====
* [http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe?modtime=1079444447&big_mirror=1 Download MSYS 1.0.10]
* Run the installer.
* Choose the default install location.
* When presented with a terminal asking if you want to continue with the post-install, type '''y''', then press enter.
* When asked if MinGW is installed, enter '''C:/MinGW''', then press enter.
* The MSYS post install script should find your MinGW installation now and configure itself.
====MSYS DTK====
* [http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe?modtime=1041430674&big_mirror=1 Download MSYS-DTK 1.01]
* Run the installer and accept all the defaults.
====Python====
* [http://www.python.org/ftp/python/2.5.1/python-2.5.1.msi Download Python 2.5.1]
* Run the installer and accept all the defaults.
====SCons====
* [http://www.scons.org/ SCons 0.97]
* Run the installer. It should find your Python installation, accept all defaults.

===Download VDrift Source and Data===
Get the VDrift source code and data, either from the latest source release on the [http://sourceforge.net/project/showfiles.php?group_id=137283 VDrift downloads page], or the [[Getting the development version#Windows|development version]].

{{note|From this point on the directory in which you checked out VDrift will be referred to as the root VDrift directory. The development environment setup script puts this in an environment variable $VDRIFT_DIR.}}

===Building===
====Boost====
Download a Boost distribution from this link:

http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041&release_id=679861

Uncompress Boost, and move the boost_1_39_0/boost folder to VDrift/tools/win/include

====VDrift====
To build VDrift you must use the MSYS terminal, compile the Bullet library, and compile VDrift itself.
* Launch MSYS by clicking '''Start''' -> '''Programs''' -> '''MinGW''' -> '''MSYS''' -> '''msys'''.
* Change directories to the spot where you checked VDrift out. If your username is '''Administrator''' and you put it on your Desktop in a directory named '''VDrift''', you would enter this command:
cd /c/Documents\ and\ Settings/Administrator/Desktop/VDrift
* Now, to build VDrift, run the command:
build_vdrift.sh

===Run VDrift===
* Move or copy the VDrift data to a directory named data within the root VDrift directory. This can be done in a few different ways, depending on how you obtained the VDrift data. You could check it out directly here, or you could check it out in another place and use TortoiseSVN to export it to this location. If you downloaded a VDrift data archive you can extract it here, or extract it elsewhere and then move or copy the necessary files to runtime. In the end, just make sure you have a directory structure with paths like '''VDrift/data/cars/''', '''VDrift/data/tracks/''', etc.
===Running===
Now, to run VDrift, you just need to double-click on the file '''vdrift.exe''' within the root VDrift directory.