improve troubleshot section for ofs integration

Author: arch

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

@@ -19,16 +19,22 @@ Currently we use a hacky lua script to communicate between the Python Funscript
 
 ## Troubleshot
 
+If you have problems with the OFS integration setup first test if the app work in standalone mode by starting the `funscript-editor.exe`. This allows the source of the error to be narrowed down more quickly!
+
+If the standalone application works, look for your problem in the issues listed below. If the standalone application not work or your issue was not solved by a point listed below, open an issue with a detailed problem description and the full terminal window output if available.
+
 ### After setting the min and max value after tracking no points are inserted in OFS
 
-If the points are missing in OFS then most likely the variable `Settings.TmpFile` in the `funscript_generator.lua` script is set incorrectly.
+If the points are missing in OFS then most likely the variable `Settings.TmpFile` in the `funscript_generator.lua` script is set incorrectly or the generator crashes. A crash could happen if your PC does not have enough memory. The amount of memory required depends heavily on the video resolution!
 
 ### Noting happens when i press the Shortcut for the Funscript Generator
 
 In most cases, the variable `Settings.FunscriptGenerator` in the `funscript_generator.lua` script was not set correctly.
 
 If you are using an older version of the `funscript_generator.lua` you should download the latest version of the script from the [github release page](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases). With older `funscript_generator.lua` scripts there were e.g. problems with blanks in the path.
 
+**Important:** You have to use use `/` or `\\` for the `\` symbols in your path!
+
 ### When calling the generator, only a message box is displayed with the message: "Video file was not specified!"
 
 In some cases OFS does not set the path to the video file within the lua script correctly (the variable `VideoFilePath` is empty). Mostly it helps to save the current project and/or create a new project. Then the variable should be set by OFS and the generator should work.

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-06-27 07:47:45.353935+00:00
+Build Date UTC : 2021-06-27 07:58:17.009150+00:00
 -->

docs/app/site/search/search_index.json

@@ -132,11 +132,14 @@ <h2 id="installation-windows">Installation (Windows)</h2>
 <li>Now you can use the shortcut at any position in the video to start the funscript generator.</li>
 </ol>
 <h2 id="troubleshot">Troubleshot</h2>
+<p>If you have problems with the OFS integration setup first test if the app work in standalone mode by starting the <code>funscript-editor.exe</code>. This allows the source of the error to be narrowed down more quickly!</p>
+<p>If the standalone application works, look for your problem in the issues listed below. If the standalone application not work or your issue was not solved by a point listed below, open an issue with a detailed problem description and the full terminal window output if available.</p>
 <h3 id="after-setting-the-min-and-max-value-after-tracking-no-points-are-inserted-in-ofs">After setting the min and max value after tracking no points are inserted in OFS</h3>
-<p>If the points are missing in OFS then most likely the variable <code>Settings.TmpFile</code> in the <code>funscript_generator.lua</code> script is set incorrectly.</p>
+<p>If the points are missing in OFS then most likely the variable <code>Settings.TmpFile</code> in the <code>funscript_generator.lua</code> script is set incorrectly or the generator crashes. A crash could happen if your PC does not have enough memory. The amount of memory required depends heavily on the video resolution!</p>
 <h3 id="noting-happens-when-i-press-the-shortcut-for-the-funscript-generator">Noting happens when i press the Shortcut for the Funscript Generator</h3>
 <p>In most cases, the variable <code>Settings.FunscriptGenerator</code> in the <code>funscript_generator.lua</code> script was not set correctly.</p>
 <p>If you are using an older version of the <code>funscript_generator.lua</code> you should download the latest version of the script from the <a href="https://github.com/michael-mueller-git/Python-Funscript-Editor/releases">github release page</a>. With older <code>funscript_generator.lua</code> scripts there were e.g. problems with blanks in the path.</p>
+<p><strong>Important:</strong> You have to use use <code>/</code> or <code>\\</code> for the <code>\</code> symbols in your path!</p>
 <h3 id="when-calling-the-generator-only-a-message-box-is-displayed-with-the-message-video-file-was-not-specified">When calling the generator, only a message box is displayed with the message: "Video file was not specified!"</h3>
 <p>In some cases OFS does not set the path to the video file within the lua script correctly (the variable <code>VideoFilePath</code> is empty). Mostly it helps to save the current project and/or create a new project. Then the variable should be set by OFS and the generator should work.</p>
 <h3 id="tracking-stops-automatically">Tracking stops automatically</h3>