Skip to content

Commit 98f9f81

Browse files
author
arch
committed
update readme
1 parent 3181e4e commit 98f9f81

File tree

4 files changed

+7
-5
lines changed

4 files changed

+7
-5
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# Python Funscript Editor
22

3-
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.
3+
A small Python program that use use Computer Vision to partially automate the generation of funscripts.
44

5-
**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.
5+
## Getting Started
6+
7+
The application has an build in UI. Due to the limitations (mainly on Windows) it is not intended for productive use. Therefore i create a lua script to integrate the tool in [Open Funscripter (OFS)](https://github.com/OpenFunscripter/OFS). For the Installation see my detailed step by step [OFS Integration instruction](https://github.com/michael-mueller-git/Python-Funscript-Editor/blob/main/docs/app/docs/user-guide/ofs-integration.md). By default the application is configured for 3D Side-By-Side VR Videos. If you want to track 2D Videos you have to manually change the config! Therefore read the [configuration page](https://github.com/michael-mueller-git/Python-Funscript-Editor/blob/main/docs/app/docs/user-guide/config.md) in the application documentation.
68

79
## Documentation
810

docs/app/docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Python Funscript Editor
22

3-
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.
3+
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 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.
44

55
**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.
66

docs/app/docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Python Funscript Editor
22

3-
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.
3+
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 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.
44

55
**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.
66

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Open Funscripter Integration
22

3-
Currently we use a hacky lua script to communicate between the Python Funscript Generator and the Open Funscripter.
3+
We use a lua script to communicate between the Python Funscript Generator and the Open Funscripter.
44

55
## Installation (Windows)
66

0 commit comments

Comments
 (0)