Skip to content

The main repository containing Stunt Rally sources and game data. A 3D racing game based on VDrift and OGRE with track editor.

License

Notifications You must be signed in to change notification settings

xvrc/stuntrally

 
 

Repository files navigation

Stunt Rally - 3D racing game, based on VDrift and OGRE, with Track Editor
Copyright (C) 2010-2022  Crystal Hammer and contributors

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see https://www.gnu.org/licenses/

The license GNU GPL 3.0 applies only to code written by us.
Which is in source dir, subdirs: editor, network, ogre and road.
Libraries used have their own licenses.
For data licenses look in various .txt files in data subdirs.

Links

Stunt Rally Homepage - Download links, Documentation wiki, track & vehicle browsers etc.
Forums - Discussions, tracks, Issues, etc.
Sources - also for bugs & Issues, pull requests, etc.
Screenshots - Galleries from all versions and development
Videos - from game and editor
Donations - financial support


Description

Stunt Rally features 182 tracks in 35 sceneries and 24 vehicles.
Game modes include:

  • Single Race (with Ghost drive, track guide, or Replays),
  • Challenges, Championships, Tutorials,
  • Multiplayer (no official server) and Split Screen.

The Track Editor allows creating and modifying tracks.
Both run on GNU/Linux and Windows.

The game has a rally style of driving, mostly on gravel (like Richard Burns Rally),
with possible stunt elements (jumps, loops, pipes) and generated roads from 3D spline.
It also features few Sci-Fi vehicles and planets.

Full features list on our Wiki. Page about Multiplayer here.


Hardware requirements

The recommended minimum hardware is:

  • CPU: with 2 cores, above 2.4GHz,
  • GPU: dedicated, low budget (e.g. GeForce GTX 560 Ti, Radeon RX 570),
    with Shader Model 3.0 supported and 1GB GPU RAM.

Integrated GPUs and old laptops don't handle the game well or at all.


Game

Localized help for new users, is on the Welcome screen, shown at game start.
Or press Ctrl-F1 to show it. It also has game related Hints.

In game - Esc/Tab key shows/hides GUI.

At first, open Options to adjust Screen resolution, pick graphics preset according to your GPU and do restart.
Open Options tab Input, to see or reassign keys, or configure a game controller. Info on wiki here.

Have fun 😀

Troubleshooting

If you have problems running, read Wiki page Running.
All settings and logs are saved to user folder, see Paths.


Editor

In editor - F1 (or tilde) key shows/hides GUI,
Tab key switches between Camera and Edit modes.
Press Ctrl-F1 to read what can be edited and how.

There is no undo, so use F5 to reload last track state, and F4 to save it (often).
After each save, track can be tested in game.

Tutorial

Editor Tutorial page with more info and videos here


Feedback

Before reporting bugs or issues, be sure to Read before posting topic first ;)

Then create a topic on Forum SR Bugs & Help
or a new issue on github (if not present).

IRC is not used now: #stuntrally on freenode.


Building from sources

For newest sources and how to compile them see page Compiling.


Contributing

If you'd like to contribute, please check Contributing.md

About

The main repository containing Stunt Rally sources and game data. A 3D racing game based on VDrift and OGRE with track editor.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C++ 86.7%
  • C 6.9%
  • CMake 2.5%
  • GLSL 1.4%
  • ShaderLab 1.3%
  • HLSL 1.1%
  • Other 0.1%