Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/equeim/tremotesf2

Remote GUI for transmission-daemon
https://github.com/equeim/tremotesf2

qt sailfishos torrent transmission

Last synced: 2 months ago
JSON representation

Remote GUI for transmission-daemon

Awesome Lists containing this project

README 

        
# Tremotesf

Remote GUI for transmission-daemon. Supports GNU/Linux and Windows.



Table of Contents

=================



   * [Tremotesf](#tremotesf)

   * [Table of Contents](#table-of-contents)

      * [Installation](#installation)

         * [Dependencies](#dependencies)

         * [Building](#building)

         * [GNU/Linux](#gnulinux)

         * [FreeBSD](#freebsd)

         * [Windows](#windows)

         * [macOS](#macos)

      * [Translations](#translations)

      * [Screenshots](#screenshots)



## Installation

### Dependencies

- C++ compiler with partial C++20 support. Minimum tested versions of GCC and Clang toolchains:

  1. GCC 12

  2. Clang 17 with libstdc++ 13

  3. Clang 17 with libc++ 17

- CMake 3.25 or newer

- Qt 6.6 or newer or 5.15 (Core, Network, Gui, Widgets modules)

- fmt 9.1 or newer

- KWidgetsAddons 5.103 or newer

- libpsl 0.21.2 or newer

- cxxopts 3.1.1 or newer

- Qt Test module (for tests only)

- OpenSSL 1.1.1 or newer (for tests only)

- cpp-httplib 0.11.0 or newer (for tests only, optional)



On GNU/Linux and BSD, also:

- Gettext 0.21 or newer

- Qt D-Bus module

- KWindowSystem (with Qt5/KF5 kwayland-integration is also needed as runtime dependency)

- Qt's SVG image format plugin as a runtime dependency (usually located somewhere at /usr/lib64/qt6/plugins/imageformats/libqsvg.so)



On Windows, also:

- Windows 11 SDK is needed to build

- Minimum supported OS version to run Tremotesf is Windows 10 1809 (October 2018 Update)



On macOS, also:

- Latest Xcode and macOS SDK versions supported by Qt (see [here](https://doc.qt.io/qt-6/macos.html))

- Minimum supported OS version to run Tremotesf is macOS 12



### Building

```sh

cmake -S /path/to/sources -B /path/to/build/directory --preset base-multi

cmake --build /path/to/build/directory --config Debug

cmake --install /path/to/build/directory --config Debug --prefix /path/to/install/directory

```

This example uses base-multi preset in CMakePresets.json and Ninja Multi-Config generator.

You can invoke CMake in a different way if you want.



CMake configuration options:



`TREMOTESF_QT6` - boolean, determines whether Qt 6 or Qt 5 will be used.



`TREMOTESF_WITH_HTTPLIB` - determines how cpp-httplib test dependency is searched. Possible values:

  - auto: CMake find_package call, otherwise pkg-config, otherwise bundled copy is used.

  - system: CMake find_package call, otherwise pkg-config, otherwise fatal error.

  - bundled: bundled copy is used.

  - none: cpp-httplib is not used at all and tests that require it are disabled.



### GNU/Linux

- Flatpak - [Flathub](https://flathub.org/apps/details/org.equeim.Tremotesf)



- Arch Linux - [AUR](https://aur.archlinux.org/packages/tremotesf)



- Debian - [Official repository](https://packages.debian.org/sid/tremotesf), or [my own OBS repository](https://build.opensuse.org/package/show/home:equeim:tremotesf/Tremotesf)



```sh

debian_version="$(source /etc/os-release && echo "$VERSION_ID")"

wget -qO - "https://download.opensuse.org/repositories/home:/equeim:/tremotesf/Debian_${debian_version}/Release.key" | sudo tee /etc/apt/trusted.gpg.d/tremotesf.asc

sudo add-apt-repository "deb http://download.opensuse.org/repositories/home:/equeim:/tremotesf/Debian_${debian_version}/ /"

sudo apt update

sudo apt install tremotesf

```



- Fedora - [Copr](https://copr.fedorainfracloud.org/coprs/equeim/tremotesf)

```sh

sudo dnf copr enable equeim/tremotesf

sudo dnf install tremotesf

```



- Gentoo - [equeim-overlay](https://github.com/equeim/equeim-overlay)



- Mageia - [Copr](https://copr.fedorainfracloud.org/coprs/equeim/tremotesf)

```sh

sudo dnf copr enable equeim/tremotesf

sudo dnf install tremotesf

```



- openSUSE Tumbleweed - [OBS](https://build.opensuse.org/package/show/home:equeim:tremotesf/Tremotesf)

```sh

sudo zypper ar https://download.opensuse.org/repositories/home:/equeim:/tremotesf/openSUSE_Tumbleweed/home:equeim:tremotesf.repo

sudo zypper in tremotesf

```



- Ubuntu - [OBS](https://build.opensuse.org/package/show/home:equeim:tremotesf/Tremotesf)



```sh

ubuntu_version="$(source /etc/os-release && echo "$VERSION_ID")"

wget -qO - "https://download.opensuse.org/repositories/home:/equeim:/tremotesf/xUbuntu_${ubuntu_version}/Release.key" | sudo tee /etc/apt/trusted.gpg.d/tremotesf.asc

sudo add-apt-repository "deb http://download.opensuse.org/repositories/home:/equeim:/tremotesf/xUbuntu_${ubuntu_version}/ /"

sudo apt update

sudo apt install tremotesf

```



### FreeBSD

Tremotesf is [available in FreeBSD ports](https://www.freshports.org/net-p2p/tremotesf/).



### Windows

Windows builds are available at [releases](https://github.com/equeim/tremotesf2/releases) page.

Minimum supported OS version to run Tremotesf is Windows 10 1809 (October 2018 Update).



Build instructions for MSVC toolchain with vcpkg:

1. Install Visual Studio with 'Desktop development with C++' workload

2. Install latest version of CMake (from cmake.org or Visual Studio installer)

3. Install and setup [vcpkg](https://github.com/microsoft/vcpkg#quick-start-windows), and make sure that you have 15 GB of free space on disk where vcpkg is located

4. Set VCPKG_ROOT environment variable to the location of vcpkg installation



When building from Visual Studio GUI, make sure to select 'Windows Debug' or 'Windows Release' configure preset.

Otherwise:

Launch x64 Command Prompt for Visual Studio, execute:

```pwsh

cmake -S path\to\sources -B path\to\build\directory --preset 

# Initial compilation of dependencies will take a while

cmake --build path\to\build\directory

cmake --install path\to\build\directory --prefix path\to\install\directory

# Next command creates ZIP archive and MSI installer

cmake --build path\to\build\directory --target package

```



### macOS

macOS builds are available at [releases](https://github.com/equeim/tremotesf2/releases) page.

Minimum supported OS version to run Tremotesf is macOS 12.



Build instructions with vcpkg:

1. Install Xcode

2. Install CMake

3. Install and setup [vcpkg](https://github.com/microsoft/vcpkg#quick-start-windows), and make sure that you have 15 GB of free space on disk where vcpkg is located

4. Set VCPKG_ROOT environment variable to the location of vcpkg installation

5. Launch terminal, execute:

```sh

cmake -S path/to/sources -B path/to/build/directory --preset 

# Initial compilation of dependencies will take a while

cmake --build path/to/build/directory

cmake --install path/to/build/directory --prefix path/to/install/directory

# Next command creates DMG image

cmake --build path/to/build/directory --target package

```



## Translations

Translations are managed on [Transifex](https://www.transifex.com/equeim/tremotesf).



## Screenshots

![](https://github.com/equeim/tremotesf-screenshots/raw/master/desktop-1.png)

![](https://github.com/equeim/tremotesf-screenshots/raw/master/desktop-2.png)

![](https://github.com/equeim/tremotesf-screenshots/raw/master/desktop-3.png)

![](https://github.com/equeim/tremotesf-screenshots/raw/master/desktop-4.png)