add some OFS3 notes

Author: arch

build_and_deploy.bat

@@ -2,12 +2,12 @@
 REM script to build an deploy ofs extension
 rmdir /Q /S "build" 2>NUL
 rmdir /Q /S "dist/funscript-editor" 2>NUL
-rmdir /Q /S "%APPDATA%\\OFS\\OFS_data2\\extensions\\Funscript Generator Windows\\funscript-editor" 2>NUL
+rmdir /Q /S "%APPDATA%\\OFS\\OFS_data3\\extensions\\Funscript Generator Windows\\funscript-editor" 2>NUL
 del "dist\\funscript-editor.zip" 2>NUL
 del funscript-editor.spec 2>NUL
-del "%APPDATA%\\OFS\\OFS_data2\\extensions\\Funscript Generator Windows\\main.lua" 2>NUL
-del "%APPDATA%\\OFS\\OFS_data2\\extensions\\Funscript Generator Windows\\json.lua" 2>NUL
-if not exist "%APPDATA%\\OFS\\OFS_data2\\extensions\\Funscript Generator Windows" mkdir "%APPDATA%\\OFS\\OFS_data2\\extensions\\Funscript Generator Windows"
+del "%APPDATA%\\OFS\\OFS_data3\\extensions\\Funscript Generator Windows\\main.lua" 2>NUL
+del "%APPDATA%\\OFS\\OFS_data3\\extensions\\Funscript Generator Windows\\json.lua" 2>NUL
+if not exist "%APPDATA%\\OFS\\OFS_data3\\extensions\\Funscript Generator Windows" mkdir "%APPDATA%\\OFS\\OFS_data3\\extensions\\Funscript Generator Windows"
 cd docs/app
 mkdocs build
 cd ../..
@@ -17,6 +17,6 @@ copy /Y "funscript_editor\\VERSION.txt" "dist\\funscript-editor\\funscript_edito
 md "dist\\funscript-editor\\OFS"
 copy /Y "contrib\\Installer\\assets\\main.lua" "dist\\funscript-editor\\OFS"
 copy /Y "contrib\\Installer\\assets\\json.lua" "dist\\funscript-editor\\OFS"
-move "dist\\funscript-editor" "%APPDATA%\\OFS\\OFS_data2\\extensions\\Funscript Generator Windows\\funscript-editor"
-copy /Y "contrib\\Installer\\assets\\main.lua" "%APPDATA%\\OFS\\OFS_data2\\extensions\\Funscript Generator Windows"
-copy /Y "contrib\\Installer\\assets\\json.lua" "%APPDATA%\\OFS\\OFS_data2\\extensions\\Funscript Generator Windows"
+move "dist\\funscript-editor" "%APPDATA%\\OFS\\OFS_data3\\extensions\\Funscript Generator Windows\\funscript-editor"
+copy /Y "contrib\\Installer\\assets\\main.lua" "%APPDATA%\\OFS\\OFS_data3\\extensions\\Funscript Generator Windows"
+copy /Y "contrib\\Installer\\assets\\json.lua" "%APPDATA%\\OFS\\OFS_data3\\extensions\\Funscript Generator Windows"

docs/app/docs/user-guide/build.md

@@ -89,3 +89,7 @@ Path for extensions is `~/.local/share/OFS/OFS_data/extensions`
 ### OFS 2.x.x
 
 Path for extensions is `~/.local/share/OFS/OFS_data2/extensions`
+
+### OFS 3.x.x
+
+Path for extensions is `~/.local/share/OFS/OFS_data3/extensions`

docs/app/docs/user-guide/developer.md

@@ -8,7 +8,7 @@ Sometimes it is useful to test new functions and verify the correctness of chang
 
 ### Installation
 
-There is no automated way to install the prereleases since they are indented for developer and technical experienced test users. To install the prerealese you have to extract the downloaded Prerelease to `%APPDATA%\OFS\OFS_data2\extensions\Funscript Generator Windows\funscript-editor`. Therefore first delete the `funscript-editor` folder in `%APPDATA%\OFS\OFS_data2\extensions\Funscript Generator Windows`. And create a new one with the content of the Prerelease. The preerelease now can be used as OFS extension. Note: For prereleases the version may be displayed incorrectly because there is no official release tag. To switch back to the latest official release delete the `funscript-editor` folder in `%APPDATA%\OFS\OFS_data2\extensions\Funscript Generator Windows` and run the `mtfg-ofs-extension-installer.exe` from [latest GitHub release](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases/tag/latest).
+There is no automated way to install the prereleases since they are indented for developer and technical experienced test users. To install the prerealese you have to extract the downloaded Prerelease to `%APPDATA%\OFS\OFS_dataX\extensions\Funscript Generator Windows\funscript-editor`. Therefore first delete the `funscript-editor` folder in `%APPDATA%\OFS\OFS_dataX\extensions\Funscript Generator Windows`. And create a new one with the content of the Prerelease. The preerelease now can be used as OFS extension. Note: For prereleases the version may be displayed incorrectly because there is no official release tag. To switch back to the latest official release delete the `funscript-editor` folder in `%APPDATA%\OFS\OFS_dataX\extensions\Funscript Generator Windows` and run the `mtfg-ofs-extension-installer.exe` from [latest GitHub release](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases/tag/latest).
 
 ## Development on Windows
 

docs/app/docs/user-guide/ofs-integration.md

@@ -2,7 +2,7 @@
 
 ## Installation Windows (Easy)
 
-This method use an installer that check for the latest release on GitHub and automatically update the existing Motion Tracking Funscript Generator (MTFG) OFS Extension on your computer. If you want to make an clean install of the MTFG OFS Extension you can delete the existing folder `Funscript Generator Windows` in `%APPDATA%\OFS\OFS_data2\extensions` before running the installer.
+This method use an installer that check for the latest release on GitHub and automatically update the existing Motion Tracking Funscript Generator (MTFG) OFS Extension on your computer. If you want to make an clean install of the MTFG OFS Extension you can delete the existing folder `Funscript Generator Windows` in `%APPDATA%\OFS\OFS_dataX\extensions` (the `X` in `OFS_dataX` is an placeholder for your OFS Version) before running the installer.
 
 **Installation:**
 
@@ -27,7 +27,7 @@ This method use an installer that check for the latest release on GitHub and aut
 
 This section for technical interested people who want to understand the installation process. The source code of the installer is in the [`contrib/Installer`](https://github.com/michael-mueller-git/Python-Funscript-Editor/tree/main/contrib/Installer) directory of this repository. The installer perform the following Steps:
 
-1. Check if the OFS Extension Directory `%APPDATA%\OFS\OFS_data2\extensions` exists.
+1. Check if the OFS Extension Directory `%APPDATA%\OFS\OFS_dataX\extensions` exists (the `X` in `OFS_dataX` is an placeholder for your OFS Version).
 2. Fetch the latest release Version from github rest api.
 3. Check if an (older) MTFG Version is already installed in the OFS Extension Directory: If we have already the latest version installed, we are done here
 4. The installer download the latest release version from github.
@@ -51,15 +51,16 @@ Manual Installation:
    <br> ![Install OFS](./images/ofs_installation_03.jpg)
 3. Start OFS at least once and close it again.
    <br> ![Start OFS](./images/ofs_installation_04.jpg)
-4. Download the application `funscript-editor_vx.x.x.zip` from https://github.com/michael-mueller-git/Python-Funscript-Editor/releases.
-5. Open your File Explorer and navigate to `%APPDATA%\OFS\OFS_data2\extensions`.
-6. Create an directory for the Extension with the name `Funscript Generator Windows`.
-7. Create an other directory inside the `Funscript Generator Windows` directory with the Name `funscript-editor`.
-8. Extract the Downloaded `funscript-editor_vx.x.x.zip` into `%APPDATA%\OFS\OFS_data2\extension\Funscript Generator Windows\funscript-editor`.
-9. Now check that the file `%APPDATA%\OFS\OFS_data2\extension\Funscript Generator Windows\funscript-editor\funscript-editor.exe` exists.
-10. Copy the content from `%APPDATA%\OFS\OFS_data\extension\Funscript Generator Windows\funscript-editor\OFS` to `%APPDATA%\OFS\OFS_data\extension\Funscript Generator Windows` and override existing files.
-11. Now check that the file `%APPDATA%\OFS\OFS_data2\extension\Funscript Generator Windows\main.lua` exists.
-12. Open OFS, activate the extension (3) and enable the window (4). Now you can use the extension at any position in the Video with the _Start MTFG_ Button (5). On slow computers, the program may take several seconds to start!. Before you press the _Start MTFG_ Button you have to open a video in OFS else you get only the Message Box "Video file was not specified!".
+4. Determine OFS extension directory in `%APPDATA%\OFS`. For OFS Version 3 the `OFS_EXTENSION_PATH` is `%APPDATA%\OFS\OFS_data3\extension`.
+5. Download the application `funscript-editor_vx.x.x.zip` from `https://github.com/michael-mueller-git/Python-Funscript-Editor/releases`.
+6. Open your File Explorer and navigate to `%OFS_EXTENSION_PATH%` (determined in step 4).
+7. Create an directory for the Extension with the name `Funscript Generator Windows`.
+8. Create an other directory inside the `Funscript Generator Windows` directory with the Name `funscript-editor`.
+9. Extract the Downloaded `funscript-editor_vx.x.x.zip` into `%OFS_EXTENSION_PATH%\Funscript Generator Windows\funscript-editor`.
+10. Now check that the file `%OFS_EXTENSION_PATH%\extension\Funscript Generator Windows\funscript-editor\funscript-editor.exe` exists.
+11. Copy the content from `%OFS_EXTENSION_PATH%\extension\Funscript Generator Windows\funscript-editor\OFS` to `%OFS_EXTENSION_PATH%\Funscript Generator Windows` and override existing files.
+12. Now check that the file `%OFS_EXTENSION_PATH%\Funscript Generator Windows\main.lua` exists.
+13. Open OFS, activate the extension (3) and enable the window (4). Now you can use the extension at any position in the Video with the _Start MTFG_ Button (5). On slow computers, the program may take several seconds to start!. Before you press the _Start MTFG_ Button you have to open a video in OFS else you get only the Message Box "Video file was not specified!".
     <br> ![Activate MTFG Extension](./images/ofs_extension_03.jpg)
 
 <br>