mirror of https://github.com/imaginaryPineapple/OpenRayman.git synced 2024-10-19 14:37:36 -04:00

An open source reimplementation of the Rayman 2: The Great Escape engine using C++11 and modern OpenGL.

Go to file

Hannes Mann 26c6e69844 Add a folder for future documentation		2016-06-16 03:37:28 +02:00
data	Add rebindable keyboard keys	2016-06-15 18:16:25 +02:00
docs	Add a folder for future documentation	2016-06-16 03:37:28 +02:00
game_demos	Add game demos based on Rayman 2 engine for research	2016-06-12 05:20:13 +02:00
lib	Switch from GLFW to SDL2	2016-06-15 05:06:21 +02:00
src	Fix windows support	2016-06-16 00:56:11 +02:00
win32	Fix windows support	2016-06-16 00:56:11 +02:00
.gitignore	Fix windows support	2016-06-16 00:56:11 +02:00
.gitmodules	Switch from GLFW to SDL2	2016-06-15 05:06:21 +02:00
CMakeLists.txt	Switch from GLFW to SDL2	2016-06-15 05:06:21 +02:00
LICENSE.md	GPLv3	2016-06-11 02:39:56 +02:00
README.md	Add a game class for mod support	2016-06-15 03:55:52 +02:00

README.md

OpenRayman

An open source reimplementation of the Rayman 2: The Great Escape engine using C++11 and modern OpenGL.

Usage

openrayman [options] ...

OpenRayman needs the base game rayman2 to run.

rayman2 can be created by using the command line option --extract-data "folder". The folder variable should point to a valid Rayman 2: The Great Escape installation.

rayman2 will be copied into the OpenRayman data folder (in data/games). This is all that needs to be done to run OpenRayman.

Do note that OpenRayman contains some extensions to the Rayman 2: The Great Escape game, such as more menu options.

If you for some reason wish to run without these modifications then you will either need to edit the config.json file and change the game variable from rayman2_openrayman to rayman2, or by specifying the game to run via the command line option --game rayman2.

You should always target rayman2_openrayman when making a mod.

GL3W

You need to build gl3w.h and gl3w.c before you build the project.

This can be done by executing lib/gl3w/gl3w_gen.py with Python 2.

Building on Linux

CMake should be used to generate makefiles, and make 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.

Additionally, a .desktop file will be created.

Building on Windows

Building should be done with MinGW, and is almost the same as on Linux.

You need to use the command cmake -G "MinGW Makefiles" .. instead of cmake .. to create makefiles, as OpenRayman cannot be built with MSVC.

You might also need mingw32-make -j8 instead of make -j8.

Building on Mac OS X

Mac OS X is not supported at the moment (might work with CMake?).