Merge pull request #1087 from jellyfin/dev

Cleanup build instructions and scripts

Author: Andrew Rabert

.github/workflows/build-macos.yml

@@ -41,11 +41,21 @@ jobs:
         cmake --build build --target install
     - name: Sign and create dmg
       run: |
-        codesign --force --deep -s - "./output/Jellyfin Desktop.app/"
+        codesign --force --deep -s - "./build/output/Jellyfin Desktop.app/"
         brew install create-dmg
-        create-dmg --volname "Jellyfin Desktop" --no-internet-enable "Jellyfin Desktop.dmg" "./output/Jellyfin Desktop.app"
+        VERSION=$(cat VERSION)
+        ARCH=$(uname -m)
+        DMG_NAME="JellyfinDesktop-${VERSION}-${ARCH}.dmg"
+        create-dmg \
+          --volname "Jellyfin Desktop v${VERSION}" \
+          --no-internet-enable \
+          --window-size 500 300 \
+          --icon-size 100 \
+          --icon "Jellyfin Desktop.app" 125 150 \
+          --app-drop-link 375 150 \
+          "${DMG_NAME}" "./build/output/Jellyfin Desktop.app"
     - name: Archive production artifacts
       uses: actions/upload-artifact@v4
       with:
         name: ${{ matrix.artifact }}
-        path: ${{ github.workspace }}/Jellyfin Desktop.dmg
+        path: ${{ github.workspace }}/JellyfinDesktop-*.dmg

.gitignore

@@ -2,35 +2,18 @@
 !/.github/**
 *.pro.user*
 dependencies/*
-CMakeLists.txt.user
-CMakeLists.txt.user.*
-build/*
-build_deps/*
+/build/*
 deps/*
-build_vs_debug/*
+dev/windows/deps/
+dev/macos/deps/
 .idea
-.install_pkg
-.openelec-unpack
-QtCreatorDeployment.txt
-vagrant/ubuntu-x86_64/.vagrant
-vagrant/windows-x86_64/.vagrant
-build-*
-cmake-build-*
 *.pyc
-conaninfo.txt
-conanbuildinfo.*
-web-client
 .DS_Store
 .*libreelec*
-toolchain.cmake
-.sublime-settings
-.last_wc_version
 debian/*.debhelper.log
 debian/.debhelper/
 debian/jellyfin-desktop/
 debian/files
 debian/jellyfin-desktop.substvars
 debian/debhelper-build-stamp
-dist.zip
-obj-x86_64-linux-gnu/
 deployment/dist

.vscode/c_cpp_properties.json

@@ -32,9 +32,9 @@ add_custom_target(innosetup_install
 
 # Determine architecture string for output filename
 if(CMAKE_SIZEOF_VOID_P MATCHES 8)
-  set(INSTALLER_ARCH_STR windows-x64)
+  set(INSTALLER_ARCH_STR x64)
 else()
-  set(INSTALLER_ARCH_STR windows-x86)
+  set(INSTALLER_ARCH_STR x86)
 endif()
 
 set(INSTALLER_BASE_NAME "JellyfinDesktop-${VERSION_STRING}-${INSTALLER_ARCH_STR}")

.vscode/settings.json

@@ -1,184 +1,32 @@
 # Jellyfin Desktop
+
 Jellyfin desktop client built with Qt WebEngine and [libmpv](https://github.com/mpv-player/mpv). Supports audio passthrough, hardware decoding, and playback of more formats without transcoding.
 
 ![Screenshot of Jellyfin Desktop](screenshots/video_player.png)
 
-Downloads:
- - [Windows, Mac, and Linux Releases](https://github.com/jellyfin/jellyfin-desktop/releases)
-   - Note for Mac users: builds for Intel require macOS 12+ and Apple Silicon builds requires macOS 14+
- - [Flathub (Linux)](https://flathub.org/apps/details/org.jellyfin.JellyfinDesktop)
-
-Related Documents:
- - Web client: Application uses server-provided web client.
- - Web client integration documentation: [for-web-developers.md](https://github.com/jellyfin/jellyfin-desktop/blob/master/for-web-developers.md)
- - API Docs in [client-api.md](https://github.com/jellyfin/jellyfin-desktop/blob/master/client-api.md)
- - Tip: For help building, look at the GitHub Actions file!
-
-## Building at a glance (Linux)
-
-To download the latest stable release, get the latest version tag from the [latest releases page](https://github.com/jellyfin/jellyfin-desktop/releases/latest) and append the following to your pull command during the build phase for JMP "--branch $VERSIONTAG --single-branch"
-
-Example:
-```bash
-git clone --recursive https://github.com/jellyfin/jellyfin-desktop.git --branch v1.9.1 --single-branch
-```
-
-
-### Ubuntu based systems
-
-Install dependencies:
-```bash
-sudo apt install  autoconf automake build-essential cmake curl g++ git libasound2-dev libcec-dev libegl1-mesa-dev libfontconfig1-dev libfreetype6-dev libfribidi-dev libgl1-mesa-dev libgnutls28-dev libharfbuzz-dev libpulse-dev libsdl2-dev libtool libuchardet-dev libva-dev libvdpau-dev libx11-dev libxrandr-dev mesa-common-dev meson qml6-module-qtqml-workerscript qml6-module-qtquick-controls qml6-module-qtquick-templates qml6-module-qtquick-window qml6-module-qtwebchannel qml6-module-qtwebengine qml6-module-qtwebengine-controlsdelegates qml6-module-qtwebview qt6-base-private-dev qt6-webengine-private-dev unzip wget yasm zlib1g-dev
-mkdir ~/jmp; cd ~/jmp
-git clone https://github.com/mpv-player/mpv-build.git
-cd mpv-build
-./use-mpv-release
-./update
-echo -Dlibmpv=true > mpv_options
-./rebuild -j$(nproc)
-sudo ./install
-sudo ln -s /usr/local/lib/x86_64-linux-gnu/libmpv.so /usr/local/lib/x86_64-linux-gnu/libmpv.so.1
-sudo ln -sf /usr/local/lib/x86_64-linux-gnu/libmpv.so /usr/local/lib/libmpv.so.2
-sudo ldconfig
-cd ~/jmp/
-git clone --recursive https://github.com/jellyfin/jellyfin-desktop.git
-cd jellyfin-desktop
-mkdir build
-cd build
-cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=/usr/local/ -G Ninja ..
-ninja
-sudo ninja install
-rm -rf ~/jmp/
-```
-
-### Fedora based systems
-
-Install dependencies:
-```bash
-sudo dnf install autoconf automake libtool freetype-devel libXrandr-devel libvdpau-devel libva-devel  mesa-libGL-devel libdrm-devel libX11-devel  mesa-libEGL-devel yasm  alsa-lib pulseaudio-libs-devel zlib-devel fribidi-devel git gnutls-devel mesa-libGLU-devel  SDL2-devel cmake wget g++ qt-devel libcec-devel qt6-qtbase-devel curl unzip qt6-qtwebchannel-devel qt6-qtwebengine-devel mpv.x86_64 qt6-qtbase.x86_64 meson.noarch ninja-build.x86_64 qt6-qtbase-private-devel mpv-libs.x86_64 mpv-devel qt6-qtdeclarative nasm libatomic libshaderc mpvqt-devel
-```
-
-Build commands for Fedora:
-
-Note, the only real differences here is that libraries are in diffrent directories on Fedora systems.
-```bash
-mkdir ~/jmp; cd ~/jmp
-git clone https://github.com/mpv-player/mpv-build.git
-cd mpv-build/
-echo -Dlibmpv=true > mpv_options
-echo -Dpipewire=disabled >> mpv_options # hopefully temporary
-./rebuild -j`nproc`
-sudo ./install
-sudo mkdir /usr/local/lib/x86_64-linux-gnu
-sudo ln -s /usr/local/lib64/libmpv.so /usr/local/lib/x86_64-linux-gnu/libmpv.so.1
-sudo ln -s /usr/local/lib64/libmpv.so /usr/local/lib/x86_64-linux-gnu/libmpv.so
-sudo ldconfig
-cd ~/jmp/
-git clone --recursive https://github.com/jellyfin/jellyfin-desktop.git
-cd jellyfin-desktop/
-mkdir build
-cd build/
-cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=/usr/local/ ..
-make -j`nproc`
-sudo make install
-```
-
-## Building for Windows
-
-Please install:
- - [cmake](https://cmake.org/download/) - cmake-3.20.0-windows-x86_64.msi
-   - Add cmake to the path.
- - [ninja](https://github.com/ninja-build/ninja/releases)
-   - Place this in the build directory.
- - [QT](https://www.qt.io/download-thank-you?hsLang=en)
-   - This package is huge. You also need to make a QT account...
-   - Check "MSVC 2019 64-bit" and "Qt WebEngine" under Qt 6.
- - [VS2019 Build Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019)
-   - Again this will use a lot of disk space. The installer is small though.
- - [libmpv1](https://sourceforge.net/projects/mpv-player-windows/files/libmpv/)
-   - Place the contents in the build directory, in a subfolder called `mpv`.
-   - Move the contents of the `include` folder to an `mpv` folder inside the `include` folder.
-   - Move the `mpv-1.dll` to `mpv.dll`.
- - [WIX](https://wixtoolset.org/releases/v3.11.2/stable)
-
-You need to run these commands in git bash.
-
-```bash
-git clone --recursive https://github.com/jellyfin/jellyfin-desktop
-cd jellyfin-desktop
-mkdir build
-cd build
-```
-
-Open the "x86_x64 Cross Tools Command Prompt for VS 2019". `cd` to the `build` directory. Run:
-
-```
-set PATH=%PATH%;C:\Program Files (x86)\WiX Toolset v3.11\bin
-cmake -GNinja -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_INSTALL_PREFIX=output -DCMAKE_MAKE_PROGRAM=ninja.exe -DQTROOT=C:/Qt/6.x.x/msvc2019_64 -DMPV_INCLUDE_DIR=mpv/include -DMPV_LIBRARY=mpv/libmpv-2.dll -DCMAKE_INSTALL_PREFIX=output ..
-lib /def:mpv\mpv.def /out:mpv\mpv.dll.lib /MACHINE:X64
-ninja
-ninja windows_package
-```
-
-## Building for MacOS
-```bash
-# Install dependencies
-brew install aqtinstall mpv ninja
-
-# Download Qt
-aqt install-qt mac desktop 6.10.1 -m qtwebengine qtwebchannel qtpositioning
-export QTROOT="$(realpath 6.10.1/macos)"
-
-# Clone and build
-git clone --recursive https://github.com/jellyfin/jellyfin-desktop.git
-cd jellyfin-desktop
-
-cmake -B build -G Ninja \
-  -DQTROOT="$QTROOT" \
-  -DCMAKE_PREFIX_PATH="$QTROOT" \
-  -DCMAKE_BUILD_TYPE=Release \
-  -DCMAKE_INSTALL_PREFIX=output \
-  -DUSE_STATIC_MPVQT=ON
-cmake --build build --target install
-```
-
-## Log File Location
-
- - Windows: `%LOCALAPPDATA%\Jellyfin Desktop\logs`
- - Linux: `~/.local/share/jellyfin-desktop/logs/`
- - Linux (Flatpak): `~/.var/app/org.jellyfin.JellyfinDesktop/data/jellyfin-desktop/logs/`
- - macOS: `~/Library/Logs/Jellyfin Desktop/`
-
-## Config File Location
-
-The main configuration file is called `jellyfin-desktop.conf`. You can also add a `mpv.conf` to configure MPV directly.
-
- - Windows: `%LOCALAPPDATA%\Jellyfin Desktop\`
- - Linux: `~/.local/share/jellyfin-desktop/`
- - Linux (Flatpak): `~/.var/app/org.jellyfin.JellyfinDesktop/data/jellyfin-desktop/`
- - macOS: `~/Library/Application Support/Jellyfin Desktop/`
-
-## Web Debugger
-
-To get browser devtools, use remote debugging.
-
- - Run the application with the command argument `--remote-debugging-port=9222`.
- - Open Chromium or Google Chrome.
- - Navigate to `chrome://inspect/#devices`.
- - You can now access the developer tools.
+## Downloads
+- [Windows, Mac, and Linux Releases](https://github.com/jellyfin/jellyfin-desktop/releases)
+  - Note for Mac users: builds for Intel require macOS 12+ and Apple Silicon builds requires macOS 14+
+- [Flathub (Linux)](https://flathub.org/apps/details/org.jellyfin.JellyfinDesktop)
 
-If you have problems:
+## Building
+See [dev/](dev/) for platform-specific build instructions.
 
- - Make sure "Discover Network Targets" is checked.
- - Make sure `localhost:9222` is in the list under "Configure...".
- - Make sure `--remote-debugging-port=9222` is specified correctly.
+## File Locations
+Data is stored per-profile in a `profiles/<profile-id>/` subdirectory. The main configuration file is `jellyfin-desktop.conf`. You can also add `mpv.conf` to configure MPV directly.
 
-## License
+**Windows:**
+- Config: `%LOCALAPPDATA%\Jellyfin Desktop\profiles\<profile-id>\`
+- Logs: `%LOCALAPPDATA%\Jellyfin Desktop\profiles\<profile-id>\logs\`
 
-Jellyfin Desktop is licensed under GPL v2. See the ``LICENSE`` file.
-Licenses of dependencies are summarized under ``resources/misc/licenses.txt``.
-This file can also be printed at runtime when using the ``--licenses`` option.
+**Linux:**
+- Config: `~/.local/share/jellyfin-desktop/profiles/<profile-id>/`
+- Logs: `~/.local/share/jellyfin-desktop/profiles/<profile-id>/logs/`
 
-## Known Issues
+**Linux (Flatpak):**
+- Config: `~/.var/app/org.jellyfin.JellyfinDesktop/data/jellyfin-desktop/profiles/<profile-id>/`
+- Logs: `~/.var/app/org.jellyfin.JellyfinDesktop/data/jellyfin-desktop/profiles/<profile-id>/logs/`
 
-If you build MPV from source, you currently need to disable pipewire or else the client will segfault.
+**macOS:**
+- Config: `~/Library/Application Support/Jellyfin Desktop/profiles/<profile-id>/`
+- Logs: `~/Library/Logs/Jellyfin Desktop/<profile-id>/`