Skip to content

Commit 4137f98

Browse files
author
arch
committed
improve ofs integration doc
1 parent 897867c commit 4137f98

File tree

9 files changed

+11
-3
lines changed

9 files changed

+11
-3
lines changed
23.2 KB
Loading
23.5 KB
Loading
23.5 KB
Loading
61.8 KB
Loading
97.3 KB
Loading
46.8 KB
Loading
86 KB
Loading
86.8 KB
Loading

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

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,24 @@ Currently we use a hacky lua script to communicate between the Python Funscript
55
## Installation (Windows)
66

77
1. Download the **latest** packed Python Funscript Editor from [github release page](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases).
8+
![Funscript Editor Windows Release](./images/ofs_integration_01.jpg)
89
2. Extract the Archiv.
10+
![Extract Python Funscript Editor Windows Release](./images/ofs_integration_02.jpg)
911
3. Download the **latest** `funscript_generator.lua` script from [github release page](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases).
12+
![OFS integration Windows Release](./images/ofs_integration_03.jpg)
1013
4. Move the downloaded `funscript_generator.lua` script to `data/lua` in your OFS directory.
14+
![Copy the OFS integration script to the lua folder](./images/ofs_integration_04.jpg)
1115
5. Open the `funscript_generator.lua` file and adjust the `Settings.FunscriptGenerator` and `Settings.TmpFile` variable.
12-
- **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.
13-
- `Settings.FunscriptGenerator`: Point to the extracted Python Funscript Editor program (better double check the complete path string to avoid errors later on).
14-
- `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!
16+
<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.
17+
<br> - `Settings.FunscriptGenerator`: Point to the extracted Python Funscript Editor program (better double check the complete path string to avoid errors later on).
18+
<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!
19+
![Adjust Settings/Variables in the lua Script](./images/ofs_integration_05.jpg)
1520
6. Now launch OFS.
21+
![Start OFS](./images/ofs_integration_06.jpg)
1622
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`.
23+
![Enable OFS Integration](./images/ofs_integration_07.jpg)
1724
8. Navigate to `Options : Keys : Dynamic` and insert a shortcut for the funscript generator.
25+
![Assign an Shortcut](./images/ofs_integration_08.jpg)
1826
9. Now you can use the shortcut at any position in the video to start the funscript generator.
1927

2028
## Troubleshot

0 commit comments

Comments
 (0)