passdedd / ramses-logic

A scripting and animation runtime for the RAMSES rendering ecosystem

Introduction

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

You can find the compiled 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.

Version matrix

Logic	Included Ramses version	Minimum required Ramses version	Binary file compatibility
0.12.0	27.0.113	same as 0.6.0	0.9.x
0.11.0	27.0.113	same as 0.6.0	0.9.x
0.10.2	27.0.112	same as 0.6.0	0.9.x
0.10.1	27.0.111	same as 0.6.0	0.9.x
0.10.0	27.0.111	same as 0.6.0	0.9.x
0.9.1	27.0.111	same as 0.6.0	0.9.x
0.9.0	27.0.110	same as 0.6.0	0.9.x
0.8.1	27.0.110	same as 0.6.0	0.7.x or 0.8.x
0.8.0	27.0.110	same as 0.6.0	0.7.x or 0.8.x
0.7.0	27.0.105	same as 0.6.0	0.7.x
0.6.2	27.0.105	same as 0.6.0	0.6.x
0.6.1	27.0.103 (includes 27.0.11)	same as 0.6.0	0.6.x
0.6.0	27.0.102 (includes 27.0.10)	27.0.100	0.6.x
0.5.3	27.0.101	27.0.100	0.5.x

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.