Skip to content

Commit a78cf1f

Browse files
author
arch
committed
update trobleshot section
1 parent 0237704 commit a78cf1f

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

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

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -45,41 +45,41 @@ We use a `lua` script to communicate between the Python Funscript Generator and
4545
<br> ![Assign an Shortcut](./images/ofs_integration_08.jpg)
4646
10. Now you can use the shortcut in OFS at any position in the video to start the funscript generator.
4747

48-
## Troubleshot
48+
## Troubleshot for all Installation Options
4949

50-
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!
50+
### When calling the generator, only a message box is displayed with the message: "Video file was not specified!"
5151

52-
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.
52+
In some cases OFS does not set the path to the video file within the lua script correctly (the variable `VideoFilePath` is empty). This happen when the video path contains some special character like square braked `[` and `]`. **Rename your video files and store them in a path without special character**. Then the variable should be set by OFS and the motion tracking funscript generator should work.
5353

54-
### After setting the min and max value after tracking no points are inserted in OFS
54+
### Tracking stops automatically
5555

56-
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!
56+
If a tacker does not find the selected feature in the next frame, the tracking process stops. If more than 90 frames have already been tracked, a window appears to select the minimum and maximum value in which the reason for the abort is displayed with e.g. `Info: Tracker Woman Lost`.
5757

58-
### Noting happens when i press the Shortcut for the Funscript Generator
58+
If less than 90 frames have been processed, a message box should pop up with the message `Tracking time insufficient`. In this case, no output is generated because there is not enough data for the algorithm to work with.
5959

60-
In most cases, the variable `Settings.FunscriptGenerator` in the `funscript_generator.lua` script was not set correctly.
60+
### Tracking stops very often
6161

62-
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.
62+
The selection of the tracking feature is tricky and requires some practice and experience. For a good tracking result, unique features in the video should be selected near the desired tacking position.
6363

64-
**Important:** You have to use use `/` or `\\` for the `\` symbols in your path!
64+
## Troubleshot for Installation Option 2
6565

66-
### When calling the generator, only a message box is displayed with the message: "Video file was not specified!"
66+
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!
6767

68-
In some cases OFS does not set the path to the video file within the lua script correctly (the variable `VideoFilePath` is empty). This happen when the video path contains some special character like square braked `[` and `]`. Rename your video files and store them in a path without special character. Then the variable should be set by OFS and the motion tracking funscript generator should work.
68+
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.
6969

70-
### When press shortcut the message "C:\Users\\...” is not recognized as an internal or external command, operable program or batch file appears in the terminal output.
70+
#### Noting happens when i press the Shortcut for the Funscript Generator
7171

72-
The path you have set in `Settings.FunscriptGenerator` does not exist. You have an typo in the path or forget an parent directory. Double check the complete path string!
72+
In most cases, the variable `Settings.FunscriptGenerator` in the `funscript_generator.lua` script was not set correctly.
7373

74-
### Tracking stops automatically
74+
**Important:** You have to use use `/` or `\\` for the `\` symbols in your path!
7575

76-
If a tacker does not find the selected feature in the next frame, the tracking process stops. If more than 120 frames have already been tracked, a window appears to select the minimum and maximum value in which the reason for the abort is displayed with e.g. `Info: Tracker Woman Lost`.
76+
#### When press shortcut the message "C:\\Users\\...” is not recognized as an internal or external command, operable program or batch file appears in the terminal output.
7777

78-
If less than 120 frames have been processed, a message box should pop up with the message `Tracking time insufficient`. In this case, no output is generated because there is not enough data for the algorithm to work with.
78+
The path you have set in `Settings.FunscriptGenerator` does not exist. You have an typo in the path or forget an parent directory. Double check the complete path string!
7979

80-
### Tracking stops very often
80+
### After setting the min and max value after tracking no points are inserted in OFS
8181

82-
The selection of the tracking feature is tricky and requires some practice and experience. For a good tracking result, unique features in the video should be selected near the desired tacking position.
82+
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!
8383

8484
### The standalone application `funscript-editor.exe` show only a black console window
8585

0 commit comments

Comments
 (0)