update ofs docs #5

Author: arch

docs/app/docs/user-guide/images/ofs_installation_01.jpg

@@ -4,26 +4,29 @@ We use a lua script to communicate between the Python Funscript Generator and th
 
 ## Installation (Windows)
 
-1. Download the **latest** packed Python Funscript Editor from [github release page](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases).
+1. Download and install [Open Funscripter](https://github.com/OpenFunscripter/OFS/releases). Please memorize the specified installation path, you will need it later.
+   <br> ![OFS installation Step 1](./images/ofs_installation_01.jpg)
+   <br> ![OFS installation Step 2](./images/ofs_installation_02.jpg)
+2. Download the **latest** packed Python Funscript Editor from [github release page](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases).
    <br> ![Funscript Editor Windows Release](./images/ofs_integration_01.jpg)
-2. Extract the Archiv.
+3. Extract the Archiv.
    <br> ![Extract Python Funscript Editor Windows Release](./images/ofs_integration_02.jpg)
-3. Download the **latest** `funscript_generator.lua` script from [github release page](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases).
+4. Download the **latest** `funscript_generator.lua` script from [github release page](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases).
    <br> ![OFS integration Windows Release](./images/ofs_integration_03.jpg)
-4. Move the downloaded `funscript_generator.lua` script to `data/lua` in your OFS directory.
+5. Move the downloaded `funscript_generator.lua` script to `data/lua` in your OFS directory. The default OFS install path is `C:\Program Files\OpenFunscripter`.
    <br> ![Copy the OFS integration script to the lua folder](./images/ofs_integration_04.jpg)
-5. Open the `funscript_generator.lua` file and adjust the `Settings.FunscriptGenerator` and `Settings.TmpFile` variable.
+6. Open the `funscript_generator.lua` file and adjust the `Settings.FunscriptGenerator` and `Settings.TmpFile` variable.
    <br> - **NOTE:** If you copy the path from Windows explorer to the variable in the lua script you have to escape the `\` symbol. This mean you have to put another `\` in front of each `\` so that there are always `\\` pairs. As an alternative, you can use a simple `/` instead of the single `\` Symbole that also work.
    <br> - `Settings.FunscriptGenerator`: Point to the extracted Python Funscript Editor program (better double check the complete path string to avoid errors later on).
    <br> - `Settings.TmpFile`: Specifies a temporary file location where to store the result (must be a file not a directory!). The file does not have to exist at the moment. The specified file will be generated from the Python Funscript Editor and will be overwritten automatically at the next time the generator is started!
    <br> ![Adjust Settings/Variables in the lua Script](./images/ofs_integration_05.jpg)
-6. Now launch OFS.
+7. Now launch OFS.
    <br> ![Start OFS](./images/ofs_integration_06.jpg)
-7. Navigate to `View : Special functions : Custom Functions` and select the `funscript_generator.lua` entry. Click on the `funscript_generator.lua` entry to get more options for the script (This may trigger the funscript generator, just ignore it for now). Finally click the now visible Button `Bind Script`.
+8. Navigate to `View : Special functions : Custom Functions` and select the `funscript_generator.lua` entry. Click on the `funscript_generator.lua` entry to get more options for the script (This may trigger the funscript generator, just ignore it for now). Finally click the now visible Button `Bind Script`.
    <br> ![Enable OFS Integration](./images/ofs_integration_07.jpg)
-8. Navigate to `Options : Keys : Dynamic` and insert a shortcut for the funscript generator.
+9. Navigate to `Options : Keys : Dynamic` and insert a shortcut for the funscript generator.
    <br> ![Assign an Shortcut](./images/ofs_integration_08.jpg)
-9. Now you can use the shortcut at any position in the video to start the funscript generator.
+10. Now you can use the shortcut at any position in the video to start the funscript generator.
 
 ## Troubleshot
 

docs/app/docs/user-guide/images/ofs_installation_02.jpg

@@ -30,8 +30,7 @@
 @dataclass
 class FunscriptGeneratorParameter:
     """ Funscript Generator Parameter Dataclass with default values """
-    # No default values
-    video_path: str # no default value
+    video_path: str
     track_men: bool
     metric: str
     projection: str
@@ -49,15 +48,15 @@ class FunscriptGeneratorParameter:
     # General
     skip_frames: int = max((0, int(HYPERPARAMETER['skip_frames'])))
 
-    # y VR Movement
+    # VR Movement in y Direction
     shift_bottom_points: int = int(HYPERPARAMETER['shift_bottom_points'])
     shift_top_points: int = int(HYPERPARAMETER['shift_top_points'])
     bottom_points_offset: float = float(HYPERPARAMETER['bottom_points_offset'])
     top_points_offset: float = float(HYPERPARAMETER['top_points_offset'])
     bottom_threshold: float = float(HYPERPARAMETER['bottom_threshold'])
     top_threshold: float = float(HYPERPARAMETER['top_threshold'])
 
-    # x-Movement
+    # All other predicted Movements
     shift_min_points: int = int(HYPERPARAMETER['shift_min_points'])
     shift_max_points: int = int(HYPERPARAMETER['shift_max_points'])
     min_points_offset: float = float(HYPERPARAMETER['min_points_offset'])