# User guide

Practical, narrative documentation for the Nyx renderer plugin. If you want a complete listing of every class and method, head to the {doc}`../api_reference/index` instead.

```{toctree}
:caption: Getting started
:maxdepth: 1

installation
quickstart
concepts
supported_features
known_issues
```

Each example below corresponds to a runnable script in the [`examples/`](https://github.com/Genesis-Embodied-AI/nyx-for-genesis/tree/main/examples) directory of this repository. The pages embed the script source verbatim via `literalinclude`, so what you read is exactly what you can run.

```{toctree}
:caption: Examples
:maxdepth: 1

examples/hello_nyx
examples/attached_camera
examples/materials
examples/light_types
examples/gaussian_splat
examples/object_picking
examples/multi_camera_multi_env
```

```{toctree}
:caption: Advanced topics
:maxdepth: 1

advanced/sensor_lifecycle
advanced/lights
advanced/environment_maps
advanced/splats
```