update install instructions

Author: arch

contrib/OpenFunscripter/README.md

@@ -1,33 +1,13 @@
 # Open Funscripter Integration
 
-A hacky lua script to use the python funscript generator scripts in Open Funscripter. Copy the lua script (`funscript_generator.lua`) to `data/lua` in your OFS directory. Then adjust the python script path in OFS or direct in the source code. Finally add an shortcut for the script in OFS. The script was only tested on Linux!
+A hacky lua script to use the python funscript generator script in Open Funscripter.
 
-## Memo for developer
+## Installation
 
-**NOTE:** We should use luasockets for the communication but i could not get them to work. I install the lua socket module with `pacman -Sy lua-socket` and compile OFS with dynamic linked library support for lua. But when i load the socket module i got an exception `Symbol not found: some_symbol_name`.
-
-Below the code i used for my first lua socket test:
-
-```lua
-package.cpath ="/usr/lib/lua/5.4/?.so;" .. package.cpath
-package.path = "/usr/share/lua/5.4/?.lua;" .. package.path
-
-local HOST, PORT = "localhost", 9090
-local socket = require('socket')
-
-client, err = socket.connect(HOST, PORT)
-client:setoption('keepalive', true)
-
--- Attempt to ping the server once a second
-start = os.time()
-while true do
-  now = os.time()
-  if os.difftime(now, start) >= 1 then
-    data = client:send("Hello World")
-    -- Receive data from the server and print out everything
-    s, status, partial = client:receive()
-    print(data, s, status, partial)
-    start = now
-  end
-end
-```
+1. Download the packed Python Funscript Editor from [github release page](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases).
+2. Extract the Archiv.
+3. Copy the `funscript_generator.lua` script to `data/lua` in your OFS directory.
+4. Open the `funscript_generator.lua` file and adjust the `Settings.FunscriptGenerator` and `Settings.TmpFile` variable.
+5. 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).
+7. Navigate to `Options : Keys : Dynamic` and insert a shortcut for the funscript generator.

contrib/OpenFunscripter/funscript_generator.lua

@@ -1,12 +1,12 @@
 Settings = {}
-Settings.PythonScript = "/home/arch/Repos/private/stroker-robot/Code/Python Funscript Editor/main.py"
-Settings.TmpFile = "/tmp/funscript_actions.csv"
+Settings.FunscriptGenerator = "C:\\Users\\win10\\Desktop\\funscript-editor\\funscript-editor.exe"
+Settings.TmpFile = "C:\\Users\\win10\\AppData\\Local\\Temp\\funscript_actions.csv"
 SetSettings(Settings)
 
 function GetActions(video)
     local at = {}
     local pos = {}
-    local command = 'python3 "'..Settings.PythonScript..'" --generator -s '..tostring(CurrentTimeMs)..' -i "'..video..'" -o "'..Settings.TmpFile..'"'
+    local command = Settings.FunscriptGenerator..' --generator -s '..tostring(CurrentTimeMs)..' -i "'..video..'" -o "'..Settings.TmpFile..'"'
     print(command)
     os.execute(command)
     local f = io.open(Settings.TmpFile)
@@ -30,7 +30,8 @@ function GetActions(video)
 end
 
 print('start funscript generator')
-local video = VideoFilePath -- you have to set the metadata at OFS start
+local video = VideoFilePath -- NOTE: do not use special character in the video path!
+print('video file: ', video)
 local actions = {GetActions(video)}
 for i = 1, #actions[1] do
     CurrentScript:AddActionUnordered(tonumber(actions[1][i]), tonumber(actions[2][i]), true, 0)

funscript_editor/ui/minimal.py

@@ -49,6 +49,7 @@ def __init__(self, video_file, start_time, output_file):
             sys.exit()
 
         if not os.path.exists(video_file):
+            if video_file == "": video_file = "EMPTY"
             self.__logger.error("Video file not found: %s", video_file)
             self.__show_message("Video file not found ({})".format(video_file))
             sys.exit()