/ramses-logic

A scripting and animation runtime for the RAMSES rendering ecosystem

Primary LanguageC++Mozilla Public License 2.0MPL-2.0

Introduction

build status

RAMSES logic extends the RAMSES rendering ecosystem with scripting support based on Lua. RAMSES is designed to be minimalistic and closely aligned to OpenGL, which can be a limitation for more complex applications. RAMSES logic addresses this limitation by providing a runtime library which can load and run Lua scripts and provides a standard set of tools to let these scripts interact between each other and control a sophisticated RAMSES scene.

You can find the full documentation of RAMSES logic here.

Build

Clone RAMSES logic along with its dependencies:

git clone https://github.com/GENIVI/ramses-logic <path>
cd <path>
git submodule update --init --recursive

Configure and build with CMake (CMake 3.13 or newer required):

mkdir build && cd build
cmake -G"Visual Studio 16 2019" ../   # Or any other generator!
cmake --build .

You can find the compiler version of the examples in <path>/build/bin.

For more in-depth build instructions and customization options, have a look at the detailed build documentation.

Examples

Prefer to learn by example? Have a look at our self-contained example snippets.

License

The Ramses Logic Engine is licensed under the Mozilla Public License 2.0 (MPL-2.0), same as Ramses itself. Have a look at the Ramses README file for more information regarding Ramses and its dependencies.

In addition to Ramses, the Ramses Logic Engine has following dependencies, listed alongside their licenses here: * Lua (MIT) * Sol (MIT) * Flatbuffers (Apache-2.0) * Fmtlib (MIT) * Googletest (BSD-3-Clause) * Google Benchmark (Apache-2.0)

All of the above dependencies are referenced as Git submodules pointing to their original repository. Hence, no modifications are made by Ramses Logic.