Mirrors/openrw
1
0
Fork 0
mirror of https://github.com/rwengine/openrw.git synced 2024-11-25 20:02:40 +01:00
Code Issues Projects Releases Activity
Mirror of (now archived): https://github.com/rwengine/openrw
529 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%
8b18712d1f
Go to file
Daniel Evans 8b18712d1f Merge branch 'rwng-disassembly' into rwng 
Conflicts:
	rwgame/RWGame.hpp
	rwgame/ingamestate.cpp
2015-05-03 23:31:45 +01:00
analyzer Fix compiler errors and test problems 2014-05-25 22:30:50 +01:00
datadump Fix compiler errors and test problems 2014-05-25 22:30:50 +01:00
rwengine Merge branch 'rwng-disassembly' into rwng 2015-05-03 23:31:45 +01:00
rwgame Merge branch 'rwng-disassembly' into rwng 2015-05-03 23:31:45 +01:00
rwviewer Move GameState out of GameWorld ownership 2015-04-27 03:55:18 +01:00
scripttool Implement Script Disassembly 2015-05-03 18:09:25 +01:00
tests Implement Game Object ID allocation 2015-04-29 21:03:53 +01:00
.gitignore Update .gitignore 2014-12-10 18:08:25 +00:00
CMakeLists.txt Add Improved Profiling statistics 2015-04-12 19:47:47 +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 Update Readme and CMakeLists with options 2015-04-03 03:07:08 +01:00

README.md

OpenRW

This is an attempt at re-implementing the GTA III game binary, adding support for more platforms and input methods, while fixing some issues that plauge the original release.

REQURIES A COPY OF GTA III PC. Without an original copy of the game, it will not be possible to run openrw.

Building

Dependencies:

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

Options:

  • BUILD_TESTS — Builds the test suite
  • BUILD_TOOLS — Builds the rwviewer application
  • BUILD_OLD_TOOLS – Builds old, unmaintained tools (datadump & analyzer)

Recomended build

$ mkdir build
$ cd build
$ cmake ../

Running

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

rwgame

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

rwviewer

Intended to be a tool for viewing the various game data types, such as objects and models. Currently awaiting refactoring.

Documentation

Run Doxygen on the included Doxyfile to generate documentation.

Things to do

  • Finish rwng reorganisation
    • Split basic functionality from rwengine into core library.
    • Clean up more of GameObject's member variables.
    • Implement script debugging.
    • Fix rwviewer for new paradigm.
  • Fix water rendering artefacts.

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