The units are all in MKS (meters, kilograms, seconds). It might also help to read The Physics of Racing by Brian Beckman. For unit conversion you can go to: 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.
The .car files use the right-handed (positive) coordinate system for all parameters:
- x axis: negative is left, positive is right
- y axis: negative is back, positive is forward
- z axis: negative is down, positive is up
[section]
texture = diffuse.png, misc1.png, misc2.png
mesh = model.joe
position = 0.736, 1.14, -0.47
rotation = 0, 0, 30
scale = -1, 1, 1
color = 0.8, 0.1, 0.1
draw = transparent
mass = 40
Every car section supports a set of optional parameters to describe its graphic representation.
Texture is a list of textures that has to contain at least one texture, usually the diffuse color texture. Mesh defines the model mesh to be used with the texture. Texture and mesh paths are relative to car(XS) and carparts(shared components) directory.
Position/rotation(in degrees)/scale will transform the mesh relative to parent. Color defines the color of the mesh(to be blended with the texture according to its alpha channel). Draw allows the options transparent(according to first textures alpha channel) or emissive(won't be affected by lighting, used for brake/reverse light models).
Mass is used to calculate car inertia, weight and center of mass.
[engine]
position = 0.86, 0.0, -0.21
mass = 140.0
inertia = 0.25
displacement = 2E-3
max-power = 1.79e5
peak-engine-rpm = 7800.0
rpm-limit = 9000.0
start-rpm = 1000
stall-rpm = 350
#efficiency = 0.35 # optional, engine efficiency used to calculate fuel consumption
#fuel-heating-value = 4.5E7 # optional, Ws/kg used to calculate fuel consumption
#torque-friction = 15.4, 2.4, 0.8 # optional, overrides friction calculated from displacement
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
The position and mass parameters affect the weight distribution of the car. The rotational inertia of the moving parts is inertia. Displacement is used to calculate engine friction (Heywood 1988). Engine friction can be overriden by the optional torque-friction parameter. Starting the engine sets the engine speed to start-rpm, which is also used to calculate idle throttle. Letting the engine speed drop below stall-rpm makes the engine stall. The torque curve should include stall-rpm and rpm-limit. Fuel consumption is proportional to engine power output.
[clutch]
sliding = 0.27
radius = 0.15
area = 0.75
max-pressure = 11079.26
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]
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
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.
For FWD cars [differential.front] has to be defined. AWD cars require [differential.front], [differential.rear] and [differential.center].
[differential.rear]
final-drive = 4.100
anti-slip = 600.0
anti-slip-torque = 1
anti-slip-torque-deceleration-factor = 0
torque-split = 0.5
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. Torque split parameter determines the torque split ratio 0.0 to 1.0 between driven axes front and rear (left and right), 0.0 means all torque is applied to front (left).
[fuel-tank]
position = 0.0, -1.0, -0.26
capacity = 0.0492
volume = 0.0492
fuel-density = 730.0
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.
[camera.1]
name = driver # name to identify camera, default values are hood, driver, chase rigid, chase loose, orbit and free
type = mount # supported types are mount, chase, orbit, free
position = -0.023, -0.32, 0.50 # camera position relative to car
lookat = -0.023, 0.32, 0.3 # optional, defines camera view direction
stiffness = 0.0 # optional, bounce effect, 0.0 is a sports car and 1.0 is F1-ish.
fov = 90 # optional, overrides default field of view angle
VDrift supports an arbitrary number of cameras per car. The default minimum count is 6, camera.0 - camera.5.
[wing.rear]
position = 0.0, -2.14, 0.37
frontal-area = 0.05
drag-coefficient = 0.0
surface-area = 0.5
lift-coefficient = -0.7
efficiency = 0.95
Wing identifiers front, center, rear are arbitrary(can be chosen freely). A wing describes the aerodynamics(car body, front/rear wing) of the car. A car has to have at least one wing, to capture body drag. Most cars will use up to three. The frontal area and coefficient of drag, set with frontal-area and drag-coefficient, are used to calculate the drag force.
Downforce can be added with the optional parameters surface-area, lift-coefficient, efficiency. 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.fl]
texture = oem_wheel.png, oem_wheel-misc1.png
mesh = oem_wheel.joe # if genrim not set to false, mesh is used as wheel disk(spokes), rim will be auto-generated
#genrim = false # optional, disables auto-generated rim mesh
position = -0.736, 1.14, -0.47 #track front/rear 1471/1509
camber = 0.5
caster = 6.0
toe = -0.16
ackermann = 8.46 # 50% ackermann
steering = 30
The number of wheels is fixed to four: fl, fr, rl, rr. For a FWD car the wheels fl and fr are powered, for RWD the wheels rl and rr.
Wheel position, camber, toe are the values for the car at rest.
The wheel mesh is the wheel disk mesh(wheel mesh without rim). The mesh will be scaled according to tire dimensions, has to fit into a unit cube. The rim mesh is generated automatically.
Wheel alignment is set with the camber, caster, and toe. All angles are in degrees. For a "negative camber" the left wheel camber has to be negative, the right wheel camber positive.
Ackermann and steering are optional. Ackermann is the steering arm angle relative to wheel. Ideal ackermann(100%) is atan(0.5* track / wheelbase). For the right wheel positive ackermann is positive, for the left negative. Steering is the maximum steering angle of the wheel(for ackermann = 0). A negative steering leads to a reverted steering.
[wheel.fl.hinge]
wheel = -0.736, 1.14, -0.47
chassis = 0.0, 0.99, -0.55
Suspension has to be defined per wheel. Hinge suspension is equivalent to a parallel double wishbone setup. The hinge link is attached at chassis to car body and at wheel to wheel hub.
[wheel.fl.macpherson-strut]
strut-top = -0.66, 1.34, 0.05
strut-end = -0.70, 1.34, -0.505
hinge = -0.36, 1.34, -0.44
Alternatively a macpherson-strut setup can be used. Hinge is the lower link attachment point to car body. The wheel attachment point is the wheel hub position.
[wheel.fl.coilover]
spring-constant = 49131.9
bounce = 2600
rebound = 7900
travel = 0.19
anti-roll = 800.0
Each wheel has a coilover(spring-damper unit). The spring-constant is the wheel rate in N/m.
The bounce and rebound parameters are the damping coefficients for compression and expansion of the suspension, respectively, in units of N/m/s.
The travel is the wheel travel at rest position (spring compressed by car weight at rest). The extended wheel position and total travel is calculated from rest travel and spring stiffnes (total travel = travel + wheel load at rest / spring constant).
Anti-roll in N/m (currently associated with the wheel coilover) acts between front wheels fl and fr and rear wheels rl and rr.
[wheel.fl.tire]
texture = tire/touring.png # optional, enables auto-generated tire mesh
#mesh = tire.joe # optional, overrides auto-generated tire mesh
size = 215, 45, 17
type = tire/touring.tire
Tire size determines tire dimensions:
- section width in millimeters, measured from sidewall to sidewall
- ratio of sidewall height to section width in percent
- diameter of the wheel in inches
Each wheel has a tire section. Tire size is used to calculate wheel weight and inertia. The tire mesh is optional and has to be centered at origin and fit into a unit box. It will be scaled according to tire dimensions. If omitted a default mesh is generated/used.
Tire type is stored in a separate file relative to the car or carparts directory. More info about tire type definition can be found here: Tire parameters
[wheel.rl.brake]
texture = rotor_shiny_slotted_drilled.png # optional, enables auto-generated disk mesh
#mesh = rotor.joe # optional, overrides auto-generated brake disk mesh
friction = 0.6
max-pressure = 4.0e6
bias = 0.45
radius = 0.14
area = 0.015
handbrake = 1.0
The bias parameter is the fraction of braking pressure applied to the front brakes (in the front weight gain 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. Handbrake determines the handbrake influence factor. Texture is an optional brake rotor texture. If set a brake disk mesh is generated from brake parameters. This mesh can be overridden by providing a custom brake mesh.
[steering]
texture = steering_wheel.png
mesh = steering_wheel.joe
position = -0.37, 0.44, 0.09
rotation = 87.5, 0.0, 0.0
max-angle = 320
Steering defines the steering device. The rotation of the steering model is constrained by max-angle. The rotation axis is the local z-axis of the steering mesh.
[particle-00]
position = 0.0, -1.28, -0.36
mass = 30.0
Mass particles used for weight distribution and rotational inertia. Most cars will use 6-10 particles.
[body.hull]
00 = -0.50, 1.60, -0.20, 0.30
01 = 0.50, 1.60, -0.20, 0.30
02 = -0.50, -1.80, -0.20, 0.30
03 = 0.50, -1.80, -0.20, 0.30
04 = -0.40, -0.60, 0.15, 0.30
05 = 0.40, -0.60, 0.15, 0.30
[front.capsule]
center = 0.0, 1.60, -0.35
size = 1.3, 0.2, 0.2
[sides.box]
center = 0.0, 0.275, -0.3
size = 0.5, 4.0, 0.4
Collision shape is usually defined as a (swept sphere) hull. A sphere is defined by four values: position x, y, z and radius r. The number of hull spheres should be kept minimal for performance reasons.
Alternative shapes are capsule and box, defined by their position and size. A car can have multiple collision shapes (see F1-02).
[driver]
texture = driver2.png, driver-misc1.png
mesh = driver.joe
position = -0.37, 0.07, 0.05
mass = 90.0
[body]
texture = body00.png
mesh = body.joe
[interior]
texture = interior.png
mesh = interior.joe
[glass]
texture = glass.png
mesh = glass.joe
draw = transparent
The car shape can consist of an arbitrary number of models with arbitrary names excluding the reserved ones: engine, clutch, ...
Shape hierarchies [body.foo] are not supported.
[light-brake]
texture = brake.png
mesh = brake.joe
draw = emissive
[light-reverse]
texture = reverse.png
mesh = reverse.joe
draw = emissive
Car lights are treated as car shape models. light-brake is set emissive during braking, light-reverse if reverse gear is selected.
Category:Cars Category:Files