mirror of
https://github.com/rwengine/openrw.git
synced 2024-09-03 00:59:47 +02:00
Update readme
This commit is contained in:
parent
4d228e40c7
commit
4e20c66bc7
55
README.markdown
Normal file
55
README.markdown
Normal file
@ -0,0 +1,55 @@
|
|||||||
|
# OpenRW
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
Dependencies:
|
||||||
|
|
||||||
|
* Bullet
|
||||||
|
* GLM (0.9.5+)
|
||||||
|
* SFML (2.0+)
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
## 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/>.
|
||||||
|
|
15
README.md
15
README.md
@ -1,15 +0,0 @@
|
|||||||
# OpenRW
|
|
||||||
|
|
||||||
|
|
||||||
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/>.
|
|
Loading…
Reference in New Issue
Block a user