This repository contains the documentation for Ramses Composer, the authoring tool for the open source RAMSES rendering ecosystem.
These tutorials explain the basic features of the Composer, how to import, manage, modify and export your data.
Introduction - What exactly is this Ramses Composer good for?
First basic project - A simple cube.
A more interesting project - A monkey head with flat shading.
Data and scope - Details on object types, data and scope.
Exporting to Ramses - Export optimized Ramses binary assets.
Introducing prefabs - This example shows you how to create encapsulated, reusable objects with the Prefab mechanism.
Conventions - Coordinate systems and import specifics.
Scripting with LUA - Additional Lua scripting tips.
Render Order - Controlling the render order.
Offscreen Rendering - Offscreen Rendering.
Modules - Reuse Lua code by using modules.
Complex import - Import multiple objects from a single glTF file.
Animations - Import and control animations from glTF.
Nested prefabs - Demonstrates how to construct complex Prefabs using other Prefabs as building blocks.
External references - Explains how to import and use building blocks from different projects.
Best practices - Suggests best practices for project structure.
Versions - Supported versions, API and ABI compatibility.
You will find the source code of Ramses Composer and instructions on how to build it in the main Ramses Composer repository. For a general overview of the Ramses ecosystem and its other components, visit also these pages.
Like the Ramses Composer, this documentation is also published under the MPL-2.0 license. Some of the example glTF assets are taken from the official Khronos repositories - the corresponding example projects mention the source and license information in their respective README.md documents. Some of the example projects contain a custom Blender file. These files are also published under the MPL-2.0 license.