Skip to content

Commit

Permalink
fix docs images
Browse files Browse the repository at this point in the history
  • Loading branch information
cryham committed Jun 19, 2024
1 parent f3a564f commit 3659cdf
Show file tree
Hide file tree
Showing 14 changed files with 28 additions and 13 deletions.
25 changes: 17 additions & 8 deletions docs/Tweak.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ _Various tools and visualizations to tweak game._


## Tools list

This Wiki describes most tools available in game (found on Tweak tab).
How to use them and what are they for.
Mainly they are helpful in visualizing the result of edited .car sections.
Expand All @@ -22,9 +23,11 @@ They are listed here for quick guide:


#### Common

In game and editor.

### Fps bar

Cycle Fps bar mode with F11.

This small left top bar shows values (that change, especially when moving), in default mode:
Expand All @@ -36,6 +39,7 @@ This small left top bar shows values (that change, especially when moving), in d
This is better explained on Gui for each mode.

### Wireframe

Toggle 🌐 wireframe mode with F10.
It is useful to check how dense are triangles in car/wheel model (or also for whole track).

Expand All @@ -44,15 +48,16 @@ It is useful to check how dense are triangles in car/wheel model (or also for wh


### Bullet Debug Lines

This is useful to check and adjust the shape of car body that collides.
To use bullet lines first check the global (Startup) option, and restart game.

{{http://stuntrally.tuxfamily.org/uploads/images/wiki/1.jpg}}
![](images/1.jpg)


If game was started with it enabled, you can toggle bullet debug lines with Ctrl-F10 or the next checkbox.

{{http://stuntrally.tuxfamily.org/uploads/images/wiki/2.jpg}}
![](images/2.jpg)

If you just need to edit car collision, don't use official tracks.
_They have a lot of vegetation and it will be horribly slow to draw all lines (and this stays until you quit and restart game)._
Expand Down Expand Up @@ -85,6 +90,7 @@ See the top of this file for more info (e.g. how to disable collision or use ful


### Car file Editor

Editing car settings (.car file) is done in game.
```
Alt-Z - toggles car editor in game.
Expand All @@ -102,6 +108,7 @@ where mode is current simulation mode (easy or normal).


### Graphs

Graphs in game can be used to test more advanced car behaviour and simulation.

Press F9 to show/hide, F2,F3 will cycle through various graph types. Or use Gui to pick from combo.
Expand All @@ -112,13 +119,14 @@ Those are explained more in [VehicleEditing](VehicleEditing.md).


### Car debug Text

This was the first simulation visualisation and it is still useful if you want to check the values (if they don't change too fast).

Use this checkbox to toggle it or Shift-F9.

On Gui you can also change how many text sections are displayed and change text color to black or white.

{{http://stuntrally.tuxfamily.org/uploads/images/wiki/3.jpg}}
![](images/3.jpg)


### Performance test
Expand All @@ -139,7 +147,7 @@ Most of those stats are then shown in info panel on Gui when when picking car in

_Run it for each sim mode (provided you made it different as game requires). See bottom of page for differences list._

{{http://stuntrally.tuxfamily.org/uploads/images/wiki/4.jpg}}
![](images/4.jpg)



Expand All @@ -148,16 +156,17 @@ _Run it for each sim mode (provided you made it different as game requires). See

### Surfaces

{{http://stuntrally.tuxfamily.org/uploads/images/wiki/12.jpg}}
![](images/12.jpg)


### Tires
{{http://stuntrally.tuxfamily.org/uploads/images/wiki/10.jpg}}

{{http://stuntrally.tuxfamily.org/uploads/images/wiki/11.jpg}}
![](images/10.jpg)

![](images/11.jpg)

Tire editing is meant only for people with good knowledge of simulation, who know Pacejka Magic Formula.

It can be very time consuming/wasting, and produce no better results.

Other and simpler parameters are in surfaces.cfg.
Other and simpler parameters are in surfaces.cfg.
16 changes: 11 additions & 5 deletions docs/VehicleEditing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@ _Todo:_ Renew screenshots {{..


#### Introduction ####

This Wiki describes the .car file format (car settings), car parameters inside of it and what editing them does.

You can either use this when tweaking existing cars or if you modeled a car,
use it to put car in game properly with physics _(or you can also leave this part for CryHam, he knows it best 😉 )._


#### Editing .car file ####

This part explains .car file sections, adjusting those car parameters and fitting model.

Stunt Rally .car file is based on VDrift .car file from older version (April 2010).
Expand All @@ -19,6 +21,7 @@ _For reference base, you can read [VDrift wiki](http://wiki.vdrift.net/index.php


### Location ###

Since we have simulation modes (currently 2: easy and normal) there are 2 .car files (1 for each mode).

data/carsim/easy/cars/3S/3S.car
Expand Down Expand Up @@ -292,7 +295,7 @@ exhaust-mirror-second = 1

There is a visualisation for body collision in game (bullet debug, use it when editing).

{{http:_stuntrally.tuxfamily.org/uploads/images/wiki/5.jpg}}
![](images/5.jpg)

Editing collison H params is quite tricky since most of them are relative to some other values (and may depend on something else).

Expand Down Expand Up @@ -367,9 +370,10 @@ friction = 230


## Section t, - torque curve ##

Graph used to visualize the curves (engine torque and power from rpm):

{{http:_stuntrally.tuxfamily.org/uploads/images/wiki/6.jpg}}
![](images/6.jpg)

* _torque-val-mul_ - is the global multiplier (scales all points torque values) and can quickly change car's engine power

Expand Down Expand Up @@ -410,7 +414,7 @@ max-torque-mul = 1.1

Useful graph for visualising all gear ratios with torque curve from car speed.

{{http:_stuntrally.tuxfamily.org/uploads/images/wiki/7.jpg}}
![](images/7.jpg)

It also shows at which rpm will gears auto shift (rpmLow) and until which speed will gear work (velMax).

Expand Down Expand Up @@ -485,7 +489,7 @@ torque-dec - anti-slip-torque-deceleration-factor

There is a graph visualising current suspension positions for all wheels and next for suspension move velocities.

{{http:_stuntrally.tuxfamily.org/uploads/images/wiki/8.jpg}}
![](images/8.jpg)

* _spring-constant_ - is the wheel rate (in N/m).

Expand Down Expand Up @@ -558,7 +562,8 @@ handbrake = 4.8


### Aerodynamics ###
{{http:_stuntrally.tuxfamily.org/uploads/images/wiki/9.jpg}}

![](images/9.jpg)

Aerodynamics is quite important and determines car path when flying after jump and car handling at higher speeds (downforce), since tire forces depend on down force it should make car "stick" more to ground when driving faster.

Expand Down Expand Up @@ -604,6 +609,7 @@ efficiency = 0.92


### Hood camera ###

Probably last thing to adjust is the position of driver and hood cameras (which are specific to each car):

When changing those: switch to that camera, adjust it's position (LMB, RMB, ..) and pick those values from camera info text.
Expand Down
Binary file added docs/images/1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/10.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/11.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/12.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/3.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/4.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/5.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/6.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/7.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/8.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/9.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3659cdf

Please sign in to comment.