improve docs

Author: arch

README.md

@@ -1,32 +1,9 @@
 # Python Funscript Editor
 
-A Python program to quickly create prototype algorithms to partially automate the generation of funscripts.
+A Python program that use Computer Vision to predict the funscript actions. Most of you are probably interested in the [Open Funscripter (OFS)](https://github.com/OpenFunscripter/OFS) integration of this tool. I create a hacky lua script to integrate the prediction of this tool in OFS. More information and installation instructions in [OFS Integration](https://github.com/michael-mueller-git/Python-Funscript-Editor/blob/main/docs/app/docs/user-guide/ofs-integration.md). For the application configuration see [this](https://github.com/michael-mueller-git/Python-Funscript-Editor/blob/main/docs/app/docs/user-guide/config.md) Documentation page.
 
-**NOTE:** The program is currently not intended for productive use. But you can do whatever you want with this tool.
+**NOTE:** The Tool could also use as an standalone application with an build in UI. Due to the limitations it is not intended for productive use.
 
 ## Documentation
 
 The application documentation is located in [`./docs/app/docs`](https://github.com/michael-mueller-git/Python-Funscript-Editor/blob/main/docs/app/docs)
-
-## Build
-
-### Windows
-
-Use `pyinstaller` in anaconda environment with all packages from `requirements.txt` set up. Then run:
-
-```
-pip install pyinstaller
-build.bat
-```
-
-This create the Windows Package in `./dist`
-
-### Pip-Package (Recommend for Linux)
-
-Generate distribution package of this project. These are archives that can be uploaded to an local Package Index and can be installed by pip.
-
-```bash
-make docs package
-```
-
-This create the distribution package in `./dist`. Or simply type `make all` to build and install the package.

docs/app/docs/README.md

@@ -1,11 +1,13 @@
 # Python Funscript Editor
 
-A Python program to quickly create prototype algorithms to partially automate the generation of funscripts.
+A Python program that use Computer Vision to predict the funscript actions. Most of you are probably interested in the [Open Funscripter (OFS)](https://github.com/OpenFunscripter/OFS) integration of this tool. I create a hacky lua script to integrate the prediction of this tool in OFS. More information in [OFS Integration](user-guide/ofs-integration.md). For the configuration see [this](user-guide/config.md) Documentation page.
 
-**NOTE:** The program is currently not intended for productive use. But you can do whatever you want with this tool.
+**NOTE:** The Tool could also use as an standalone application with an build in UI. Due to the limitations it is not intended for productive use.
 
 ## User-Guide
 
 - [Algorithms](user-guide/algorithms.md)
+- [Build](user-guide/build.md)
+- [Config](user-guide/config.md)
 - [OFS Integration](user-guide/ofs-integration.md)
 - [UI](user-guide/ui.md)

docs/app/docs/index.md

@@ -1,11 +1,13 @@
 # Python Funscript Editor
 
-A Python program to quickly create prototype algorithms to partially automate the generation of funscripts.
+A Python program that use Computer Vision to predict the funscript actions. Most of you are probably interested in the [Open Funscripter (OFS)](https://github.com/OpenFunscripter/OFS) integration of this tool. I create a hacky lua script to integrate the prediction of this tool in OFS. More information in [OFS Integration](user-guide/ofs-integration/index.html). For the configuration see [this](user-guide/config/index.html) Documentation page.
 
-**NOTE:** The program is currently not intended for productive use. But you can do whatever you want with this tool.
+**NOTE:** The Tool could also use as an standalone application with an build in UI. Due to the limitations it is not intended for productive use.
 
 ## User-Guide
 
 - [Algorithms](user-guide/algorithms/index.html)
+- [Build](user-guide/build/index.html)
+- [Config](user-guide/config/index.html)
 - [OFS Integration](user-guide/ofs-integration/index.html)
 - [UI](user-guide/ui/index.html)

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

@@ -0,0 +1,22 @@
+# Build
+
+## Windows
+
+Use `pyinstaller` in anaconda environment with all packages from `requirements.txt` set up. Then run:
+
+```
+pip install pyinstaller
+build.bat
+```
+
+This create the Windows Package in `./dist`
+
+## Pip-Package (Recommend for Linux)
+
+Generate distribution package of this project. These are archives that can be uploaded to an local Package Index and can be installed by pip.
+
+```bash
+make docs package
+```
+
+This create the distribution package in `./dist`. Or simply type `make all` to build and install the package.

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

@@ -0,0 +1,48 @@
+# Python Funscript Editor Config
+
+The configuration files for the Windows release version are located in the `funscript-editor/funscript_editor/config` directory since release `v0.0.3`. If you use the python source code directly they are located in [`funscript_editor/config`](https://github.com/michael-mueller-git/Python-Funscript-Editor/tree/main/funscript_editor/config).
+
+## Config Files
+
+The directory contains several config files. The most interesting are `video_scaling.json`, `settings.yaml` and `hyperparameter.yaml`. When editing the `*.yaml` configuration files, pay attention to the formatting, otherwise the program will not work later.
+
+Config Files:
+
+- `hyperparameter.yaml`: hyperparameter for the prediction algorithms
+- `logging_linux.yaml`: the logging configuration for linx
+- `logging_windows.yaml`: the logging configuration for windows
+- `settings.yaml`: application settings
+- `ui.yaml`: user interface settings
+- `video_scaling.json`: scaling for the preview window
+
+### Config Parameter
+
+#### `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!
+- `avg_sec_for_local_min_max_extraction` (float): Specify the window size for the calculation of the reference value for the local min and max search.
+- `min_frames` (int): Specify the minimum required frames for the tracking. Wee need this parameter to ensure there is at leas two strokes in the tracking result.
+- `shift_top_points` (int): Shift predicted top points by given frame number. Positive values delay the position and negative values result in an earlier position.
+- `shift_bottom_points` (int): Shift predicted bottom points by given frame number. Positive values delay the position and negative values result in an earlier position.
+
+#### `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.
+- `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)
+
+#### `video_scaling.json`
+
+The `video_scaling.json` config file specifies how the video get scaled bevor the tracking. The scaling also apply tho the preview size. If the preview to select the tracking feature is to small or to large you have to adjust this config file.
+
+The entries in this config file consist of a pair of values.
+
+Example config:
+
+```json
+{ "1920": 1.0, "3500": 0.5, "5000": 0.25 }
+```
+
+One pair in the example config is e.g. `"1920": 1.0`. Each pair of values defines which scaling should be used for which video resolution. The first value, refers to the video width in pixels. Videos with size larger than 1920 pixels horizontally use a scaling of `1.0`. Videos with 3500 pixel and more are scaled with `0.5` and from 5000 with `0.25`. All videos which are smaller than the smallest value (in this case 1920) are scaled always with `1.0` (original size). You can enter as many values as you want and change the existing scaling.
+
+It’s best to look at your screen resolution and calculate which scaling you need for which video size so that the window fits on the monitor. e.g. You have `1920x1080` screen and `5400x2700` Video, you can divide `1920 / 5400 = 0.36` → add `"5300": 0.35` to the config (the key value have to be a little bit smaller than the Video resolution to apply the correct scaling).

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

@@ -2,13 +2,13 @@
 
 Currently we use a hacky lua script to communicate between the Python Funscript Generator and the Open Funscripter.
 
-## Installation
+## Installation (Windows)
 
 1. Download the latest packed Python Funscript Editor from [github release page](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases).
 2. Extract the Archiv to an Path without special character or spaces.
 3. Copy the `funscript_generator.lua` script ([`Repository/contrib/OpenFunscripter`](https://github.com/michael-mueller-git/Python-Funscript-Editor/tree/main/contrib/OpenFunscripter)) to `data/lua` in your OFS directory.
 4. Open the `funscript_generator.lua` file and adjust the `Settings.FunscriptGenerator` and `Settings.TmpFile` variable.
-   - `Settings.FunscriptGenerator`: point to the extracted Python Funscript Editor program
+   - `Settings.FunscriptGenerator`: point to the extracted Python Funscript Editor program. Use `\\` instead of `/` symbols in the path string!
    - `Settings.TmpFile`: specifies a temporary file where to store the result (must be a file not a directory!). The file will be overwritten automatically the next time the generator is started!
 5. Now launch OFS.
 6. 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).

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

@@ -1,6 +1,6 @@
 # UI
 
-The UI use an embedded mpv video player and matplotlib to draw the actions timeseries at the bottom.
+The build in UI use an embedded mpv video player and matplotlib to draw the actions timeseries at the bottom.
 
 ## UI Keyboard Shortcuts
 

docs/app/mkdocs.yml

@@ -5,3 +5,5 @@ pages:
     - 'OFS Integration': 'user-guide/ofs-integration.md'
     - 'UI': 'user-guide/ui.md'
     - 'Algorithms': 'user-guide/algorithms.md'
+    - 'Config': 'user-guide/config.md'
+    - 'Build': 'user-guide/build.md'

docs/app/site/404.html

@@ -51,6 +51,14 @@
 <li>
     <a href="/user-guide/algorithms/" class="dropdown-item">Algorithms</a>
 </li>
+                                    
+<li>
+    <a href="/user-guide/config/" class="dropdown-item">Config</a>
+</li>
+                                    
+<li>
+    <a href="/user-guide/build/" class="dropdown-item">Build</a>
+</li>
                                 </ul>
                             </li>
                         </ul>

docs/app/site/index.html

@@ -51,6 +51,14 @@
 <li>
     <a href="user-guide/algorithms/" class="dropdown-item">Algorithms</a>
 </li>
+                                    
+<li>
+    <a href="user-guide/config/" class="dropdown-item">Config</a>
+</li>
+                                    
+<li>
+    <a href="user-guide/build/" class="dropdown-item">Build</a>
+</li>
                                 </ul>
                             </li>
                         </ul>
@@ -103,11 +111,13 @@
                     <div class="col-md-9" role="main">
 
 <h1 id="python-funscript-editor">Python Funscript Editor</h1>
-<p>A Python program to quickly create prototype algorithms to partially automate the generation of funscripts.</p>
-<p><strong>NOTE:</strong> The program is currently not intended for productive use. But you can do whatever you want with this tool.</p>
+<p>A Python program that use Computer Vision to predict the funscript actions. Most of you are probably interested in the <a href="https://github.com/OpenFunscripter/OFS">Open Funscripter (OFS)</a> integration of this tool. I create a hacky lua script to integrate the prediction of this tool in OFS. More information in <a href="user-guide/ofs-integration/index.html">OFS Integration</a>. For the configuration see <a href="user-guide/config/index.html">this</a> Documentation page.</p>
+<p><strong>NOTE:</strong> The Tool could also use as an standalone application with an build in UI. Due to the limitations it is not intended for productive use.</p>
 <h2 id="user-guide">User-Guide</h2>
 <ul>
 <li><a href="user-guide/algorithms/index.html">Algorithms</a></li>
+<li><a href="user-guide/build/index.html">Build</a></li>
+<li><a href="user-guide/config/index.html">Config</a></li>
 <li><a href="user-guide/ofs-integration/index.html">OFS Integration</a></li>
 <li><a href="user-guide/ui/index.html">UI</a></li>
 </ul></div>
@@ -194,5 +204,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.1.2
-Build Date UTC : 2021-06-26 06:43:36.336324+00:00
+Build Date UTC : 2021-06-26 10:02:28.282446+00:00
 -->