Editor documentation for Engine V2

docs/user-manual/editor/editor-migrations.md

@@ -0,0 +1,30 @@
+---
+title: Editor Migrations
+sidebar_position: 13
+---
+
+## Introduction
+
+This page is to outline the migrations of data between different editor versions
+
+### Migration from 1.48.0 to 1.50.0
+
+This Editor has been updated to now use Engine V2 internally. This change may cause some small visual changes for some projects. We have collated a list of the most common issues and how to fix them.
+
+#### Cubemap edge filtering
+
+<img src='/img/user-manual/editor/editor-v2/edge-filter.png' width='600' />
+
+If your cubemap skybox has pronounced edges such as this example above, navigate to your cubemap asset and delete and regenerate the prefiltered data to remove them.
+
+<img src='/img/user-manual/editor/editor-v2/prefiltered-data.png' width='400' />
+
+#### Gamma Correction
+
+<img src='/img/user-manual/editor/editor-v2/gamma-compare.png' />
+
+If you have a project with a gamma correction set to 1.0 your scene may appear more saturated such as the example above (New editor on the right). Under the rendering settings change your gamma correction to 2.2 to achieve a similar effect as before.
+
+> **Note:** Your scene will be rendered with more correct linear workflow however there will be slight visual changes related to lighting and alpha blending.
+
+<img src='/img/user-manual/editor/editor-v2/gamma-tonemap-settings.png' width='400' />

docs/user-manual/editor/engine-compatibility.md

@@ -0,0 +1,57 @@
+---
+title: Engine Compatibility
+sidebar_position: 12
+---
+
+## Introduction
+
+The Editor supports two major release streams of the engine:
+
+- The latest release of engine v1.x.x (**Engine V1**)
+  - This provides support for WebGL1 and WebGL2, but does not receive any new features, and only critical bug fixes.
+- The latest release of engine v2.x.x (**Engine V2**)
+  - This has no support for WebGL1 and supports WebGL2 and WebGPU for rendering, and receives new features and fixes.
+
+You are free to switch between these at any time.
+
+### Switching projects between Engine V1 and V2
+
+This process will involve migration and updating of scripts given differences in our Engine API between Engine V1 and V2. All details regarding the engine changes can be found [here](/user-manual/engine/migrations)
+
+To initiate this navigate to the settings panel and click the `SWITCH TO ENGINE V2` button to convert your project to using Engine V2 (This will require a confirmation before converting). If you wish to switch back, there is a `SWITCH TO ENGINE V1` button in the same location for Project V2.
+
+> **Note:** Once the switch has been confirmed **all users** in the current project will be reloaded.
+
+<img src='/img/user-manual/editor/editor-v2/switch-engine.png' width='400' />
+
+#### Scripting
+
+Given the changes in API for the engine you may wish to test your project in the launcher with Engine V1 or V2. You can do this by enabling the Force Engine V2 or Force Engine V1 checkboxes in the launcher options:
+
+<img src='/img/user-manual/editor/editor-v2/launcher-options.png' width='600' />
+
+Additionally conditionally checking the Engine version at runtime will allow your script to be made compatible with both versions of the engine, during the transition time.
+
+<img src='/img/user-manual/editor/editor-v2/scripting-engine.png' width='300' />
+
+#### Gamma and Tonemap
+
+These settings were previously found under the rendering section of the settings panel. However in Engine V2 these have been moved to be set per camera. Each camera component will now have these additional fields:
+
+<img src='/img/user-manual/editor/editor-v2/gamma-tonemap.png' width='400' />
+
+The viewport settings are now located inside the editor section of the settings panel:
+
+<img src='/img/user-manual/editor/editor-v2/viewport-camera.png' width='400' />
+
+> **Note:** If you change the settings per camera and switch back to Project V1 your per camera settings will be lost.
+
+#### sRGB Textures
+
+<img src='/img/user-manual/editor/editor-v2/srgb-texture.png' width='400' />
+
+For Engine V2, textures must be set as sRGB or not, depending on their use case. The textures that store color data, such as diffuse and emissive maps, should use sRGB for accurate color representation. This is found under the texture asset panel as shown above. These will be automatically set however if there are conflicts the console will display them:
+
+<img src='/img/user-manual/editor/editor-v2/console-texture.png' width='600' />
+
+Click on the console message to open up the conflicting reference. If you wish to use the same texture for both sRGB and not, it is advised to duplicate your texture to cover both cases.