Skip to content

Latest commit

 

History

History
190 lines (123 loc) · 8.13 KB

Running.md

File metadata and controls

190 lines (123 loc) · 8.13 KB

How to start the game, configure controller, settings etc.

Hardware requirements

The recommended minimum hardware is, at least:

  • CPU: 2 cores, 2.4 GHz
  • GPU: dedicated, with 2GB VRAM (GPU RAM) and Open GL 4 supported:
    • Low budget (e.g. Radeon RX 570, GeForce GTX 970, GeForce RTX 3050)
    • or High (e.g. Radeon RX 6600 XT, GeForce RTX 3070) etc.
    • Link to GPU benchmark for comparing.
  • RAM: 4GB
  • Disk space: 4GB

Integrated GPUs and old laptops don't handle the game well or at all.
In any case, if you get graphic errors, try updating your graphic driver, and making sure game uses dedicated GPU.

Old or slow CPUs could make the game not handle simulation correctly and slow down.
Too low GPUs (benchmark score or cores count) will slower rendering,
to less than ideal 60 Fps (from display VSync), especially on big, complex, demanding tracks.

The game is developed and tested only on a PC with Radeon RX 6600 XT.
Using default settings (Higher), it achieved around 60 Fps on all tracks (bit less in dense jungle places etc).

It is possible to run some tracks (Test* should) on lower hardware, but with low Fps (could be unplayable, below 30).

Pressing F11 will cycle Fps bar (see Tweak page for more info).
In game F9 shows (default) time Graph of Fps.

Running

  • Esc/Tab key shows/hides GUI (F1 or ` in Editor).
  • Ogre dialog (before start) has screen resolution, VSync, antialiasing etc.
  • In Options, on Screen tab, pick Graphics preset according to your GPU.
  • Quit game/editor to save settings and start again.
  • Press 🏁 New Game button to start driving.
  • For new users, you can enter How to play to watch few lessons, and read Hints there.
  • Help page in game has Quick help and other pages (this Readme, Contributing, and all gathered Credits).
  • Have Fun 😀

Input

Keys used in game can be seen in Options on tab Input. Also quickly on Welcome screen (Ctr-F1).

If you want to reassign keys, or have a game controller 🎮 go to tab Player1 (or other) to bind it and test range.

For keyboard input, there is a sensitivity setting. You can change it for each control, or pick for all from combo (preset).
There are also speed sensitive steering and steering range settings on Setup tab in Single Race window.

By default, in game you can change cameras 🎥 with C/X (with shift for main cameras only).
Cameras can be adjusted in game, by mouse - move mouse to see actions.

Controllers

Click button to start binding, then move axis or press button or key to bind it.
Click on Edit > to change Inverse for a control (for analog axis).
Press RMB (right mouse) on button to unbind.

Check your axes range on those bars displayed.
If moving an axis from start to end also moves the bar from left to right completely
(and without moving over the range) then configuration is done properly.

Binding both controller axis and keyboard keys is possible.
To check if your device was detected search for <Joystick> in ogre.log

After your configuration is complete you can restart game to have the settings saved.

You may want to backup your input_p0.xml (for Player1) in user settings dir (see Paths page) or create presets this way.


Graphics Options

Using preset combobox (which changes all settings) should be enough. Remember to quit and restart after change.

You may want to change some options individually.
Many have marks at end (** * ^ # etc) see legend for meaning (right, bottom on Gui).
Those without marks are updated instantly. Some, like Vegetation can be updated with button.

There are few Graphics options that are more important and have more impact on performance than the rest.
Generally first tabs have higher impact on Fps: Reflection, Water, Shadows.

Fps - Frames per second. The first value shown in upper left corner of the screen.
Higher values mean smoother play. It is recommended to play with at least 30 Fps or to aim at monitor's refresh rate.

  • Reflections and Water - very demanding, lowering Fps.
    Size (of textures for them) is important. Also frame skip and faces at once for dynamic cube reflections can help.

  • Shadows - quite demanding too. If you have very low Fps turn them off (None).
    Could do same for split screen, since Fps drops with each new player viewport.
    Increasing Size and Filter will make them better quality.
    Shadows do need restart to change (Todo fix).

  • Vegetation - Reduce Trees and Grass multipliers for more Fps.
    For newer GPUs you can set them higher to have denser vegetation.

  • Materials - If you have an old GPU, you should lower Anisotropy (0-16, 4 is enough).
    Turning off Triplanar can reduce Fps much, especially on demanding tracks (big and with high mountains).

  • Detail - has options for geometry Level Of Detail.
    Reducing it will decrease drawn triangles count and make geometry less smooth.

For minimum settings just pick Lowest from preset combobox and restart.
For values suggested, check other Graphics options on Gui, or in sources for that.

Configs

All settings are saved in game.cfg file or in editor.cfg.

For help on how to locate these files, see Paths page.

Deleting this file(s) will force using default settings at next start of game or editor.

If problems occur check ogre.log for errors (or ogre_ed.log for editor).

Feedback

If you have problems running, and suspect a bug, see Troubleshooting.
Testing and reporting bugs is welcome.
Especially if you can build the game from Sources.


Console Tools

Game and editor have few console tools that can be started on various occasions.
Tool output will be as text in terminal and in .log file (Ogre.log or Ogre_ed.log).
The first line is always ))) Tool start.

How to

To get more text info about available tools:

  1. First start console (cmd.exe on Windows or any terminal app for Linux like Konsole, Console, Terminal, XTerm etc).

    So e.g. on Windows enter Start Menu (or by keys Logo + R) and type cmd, press to run it.
    More help e.g. here or for Debian e.g. here.

    If you're using DoubleCmd you can just press F9 to Run Terminal from inside folder where SR3 binaries are.

  2. Then change path to your SR3 binaries

  3. Start editor or game exe with ? in command line argument for all available.

Example

Example output for editor tools:

SR3-Editor  command line Arguments help  ----
  ? or help - Displays this info
  
  c or cfg - force show Ogre config dialog
  
Results in Ogre1.log or console, lines with )))
  
  sc or scene - Runs scene.xml checks for all tracks.
  old or sc2 - Runs scene.xml checks for all tracks skies use, old tree meshes, etc.
  warn or warnings - Runs warnings checks for all tracks.

and for game tools:

StuntRally3  command line Arguments help  ----
  ? or help - Displays this info
  
  c or cfg - force show Ogre config dialog
  
Results in Ogre1.log or console, lines with )))
  
  check - Does a check for tracks.ini, championships.xml, challenges.xml, missing track ghosts, etc.
  
  convert - For new tracks. Convert ghosts to track's ghosts (less size and frames)
     Put original ghosts into  data/ghosts/original/*_ES.rpl
     ES car, normal sim, 1st lap, no boost, use rewind type: Go back time
     Time should be like in tracks.ini or less (last T= )
  
  ghosts - Test all vehicles points on all tracks, from all user ghosts. Needs many.
  trkghosts - Test all tracks ghosts, for sudden jumps, due to bad rewinds.

Shortcuts

E.g. starting StuntRally3 convert (on Windows) will convert ghosts to track ghosts,
or SR3-Editor scene will do all tracks scene.xml checks.

You can also make a .bat or .sh file with shortcuts for these tools.
E.g. ./sr-editor3 scene >ed-scn.txt (on Linux) can also redirect output to txt file in same folder.