2014-06-18 18:14:45 +02:00
# OpenRW
2016-05-19 23:28:12 +02:00
OpenRW is an open source re-implementation of Rockstar Games' Grand Theft Auto III,
a classic 3D action game first published in 2001.
2014-06-18 18:32:43 +02:00
2016-05-23 19:50:28 +02:00
* IRC: #openrw @ chat.freenode.net
Check out the [FAQ ](https://github.com/rwengine/openrw/wiki/FAQ ) and the rest of the [wiki ](https://github.com/rwengine/openrw/wiki ). Report any bugs by creating an [issue ](https://github.com/rwengine/openrw/issues ).
2016-05-19 23:28:12 +02:00
OpenRW requires a legitimate copy of the original PC game data in order to run.
2016-05-23 19:50:28 +02:00
Without this data it will not be possible to run OpenRW.
2014-06-18 18:32:43 +02:00
2014-06-18 18:14:45 +02:00
## Building
Dependencies:
* Bullet
2016-05-22 15:12:30 +02:00
* GLM (0.9.7+)
2014-06-18 18:14:45 +02:00
* SFML (2.0+)
2016-05-19 23:28:12 +02:00
* libmad
2014-08-05 01:32:11 +02:00
* Boost Test
2014-06-18 18:14:45 +02:00
2016-05-23 19:43:59 +02:00
Mac users should install Xcode and those packages from Homebrew:
brew install boost bullet glm mad sfml
2015-05-11 00:57:13 +02:00
Global Options:
2014-06-18 18:14:45 +02:00
2016-05-19 23:28:12 +02:00
* BUILD_TESTS — Build the test suite
* BUILD_VIEWER - Build the Qt GUI for viewing data
* BUILD_SCRIPT_TOOL - Build the script dissassembler
2014-06-18 18:14:45 +02:00
2015-03-30 01:59:22 +02:00
### Recomended build
```
$ mkdir build
$ cd build
2016-05-19 23:28:12 +02:00
$ cmake ../ -DCMAKE_BUILD_TYPE=Release
2015-03-30 01:59:22 +02:00
```
2014-06-18 18:14:45 +02:00
## Running
2015-03-30 01:59:22 +02:00
### rwgame
2014-06-18 18:14:45 +02:00
2016-05-20 03:09:22 +02:00
This is the game binary. Before running the game a config file is needed, by default
the game will look for ``~/.config/OpenRW/openrw.ini``, which should look like:
```
[game]
path=/opt/games/Grand Theft Auto 3/ ; Game data path
2016-05-22 16:58:36 +02:00
[input]
invert_y=0 ; Invert camera Y
2016-05-20 03:09:22 +02:00
```
Eventually the game will write this for you, but currently it must be done by
hand.
2015-05-11 00:57:13 +02:00
2014-06-18 18:14:45 +02:00
* Options:
* -w **n** , -h **n** sets initial window size
2015-05-11 00:57:13 +02:00
* --newgame starts a new game automatically
2016-05-21 16:17:57 +02:00
* Controls:
* W/A/S/D: Move
* Shift: Sprint
* Space: Jump
* F: Enter/Exit Vehicle
* Mouse Wheel: Cycle weapons
* Mouse 1: Fire Weapon
2014-06-18 18:14:45 +02:00
### rwviewer
2016-05-19 23:28:12 +02:00
This is a Qt tool for opening the game data. It currently supports looking at
objects and their models, and a primitive world viewer. It needs more work to
be useful for looking inside archives and viewing textures.
2014-06-18 18:14:45 +02:00
2014-07-09 06:04:48 +02:00
## Documentation
Run Doxygen on the included Doxyfile to generate documentation.
2014-06-18 18:14:45 +02:00
## License
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 / > .
2014-08-05 00:51:35 +02:00
### Third Party Licenses
MAD is licensed under the GNU General Public License
* http://www.underbit.com/products/mad/
SFML is licensed under the zlib license
* http://www.sfml-dev.org/license.php
Bullet Physics is licensed under the zlib license
* http://bulletphysics.org/mediawiki-1.5.8/index.php/LICENSE