stash/ui/v2.5/src/docs/en/Interactive.md
UnluckyChemical765 547f6d79ad
Add Handy / Funscript support (#1377)
* Add funscript route to scenes

Adds a /scene/:id/funscript route which serves a funscript file, if present.

Current convention is that these are files stored with the same path, but with the extension ".funscript".

* Look for funscript during scan

This is stored in the Scene record and used to drive UI changes for funscript support.

Currently, that's limited to a funscript link in the Scene's file info.

* Add filtering and sorting for interactive
* Add Handy connection key to interface config
* Add Handy client and placeholder component.

Uses defucilis/thehandy, but not thehandy-react as I had difficulty integrating the context with the existing components.

Instead, the expensive calculation for the server time offset is put in localStorage for reuse.

A debounce was added when scrubbing the video, as otherwise it spammed the Handy API with updates to the current offset.
2021-05-24 13:34:28 +10:00

529 B

Stash currently supports syncing with Handy devices, using funscript files.

In order for stash to connect to your Handy device, the Handy Connection Key must be entered in Settings -> Interface.

Funscript files must be in the same directory as the matching video file and must have the same base name. For example, a funscript file for video.mp4 must be named video.funscript. A scan must be run to update scenes with matching funscript files.

Scenes with funscript files can be filtered with the interactive criterion.