> For the complete documentation index, see [llms.txt](https://flora.magneticarcade.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://flora.magneticarcade.com/getting-started.md).

# Getting Started

Step-by-step setup instructions for new users.

Follow this page in order to install Flora and render your first scene.

## Install

When using **Unity 6.5**, use **6000.5.8f1 or newer** to avoid the camera culling view ID regression fixed in [UUM-146214](https://unity.com/releases/editor/whats-new/6000.5.8f1).

Download and import Flora from **Unity Package Manager > My Assets**: [Installing Asset Store Packages](https://docs.unity3d.com/6000.1/Documentation/Manual/upm-ui-import.html).

The Asset Store package installs Flora directly into `Packages/com.ma.flora`. Keep it in that folder; its editor resources and shaders use package-relative paths. Unity resolves the dependencies declared in Flora's `package.json`.

Open **Window > Flora > Getting Started** for project checks, scene setup, and examples. Enable **Show on startup** if you want it to open each Editor session.

Under **Edit > Project Settings > Graphics**, set **BatchRendererGroup Variants** to **Keep All** so builds retain the required shaders.

Use **Help & updates > Check now** to check for a newer release. Download and import updates through **Package Manager > My Assets**. Automatic update checks are optional and off by default.

### Upgrading from the Flora Package Installer

Before importing the new release:

1. Back up or commit your project, including any local Flora modifications.
2. Remove **Flora Package Manager** (`com.ma.flora.package-manager`) through Unity Package Manager. If the old installer is embedded directly under `Packages/com.ma.flora.package-manager`, remove that installer folder instead. If you added it as a local dependency in `Packages/manifest.json`, remove that dependency as well.
3. Keep `Packages/com.ma.flora`, your scenes, and imported samples. Remove only the old installer; do not uninstall Flora itself.
4. Download and import the new Flora release through **My Assets**, then let Unity resolve packages and compile.

The new release preserves Flora asset GUIDs and its installation path, but does not remove the old installer automatically.

### Import the examples

1. Open **Window > Package Manager**.
2. Select **Flora**.
3. Expand **Samples**.
4. Import **Examples**.

Unity copies them to `Assets/Samples/Flora/<package-version>/Examples`.

## Set up a scene

1. Create **Flora Scene Settings** from **GameObject > Flora > Scene Settings**.
2. For Terrain foliage, enable **Terrain Foliage** and **Auto Register Terrains**.
3. Configure [Runtime Settings](/scripts/runtime-settings.md) under **Edit > Project Settings > Graphics**.
4. Select **Add Render Settings Volume** if the scene needs a Flora Volume. See [Render Settings](/scripts/render-settings.md).

<figure><img src="https://2882982566-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fyo4B7EVXffipTxnJzee6%2Fuploads%2Fgit-blob-0925838f0d7c46292415e4ef5a85440a5d863818%2Frender-settings-6-4-5.webp?alt=media" alt="Container Setup Profile with Flora Render Settings"><figcaption></figcaption></figure>

See the [Scene Settings Inspector](/scripts/scene-settings.md#inspector) for terrain registration, detail density, and wind sampling controls.

## Convert prefab instances

To convert existing prefab objects into Flora-rendered instances:

1. Select one or more prefab instances in Hierarchy.
2. Right-click and select **Convert To Instance Renderer(s)**.
3. Confirm the objects use [`FloraInstanceRenderer`](/scripts/instance-renderer.md).

> See [Conversion](/getting-started/conversion.md) for all conversion options.

## Verify

Import and run [Container Mesh Sample](/samples/container-samples.md#container-mesh-sample). Then choose other examples from [Samples](/samples.md) for the workflow you use.

## Quick Troubleshooting

* Nothing renders: check [**Enable Rendering**](/scripts/scene-settings.md#enablerendering).
* Terrain foliage is missing: check [**Enable Terrain Foliage**](/scripts/scene-settings.md#enableterrainfoliage), the Terrain Provider, and the Terrain's tree and detail settings.
* Motion vectors missing: check the source Renderer or Terrain motion-vector setting.
* Inspect Flora data: open [Rendering Inspector](/rendering/rendering-inspector.md).
