Skip to main content

Installation

The recommended method to install the Flora Engine plugin is through the FAB Marketplace.

For manual installation:

For Blueprint only projects, FloraEngine.zip can be downloaded from the latest release and extracted to the marketplace plugins folder "UE_<VERSION NUMBER>/Engine/Plugins/Marketplace/".

For C++ Unreal Engine projects plugin can be included in the project directory under Plugins instead if desired.

Initial Setup

Files for the models (tokenizer.bin and weights.bin) must be located in a folder within the plugin (default: Content/Models/, can be adjusted in the settings) with each model contained in a subfolder along with a template .json file. The .json file must have the same name as the model name used for the folder with "_template" appended to the end of the name.

The library files (flora.dll for Windows or libflora.so for Android) are not included and must be placed in the Source/ThirdParty/bin/Win64 or Source/ThirdParty/bin/Android respectively and the dll must also be placed in Binaries/Win64.

Each version of the flora.dll must be placed in the respective folder for the device it is for.

Library files can be downloaded from https://app.databiomes.com.

Note: weights.xml must also be included with weights.bin for Intel NPU models. Currently Flora is unsupported for AMD NPU and will run on the CPU if selected (Windows CPU dll must be placed in the amd_npu folder).

Example file structure:

📦 FloraEngine
├─ 📁Binaries
| └─ 📁Win64
│ ├─ 📁amd_npu
| | └─ 📄flora.dll
│ ├─ 📁cpu
| | └─ 📄flora.dll
│ └─ 📁intel_npu
| ├─ 📄flora.dll
| └─ 📄openvino.dll
├─ 📁Source
│ └─ 📁ThirdParty
│ └─ 📁bin
│ ├─ 📁Android
| | └─ 📄libflora.so
│ └─ 📁Win64
│ ├─ 📁amd_npu
| | └─ 📄flora.dll
│ ├─ 📁cpu
| | └─ 📄flora.dll
│ └─ 📁intel_npu
| ├─ 📄flora.dll
| └─ 📄openvino.dll
└─ 📁Content
   └─ 📁Models
      ├─ 📁CheshireCat
      │  ├─ 📄CheshireCat_template.json
      │  ├─ 📄tokenizer.bin
      │  ├─ 📄weights.bin
      │  └─ 📄weights.xml (Only for Intel NPU builds)
      ├─ 📁MadHatter
      │  ├─ 📄MadHatter_template.json
      │  ├─ 📄tokenizer.bin
      │  └─ 📄weights.bin
      └─ 📁MarchHare
         ├─ 📄MarchHare_template.json
         ├─ 📄tokenizer.bin
         └─ 📄weights.bin

Next Steps