update docs

Author: arch

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

@@ -17,6 +17,15 @@ Config Files:
 
 ### Config Parameter
 
+#### `settings.yaml`
+
+- `use_zoom` (bool): Enable or disable an additional step to zoom in the Video before selecting a tracking feature for the Woman or Men.
+- `zoom_factor:` (float): Set the desired zoom value which will be used when the zoom function is activated.
+- `tracking_direction` (str): Specify the tracking direction. Allowed values are `'x'` and `'y'`.
+- `max_playback_fps` (int): Limit the max player speed in the tracking preview window (0 = disable limit)
+- `preview_scaling` (float): Set the preview image scaling factor. With a value of `1.0`, the window should fill the height or width of the screen depending on the aspect ratio of the video.
+- `projection`: (str): Set the video type. All available options can be obtained from the `projection.yaml` file. Each root keys represent an option. Available Options: `'flat'` = 2D Videos, `'vr_he_sbs'` = 3D VR Side-By-Side Video
+
 #### `hyperparameter.yaml`
 
 - `skip_frames` (int): This parameter specifies how many frames are skipped and interpolated during tracking. Increase this parameter to improve the processing speed on slow hardware. But higher values result in poorer predictions!
@@ -28,12 +37,3 @@ Config Files:
 - `bottom_points_offset` (float): An fix offset to the bottom points (positive values move the point up and negative values move the point down). The offset respect the user defined upper and lower limit.
 - `top_threshold` (float): Define the top threshold. All top points greater than `(max - threshold)` will be set to the specified max value. Set 0.0 to disable this function.
 - `bottom_threshold` (float): Define the bottom threshold. All bottom points lower than `(min + threshold)` will be set to the specified min value. Set 0.0 to disable this function.
-
-#### `settings.yaml`
-
-- `use_zoom` (bool): Enable or disable an additional step to zoom in the Video before selecting a tracking feature for the Woman or Men.
-- `zoom_factor:` (float): Set the desired zoom value which will be used when the zoom function is activated.
-- `tracking_direction` (str): Specify the tracking direction. Allowed values are `'x'` and `'y'`.
-- `max_playback_fps` (int): Limit the max player speed in the tracking preview window (0 = disable limit)
-- `preview_scaling` (float): Set the preview image scaling factor. With a value of `1.0`, the window should fill the height or width of the screen depending on the aspect ratio of the video.
-- `projection`: (str): Set the video type. All available options can be obtained from the `projection.yaml` file. Each root keys represent an option. Available Options: `'flat'` = 2D Videos, `'vr_he_sbs'` = 3D VR Side-By-Side Video

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

@@ -13,7 +13,7 @@ Currently we use a hacky lua script to communicate between the Python Funscript
    - `Settings.FunscriptGenerator`: Point to the extracted Python Funscript Editor program (better double check the complete path string to avoid errors later on).
    - `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!
 6. Now launch OFS.
-7. Navigate to `View : Special functions : Custom Functions` and select the `funscript_generator.lua` entry. Click the Button `Bind Script` (This may trigger the funscript generator, just ignore it for now).
+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 `Options : Keys : Dynamic` and insert a shortcut for the funscript generator.
 9. Now you can use the shortcut at any position in the video to start the funscript generator.
 

docs/app/site/index.html

@@ -204,5 +204,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.1.2
-Build Date UTC : 2021-07-02 16:58:07.199033+00:00
+Build Date UTC : 2021-07-03 08:25:01.317170+00:00
 -->

docs/app/site/search/search_index.json

@@ -1,27 +1,27 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url>
      <loc>None</loc>
-     <lastmod>2021-07-02</lastmod>
+     <lastmod>2021-07-03</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>None</loc>
-     <lastmod>2021-07-02</lastmod>
+     <lastmod>2021-07-03</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>None</loc>
-     <lastmod>2021-07-02</lastmod>
+     <lastmod>2021-07-03</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>None</loc>
-     <lastmod>2021-07-02</lastmod>
+     <lastmod>2021-07-03</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>None</loc>
-     <lastmod>2021-07-02</lastmod>
+     <lastmod>2021-07-03</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>None</loc>
-     <lastmod>2021-07-02</lastmod>
+     <lastmod>2021-07-03</lastmod>
      <changefreq>daily</changefreq>
     </url>
 </urlset>

docs/app/site/sitemap.xml

@@ -124,6 +124,15 @@ <h2 id="config-files">Config Files</h2>
 <li><code>projection.yaml</code>: the FFmpeg filter parameter for different video types</li>
 </ul>
 <h3 id="config-parameter">Config Parameter</h3>
+<h4 id="settingsyaml"><code>settings.yaml</code></h4>
+<ul>
+<li><code>use_zoom</code> (bool): Enable or disable an additional step to zoom in the Video before selecting a tracking feature for the Woman or Men.</li>
+<li><code>zoom_factor:</code> (float): Set the desired zoom value which will be used when the zoom function is activated.</li>
+<li><code>tracking_direction</code> (str): Specify the tracking direction. Allowed values are <code>'x'</code> and <code>'y'</code>.</li>
+<li><code>max_playback_fps</code> (int): Limit the max player speed in the tracking preview window (0 = disable limit)</li>
+<li><code>preview_scaling</code> (float): Set the preview image scaling factor. With a value of <code>1.0</code>, the window should fill the height or width of the screen depending on the aspect ratio of the video.</li>
+<li><code>projection</code>: (str): Set the video type. All available options can be obtained from the <code>projection.yaml</code> file. Each root keys represent an option. Available Options: <code>'flat'</code> = 2D Videos, <code>'vr_he_sbs'</code> = 3D VR Side-By-Side Video</li>
+</ul>
 <h4 id="hyperparameteryaml"><code>hyperparameter.yaml</code></h4>
 <ul>
 <li><code>skip_frames</code> (int): This parameter specifies how many frames are skipped and interpolated during tracking. Increase this parameter to improve the processing speed on slow hardware. But higher values result in poorer predictions!</li>
@@ -135,15 +144,6 @@ <h4 id="hyperparameteryaml"><code>hyperparameter.yaml</code></h4>
 <li><code>bottom_points_offset</code> (float): An fix offset to the bottom points (positive values move the point up and negative values move the point down). The offset respect the user defined upper and lower limit.</li>
 <li><code>top_threshold</code> (float): Define the top threshold. All top points greater than <code>(max - threshold)</code> will be set to the specified max value. Set 0.0 to disable this function.</li>
 <li><code>bottom_threshold</code> (float): Define the bottom threshold. All bottom points lower than <code>(min + threshold)</code> will be set to the specified min value. Set 0.0 to disable this function.</li>
-</ul>
-<h4 id="settingsyaml"><code>settings.yaml</code></h4>
-<ul>
-<li><code>use_zoom</code> (bool): Enable or disable an additional step to zoom in the Video before selecting a tracking feature for the Woman or Men.</li>
-<li><code>zoom_factor:</code> (float): Set the desired zoom value which will be used when the zoom function is activated.</li>
-<li><code>tracking_direction</code> (str): Specify the tracking direction. Allowed values are <code>'x'</code> and <code>'y'</code>.</li>
-<li><code>max_playback_fps</code> (int): Limit the max player speed in the tracking preview window (0 = disable limit)</li>
-<li><code>preview_scaling</code> (float): Set the preview image scaling factor. With a value of <code>1.0</code>, the window should fill the height or width of the screen depending on the aspect ratio of the video.</li>
-<li><code>projection</code>: (str): Set the video type. All available options can be obtained from the <code>projection.yaml</code> file. Each root keys represent an option. Available Options: <code>'flat'</code> = 2D Videos, <code>'vr_he_sbs'</code> = 3D VR Side-By-Side Video</li>
 </ul></div>
             </div>
         </div>

docs/app/site/sitemap.xml.gz

@@ -127,7 +127,7 @@ <h2 id="installation-windows">Installation (Windows)</h2>
 <li><code>Settings.FunscriptGenerator</code>: Point to the extracted Python Funscript Editor program (better double check the complete path string to avoid errors later on).</li>
 <li><code>Settings.TmpFile</code>: 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!</li>
 <li>Now launch OFS.</li>
-<li>Navigate to <code>View : Special functions : Custom Functions</code> and select the <code>funscript_generator.lua</code> entry. Click the Button <code>Bind Script</code> (This may trigger the funscript generator, just ignore it for now).</li>
+<li>Navigate to <code>View : Special functions : Custom Functions</code> and select the <code>funscript_generator.lua</code> entry. Click on the <code>funscript_generator.lua</code> 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 <code>Bind Script</code>.</li>
 <li>Navigate to <code>Options : Keys : Dynamic</code> and insert a shortcut for the funscript generator.</li>
 <li>Now you can use the shortcut at any position in the video to start the funscript generator.</li>
 </ol>