# Python Funscript Editor

[![Documentation Status](https://readthedocs.org/projects/python-funscript-editor/badge/?version=latest)](https://python-funscript-editor.readthedocs.io/en/latest/?badge=latest) [![Maintenance](https://img.shields.io/maintenance/yes/2024.svg)](https://github.com/michael-mueller-git/Python-Funscript-Editor) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) ![GitHub repo size](https://img.shields.io/github/repo-size/michael-mueller-git/Python-Funscript-Editor) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/michael-mueller-git/Python-Funscript-Editor)](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases/latest) [![GitHub release (latest by date)](https://img.shields.io/github/downloads/michael-mueller-git/Python-Funscript-Editor/latest/total)](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases/latest)

Simple Funscript Editor written in Python with an motion tracking add-on to partially automate the generation of funscripts for static video scenes like vr videos.

## Getting Started

Python Funscript Editor has an simple UI to perform basic operations to generate a funscript. Due to the UI limitations it is not intended for productive use. Therefore i create a lua script to integrate the motion tracking funscript generator (MTFG) 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). Advanced user should 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.

## Documentation

The full application documentation is located in [`./docs/app/docs`](https://github.com/michael-mueller-git/Python-Funscript-Editor/blob/main/docs/app/docs)

## License

Distributed under the MIT License. See `LICENSE` for more information.