2014-06-18 18:14:45 +02:00
|
|
|
|
# OpenRW
|
|
|
|
|
|
|
2014-06-18 18:32:43 +02:00
|
|
|
|
A project to re-implement gta3.exe, adding support for more platforms and fixing all of the bugs that have piled up.
|
|
|
|
|
|
|
|
|
|
|
|
**REQURIES A LEGITAMATE COPY OF GTA III PC TO RUN**, this project only functions with the original game's data.
|
|
|
|
|
|
|
2014-06-18 18:14:45 +02:00
|
|
|
|
## Building
|
|
|
|
|
|
|
|
|
|
|
|
Dependencies:
|
|
|
|
|
|
|
|
|
|
|
|
* Bullet
|
|
|
|
|
|
* GLM (0.9.5+)
|
|
|
|
|
|
* SFML (2.0+)
|
2014-08-05 01:32:11 +02:00
|
|
|
|
* Boost Test
|
2014-06-18 18:14:45 +02:00
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
|
|
|
|
|
|
|
* BUILD\_OLD\_TOOLS – Builds old, unmaintained tools (datadump & analyzer)
|
|
|
|
|
|
|
|
|
|
|
|
## Running
|
|
|
|
|
|
|
|
|
|
|
|
### rwgame
|
|
|
|
|
|
|
|
|
|
|
|
Implementation of the game itself.
|
|
|
|
|
|
|
|
|
|
|
|
* Options:
|
|
|
|
|
|
* env: OPENRW\_GAME\_PATH, must be set to the folder containing "gta3.exe"
|
|
|
|
|
|
* -w **n**, -h **n** sets initial window size
|
|
|
|
|
|
|
|
|
|
|
|
### rwviewer
|
|
|
|
|
|
|
|
|
|
|
|
File viewer for game data, open the folder containing "gta3.exe" and it will load the data.
|
|
|
|
|
|
|
|
|
|
|
|
Currently only supports viewing instance data, pending some rewriting.
|
|
|
|
|
|
|
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
|
|
|
|
## Things to do
|
|
|
|
|
|
|
|
|
|
|
|
* Make it work on Windows (shouldn't be too difficult for anyone with CMake and C++ experience)
|
|
|
|
|
|
* Write FindSFML and FindGLM scripts for cmake.
|
|
|
|
|
|
* Improve the vehicle dynamics
|
|
|
|
|
|
* Add more views to rwviewer
|
|
|
|
|
|
* Handling data
|
|
|
|
|
|
* Collision data
|
|
|
|
|
|
* Animation scrubbing
|
2014-06-26 18:55:17 +02:00
|
|
|
|
* Improve file loading
|
|
|
|
|
|
* One-off loaders should be moved out of GameData into some DATLoader or something.
|
|
|
|
|
|
* Some error mechanism that allows for useful error messages.
|
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
|
