You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/app/docs/user-guide/build.md
+5-62Lines changed: 5 additions & 62 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
For Windows user i recommend to use the release version from [github release page](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases)
4
4
5
-
## Windows 10
5
+
## Windows 10/11
6
6
7
7
We use [pyinstaller](https://pypi.org/project/pyinstaller/) in [miniconda](https://docs.conda.io/en/latest/miniconda.html) environment to create an Windows executable.
8
8
@@ -18,56 +18,9 @@ This create the Windows executable in `./dist`.
18
18
19
19
Finally you can remove the build environment with `conda env remove -n python-funscript-editor`
20
20
21
-
## Ubuntu 20.04 LTS, Ubuntu 21.04, Debian
21
+
## Linux
22
22
23
-
The OpenCV Package in Ubuntu use the GTK Backend for the preview window. This will cause freezes of the UI, because i use Qt threads in my code. The Arch Linux OpenCV library was compiled with QT (see `python3 -c "import cv2; print(cv2.getBuildInformation())"` output) so no problem here. To use the Application on Ubuntu you have to compile `OpenCV + OpenCV contrib` with `-D WITH_QT=ON` flag from source. Or simply use [miniconda](https://docs.conda.io/en/latest/miniconda.html). They include OpenCV compiled with Qt support.
24
-
25
-
**NOTE:** I have also test this setup on Ubuntu 21.04 with Wayland desktop. You can use the setup instructions from Ubuntu 20.04 LTS. The application work with XWayland on the Wayland desktop!
26
-
27
-
### Miniconda
28
-
29
-
After you have setup [miniconda](https://docs.conda.io/en/latest/miniconda.html) on your machine simply type the following commands to use Python-Funscript-Editor:
On some distributions e.g. Ubuntu 20.04 LTS, the FFmpeg package does not contain the required `v360` filter. Therefore you can download a static linked FFmpeg package for this application with `bash download_ffmpeg.sh` from project root directory. (Perform this step if you are not sure if your FFmpeg version is sufficient!). The latest ffmpeg downloaded via `download_ffmpeg.sh` break current MTFG. Therefore you should copy the ffmpeg executable from `./assets` to `./funscript_editor/data` for now.
39
-
40
-
Ubuntu user can alternatively use the `savoury1` ppa:
41
-
42
-
```bash
43
-
sudo add-apt-repository ppa:savoury1/ffmpeg4
44
-
sudo apt install -y ffmpeg
45
-
46
-
```
47
-
48
-
Now you can run the program direct from source code with:
49
-
50
-
```bash
51
-
conda activate funscript-editor
52
-
python3 funscript-editor.py
53
-
```
54
-
55
-
By default the latest code is used which may contain bugs. So you maybe want to switch to the latest release version with `` git checkout $(git describe --tags `git rev-list --tags --max-count=1`)``.
56
-
57
-
You can always update the application to the latest version with `git checkout main && git pull` inside the repository directory.
58
-
59
-
## Arch Linux and Arch-Based Distributions
60
-
61
-
My development platform is Arch Linux. The code should run therefore without problems. When installing the dependencies, make sure you install the following packages from the repositories, as the wrapper will have problems if the versions differ from the pip packages and the local C, C++ libraries.
62
-
63
-
```bash
64
-
sudo pacman -Syu # this ensure the new libraries will be compatible
65
-
sudo pacman -Sy python-opencv python-pyqt5
66
-
```
67
-
68
-
All other required python packages can be installed from pip.
69
-
70
-
The latest ffmpeg break current MTFG. Therefore you should copy the ffmpeg executable from `./assets` to `./funscript_editor/data` for now!!
23
+
To run the application on Linux you need the [nix package manager](https://nixos.org/download.html) with experimental [`flakes` feature enabled](https://github.com/mschwaig/howto-install-nix-with-flake-support).
71
24
72
25
## Flatpak
73
26
@@ -80,16 +33,6 @@ Limitation of the flatpak application:
80
33
- Flatpak need non-privileged user namespaces enabled (`sysctl kernel.unprivileged_userns_clone=1'`).
81
34
- The System-Theme is not applied to the application. The problem is that my recipe use conda packages which isolates the python packages inside the flatpak sandbox and we have no access to the system theme. To fix this we have to build all python packages in the flatpak recipe from source and include the system theme inside the flatpak.
82
35
83
-
## OFS Extension on Linux
84
-
85
-
### OFS 1.x.x
86
-
87
-
Path for extensions is `~/.local/share/OFS/OFS_data/extensions`
88
-
89
-
### OFS 2.x.x
90
-
91
-
Path for extensions is `~/.local/share/OFS/OFS2_data/extensions`
92
-
93
-
### OFS 3.x.x
36
+
## OFS Extension Path on Linux
94
37
95
-
Path for extensions is `~/.local/share/OFS/OFS3_data/extensions`
38
+
Path for extensions is `~/.local/share/OFS/OFSX_data/extensions`
0 commit comments