OpenRayman/README.md

49 lines
731 B
Markdown
Raw Normal View History

2016-06-10 20:35:24 -04:00
# OpenRayman
An open source reimplementation of the Rayman 2: The Great Escape engine using C++11 and modern OpenGL.
2016-06-11 12:22:42 -04:00
## Usage
2016-06-10 20:35:24 -04:00
2016-06-10 21:20:54 -04:00
`openrayman [options] ...`
2016-06-10 21:12:15 -04:00
2016-06-10 20:35:24 -04:00
2016-06-11 12:22:42 -04:00
## Building on Linux
2016-06-10 20:35:24 -04:00
CMake should be used to build the engine.
```
mkdir build
cd build
cmake ..
make -j8
```
The engine can be installed via `sudo make install` and can then be started by executing the command `openrayman`, and additionally, a .desktop file will be created.
2016-06-11 12:22:42 -04:00
## Building on Windows
2016-06-10 20:35:24 -04:00
Open `msvc\OpenRayman\OpenRayman.sln` and build the desired target.
2016-06-11 12:22:42 -04:00
## Building on Mac OS X
2016-06-10 20:35:24 -04:00
Mac OS X is not supported at the moment (might work with CMake?).
2016-06-11 12:22:42 -04:00
## Thanks to
2016-06-10 20:35:24 -04:00
2016-06-11 12:22:42 -04:00
* Ubisoft and Michael Ancel
2016-06-11 16:44:50 -04:00
* GLFW 3
* libepoxy
* lodepng
2016-06-11 12:22:42 -04:00
* http://raymanpc.com/