passdedd / ramses-composer-docs

The user documentation pages of the Ramses Composer project (https://github.com/GENIVI/ramses-composer)

Ramses Composer Documentation

This repository contains the documentation for Ramses Composer, the authoring tool for the open source RAMSES rendering ecosystem.

Basics

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.

Complex import - Import multiple objects from a single glTF file.

Exporting to Ramses - Export optimized Ramses binary assets.

Structuring your project

How to manage a more complex project, allow collaboration with multiple artists or teams, eliminate duplication and maintain clear structure? The following tutorials provide some answers.

Introducing prefabs - This example shows you how to create encapsulated, reusable objects with the Prefab mechanism.

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.

Advanced guides

Need a specific Lua feature, or need to know how rotation math works? Advanced details here!

Conventions - Coordinate systems and import specifics.

Scripting with LUA - Advanced Lua scripting tips.

Versions - Supported versions, API and ABI compatibility.

Troubleshooting

Using the Log Output Console

Common Issues

Crash dumps

Related resources

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.

License

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 manual.md documents. Some of the example projects contain a custom Blender file. These files are also published under the MPL-2.0 license.