Page cover

rocket-launchGetting Started

Step-by-step setup instructions for new users.

This page is the beginner path. If you are new to BRG and instancing, follow these sections in order.

Flora

  • Flora renders many objects as instances using shared prefab/template data.

  • You still author with familiar Unity objects (prefabs, terrain, volumes), but Flora owns runtime draw/culling data.

  • In current Flora, culling/drawing runs on Unity's Batch Renderer Group (BRG) path.


Install

Install Flora from the Unity Asset Store: Installing Asset Store Packagesarrow-up-right.

Use the Flora Package Manager to install or update Flora modules and optional add-ons.

Flora Package Manager

Open the package manager from Window → Flora → Package Manager.

Expected outcome: Flora menu items and samples are available.


Scene Bootstrap

  1. Create Flora Scene Settings (Create → Flora → Scene Settings).

  2. Confirm terrain options:

    • EnableTerrainFoliage enabled

    • AutoRegisterTerrains enabled

  3. Open Project Settings → Graphics and configure Runtime Settings if needed.

  4. Add Flora overrides to the default volume profile:

Default Volume Profile with Flora settings

Expected outcome: scene has global Flora control and default render/density behavior.


Conversion

To convert existing prefab objects into Flora-rendered instances:

  1. Select one or more prefab instances in Hierarchy.

  2. Right-click → Convert to Instance Renderer.

  3. Verify converted objects now use FloraInstanceRenderer.

See Conversion for all conversion options.


First Run

  1. Open Container Mesh Sample and press Play.

  2. Open Container Prefab Sample and verify FloraInstanceRenderer and FloraInstanceContainer instances render correctly.

  3. Open Fish Boids sample and press Play.

  4. Open Tree Effect and verify terrain trees animate.

  5. Open Tree Wrecking Ball and verify trees are disabled/replaced on impact.

If these pass, your Flora setup is functioning.


Quick Troubleshooting

Relevant pages: Runtime Settings, Scene Settings, Samples

Last updated