# How to use

Before you can use the plugin you must do the following steps (we assume you already have a working ApertusVR on your computer, if you do not, check out our guide [here](https://app.gitbook.com/@apertus/s/vr/~/edit/drafts/-Lmy_mey0x8FDWpjjnSp/developers/developers-guide)):

1. Open Cmake and check in the followings: APE\_PLUGIN\_Ogre21Render, APE\_PLUGIN\_PhotorealisticScene.
2. Make sure to **uncheck** the following: APE\_PLUGIN\_OgreRender.
3. (Optional) If you want to examine the sample using this plugin check in: APE\_SAMPLES\_PhotorealisticScene.
4. Press Configure then Generate.

![](https://4044724383-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LEyKyxZqxfQ560k-THK%2F-LnBj9mKsyKtql5JYdOf%2F-LnC6qacHlSFu3eIdTLx%2Fogre21_howtouse01.PNG?alt=media\&token=7364f0e8-14ab-46e0-a83e-d1d565036562)

To use the plugin you can make your own sample or use an existing one. To create an empty sample skeleton in ApertusVR you can use the following guide:&#x20;

{% content-ref url="../../developers/getting-started/creating-a-sample" %}
[creating-a-sample](https://apertus.gitbook.io/vr/developers/getting-started/creating-a-sample)
{% endcontent-ref %}

When you have your sample you can add the plugin by the following steps:

1. Open your sample's config folder at: ..\ApertusVR\samples\MyScene
2. Open your config where you want to use the plugin.
3. Here you must find a CMakeLists.txt (..\ApertusVR\samples\MyScene\configs\myconfig\CMakeLists.txt)
4. Open CMakeLists.txt.
5. In the set property you must add the followings : apeOgre21RenderPlugin.json. You should already have the followings if not you must add them: apeOisUserInputPlugin.json, apeCore.json.
6. Save your changes and close the file.
7. Open apeCore.json at ..\ApertusVR\samples\MyScene\configs\myconfig\apeCore.json
8. Add the followings to the "plugins" attribute: "apeOgre21RenderPlugin", "apeOisUserInputPlugin", "apePhotorealisticScenePlugin".
9. Save your changes and close the file.
10. Open CMake and click Generate.

![..\ApertusVR\samples\MyScene\configs\myconfig\CMakeLists.txt](https://4044724383-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LEyKyxZqxfQ560k-THK%2F-LnBj9mKsyKtql5JYdOf%2F-LnCEVcYE1wPHSU6dbui%2Fogre21_howtouse02.PNG?alt=media\&token=2c526262-b880-45b9-afd5-7fabca38d78c)

![..\ApertusVR\samples\MyScene\configs\myconfig\apeCore.json](https://4044724383-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LEyKyxZqxfQ560k-THK%2F-LnBj9mKsyKtql5JYdOf%2F-LnCHtP784Se3xaZgyd6%2Fogre21_howtouse03.PNG?alt=media\&token=10fc19bc-bc2f-44cc-9d58-036908208990)

Now you have a sample that uses our Photorealistic Render Plugin. You can use your own plugin to populate your scene with PBS objects. To create your own plugin check out the following guide:

{% content-ref url="../../developers/getting-started/creating-a-plugin" %}
[creating-a-plugin](https://apertus.gitbook.io/vr/developers/getting-started/creating-a-plugin)
{% endcontent-ref %}

For more information read the How to configure tab.

#### glTF format:

To use glTF files in your project you must do the followin steps alongside with the earlier mentioned:

1. Open CMake and check in: APE\_PLUGIN\_AssimpAssetLoader.
2. Click Generate.
3. Open CMakeLists.txt at ..\ApertusVR\samples\MyScene\configs\myconfig\CMakeLists.txt
4. In the set property add the following: apeAssimpAssetLoaderPlugin.json.
5. Save the changes and close the file.
6. Open apeCore.json at ..\ApertusVR\samples\MyScene\configs\myconfig\apeCore.json
7. Add the following to the "plugins" attribute: "apeAssimpAssetLoaderPlugin".&#x20;
8. Add the following to the "resourceLocations" attribute: "/plugins/assimpAssetLoader/resources"
9. Save your changes and close the file.
10. Open CMake and click Generate.

**Important**: You can not use mpSceneMakerMacro->makeModel() function while using apeAssimpAssetLoaderPlugin in your plugin and sample

![..\ApertusVR\samples\MyScene\configs\myconfig\CMakeLists.txt](https://4044724383-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LEyKyxZqxfQ560k-THK%2F-LnCrC9NjgMJ6ajS5XSP%2F-LnCwFt_kBN2WqJZGMr6%2Fogre21_howtouse04.PNG?alt=media\&token=bf5e8ba2-1a95-456f-920d-926afc55e2b3)

![..\ApertusVR\samples\MyScene\configs\myconfig\apeCore.json](https://4044724383-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LEyKyxZqxfQ560k-THK%2F-LnD8wsLoT_NJ-ijxBKp%2F-LnDBW3DmB3kLSVFCdi7%2Fogre21_howtouse05.PNG?alt=media\&token=367d1776-0cbe-439f-9878-a1c62c0ae0f0)

Makes sure to copy all your glTF model's files to: ..\ApertusVR\plugins\assimpAssetLoader\resources. Or you can add its location to ..\ApertusVR\samples\MyScene\configs\myconfig\apeCore.json under the "resourceLocations" attribute. To load a .glTF file into your scene you must edit the apeAssimpAssetLoaderPlugin.json file at ..\ApertusVR\samples\MyScene\configs\myconfig\apeAssimpAssetLoaderPlugin.json. More information about editing apeAssimpAssetLoaderPlugin.json can be found under the **How to configure** tab.
