hhy5277 / stuntrally Goto Github PK

------------------------------------------------------------------------------

    Stunt Rally - game based on VDrift and OGRE, with Track Editor
    Copyright (C) 2017  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 <http://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

Homepage:
        http://stuntrally.tuxfamily.org/

Releases:  (GNU/Linux binaries, Windows installer)
        https://sourceforge.net/projects/stuntrally/files/
Sources:
        https://github.com/stuntrally/

Forums:  (Report bugs, issues, etc):
        http://forum.freegamedev.net/viewforum.php?f=77

Screenshots:  (galleries from all versions)
        http://stuntrally.tuxfamily.org/gallery

Videos:  (gameplay and editor)
        http://www.youtube.com/user/TheCrystalHammer

------------------------------------------------------------------------------

    Description

The game features 172 tracks in 34 sceneries and 25 vehicles.
Game modes include: Single Race, Tutorials, Championships, Challenges,
Multiplayer and Split Screen. Also Replays and Ghost drive are present.

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

The game aims at a rally style of driving (like in Richard Burns Rally),
with possible stunt elements (jumps, loops, pipes)
and uses a 3D spline generated road.

For full features list check our Wiki:
http://stuntrally.tuxfamily.org/wiki/doku.php?id=features

------------------------------------------------------------------------------

    Hardware requirements

The minimum hardware is:
  CPU: with 2 cores, above 2.0GHz,
  GPU: GeForce 9600 GT or Radeon HD 3870,
with Shader Model 3.0 supported and 256 MB GPU RAM (512 on Higher).

A good GPU for smooth play on Higher preset is GTX 560 Ti (no effects).
Integrated GPUs or laptops don't handle the game well or at all.

------------------------------------------------------------------------------

    Running

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 restart.
Open Options tab Input, to see or reassign keys,
or configure a game controller.

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

    Feedback

Be sure you've read [Read before posting] topic first:
http://forum.freegamedev.net/viewtopic.php?f=78&t=3814

If that didn't help, report on
IRC: #stuntrally on freenode,
or create a topic on Forum [SR Bugs & Help].

    Editor

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

There isn't (and won't be) an undo function -
hit F5 to reload last track state, and F4 to save it (often).
After each save, track can be tested in game.

Editor Tutorial page with 14 videos (total 64 min):
http://stuntrally.tuxfamily.org/wiki/doku.php?id=editor

Have fun !

------------------------------------------------------------------------------

    Compiling

For newest sources and how to compile them check
project's Wiki page [Compiling]:
http://stuntrally.tuxfamily.org/wiki/doku.php?id=compile

------------------------------------------------------------------------------

    Help is welcomed

Track creators
    If you manage to create an interesting track,
    it could be released in future versions.

Translators
    If you want to help translating a language,
    check Wiki page [Localization].

Testers
    If you are able to build from sources,
    you can test and report bugs or suggestions.

Programmers
    If you know C++, OGRE or shaders, and could
    handle any of the [Roadmap] tasks.

Artists
    Editing meshes for game, uv unwrap, texturing etc.
    If you can record/edit sounds for games.