Mirrors/openrw
1
0
Fork 0
mirror of https://github.com/rwengine/openrw.git synced 2024-11-23 02:42:39 +01:00
Code Issues Projects Releases Activity
Mirror of (now archived): https://github.com/rwengine/openrw
620 Commits 1 Branch 0 Tags 6.9 MiB
C++ 72.1%
C 23.5%
CMake 3.2%
Python 1%
Shell 0.1%
Other 0.1%
fe61c1a9f4
Go to file
Daniel Evans fe61c1a9f4 Move include inside debug section
2016-05-20 02:10:11 +01:00
benchmarks First benchmark: Staunton 2016-04-18 02:33:13 +01:00
cmake/modules CMake: FindSFML+FindMAD, set library paths as SYSTEM, remove dead stuff. 2016-05-19 22:30:06 +01:00
rwengine Make OpenGLRenderer use correct preprocessor check for profiler 2016-05-20 01:40:11 +02:00
rwgame CMake: FindSFML+FindMAD, set library paths as SYSTEM, remove dead stuff. 2016-05-19 22:30:06 +01:00
rwlib Move include inside debug section 2016-05-20 02:10:11 +01:00
rwviewer CMake: FindSFML+FindMAD, set library paths as SYSTEM, remove dead stuff. 2016-05-19 22:30:06 +01:00
scripttool Move first of lower level code into rwlib; tear out GLEW. 2016-04-07 01:13:46 +01:00
tests CMake: FindSFML+FindMAD, set library paths as SYSTEM, remove dead stuff. 2016-05-19 22:30:06 +01:00
.gitignore Update .gitignore 2014-12-10 18:08:25 +00:00
CMakeLists.txt CMake: FindSFML+FindMAD, set library paths as SYSTEM, remove dead stuff. 2016-05-19 22:30:06 +01:00
COPYING Add Readme and Copying files 2014-02-13 09:51:42 +00:00
Doxyfile Initial documentation pass 2014-07-09 05:04:48 +01:00
README.md CMake: FindSFML+FindMAD, set library paths as SYSTEM, remove dead stuff. 2016-05-19 22:30:06 +01:00

README.md

OpenRW

OpenRW is an open source re-implementation of Rockstar Games' Grand Theft Auto III, a classic 3D action game first published in 2001.

OpenRW requires a legitimate copy of the original PC game data in order to run. Without this data it will not be possible to run openrw.

Building

Dependencies:

  • Bullet
  • GLM (0.9.5+)
  • SFML (2.0+)
  • libmad
  • Boost Test

Global Options:

  • BUILD_TESTS — Build the test suite
  • BUILD_VIEWER - Build the Qt GUI for viewing data
  • BUILD_SCRIPT_TOOL - Build the script dissassembler

Recomended build

$ mkdir build
$ cd build
$ cmake ../ -DCMAKE_BUILD_TYPE=Release

Running

Once compiled, set the environment variable OPENRW_GAME_PATH to the directory containing "gta3.exe" and run the rwgame executable.

rwgame

This is the game binary

  • Options:
    • env: OPENRW_GAME_PATH, must be set to the folder containing "gta3.exe"
    • -w n, -h n sets initial window size
    • --newgame starts a new game automatically

rwviewer

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.

Documentation

Run Doxygen on the included Doxyfile to generate documentation.

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/.

Third Party Licenses

MAD is licensed under the GNU General Public License

SFML is licensed under the zlib license

Bullet Physics is licensed under the zlib license