Guide

This guide helps you build scenes with Chorama using practical, task-first steps.

Overview

Chorama is a modular WebGL2 rendering library focused on explicit control: you compose render behavior with plugins, build scenes from reusable object/material/light primitives, and keep direct visibility into the render flow.

[!WARNING] Chorama is currently experimental and is not recommended for production use. Expect API changes, behavior changes and breaking changes as the library evolves.

This guide is structured to take you from first render to production-style scene setup. Instead of covering every class in isolation first, each chapter is anchored to a concrete task and points you to full runnable examples.

By the end of this guide, you should be able to:

Who This Guide Is For

Use this if you want direct WebGL2 control but still want reusable building blocks.

How To Use This Guide

Reading Order

  1. Installation
  2. First Scene
  3. Camera and Controls
  4. Materials and Lighting
  5. Textures and Assets
  6. Render Targets and Views
  7. Scene Graph and Transforms
  8. Plugins and Render Pipeline
  9. API Map
  10. Troubleshooting