Installing

From Sources (Git / PyPI)

Prerequisites

Linux

Installation require a compilation toolchain and python headers to compile hidapi (if the wheel (binary package) cannot be used).

On Debian / Ubuntu, this can be installed with the following command:

sudo apt install build-essential python3-dev libusb-1.0-0-dev libudev-dev

On Solus, use the following commands:

sudo eopkg install -c system.devel
sudo eopkg install python3 python3-devel libusb-devel

We will also need Python’s venv module that is packaged separately on Debian / Ubuntu, so you will have to install it with the following command:

sudo apt install python3-venv

Windows

On Windows, you have to install Python first:

Python >= 3.9 (see https://www.python.org/downloads/windows/)

And Vusual C++ build tools are also required to compile hidapi if the weel (binary package) cannot be used:

Visual C++ 2015 Build Tools: https://www.microsoft.com/en-us/download/details.aspx?id=48159

Installing From PyPI

First create a virtualenv using the following command:

python3 -m venv ./rivalcfg.env

This will create a rivalcfg.env folder in the current directory. We will then be able to install Rivalcfg in it with the following command:

On Linux or macOS:

./rivalcfg.env/bin/pip install rivalcfg

On Windows:

.\rivalcfg.env\Scripts\pip install rivalcfg

Installing From GitHub

Clone the repository:

git clone https://github.com/flozz/rivalcfg.git
cd rivalcfg

Then create a virtualenv using:

python3 -m venv ./rivalcfg.env

This will create a rivalcfg.env folder in the current directory. Finally, install Rivalcfg in it with the following command:

On Linux or macOS:

./rivalcfg.env/bin/pip install rivalcfg

On Windows:

.\rivalcfg.env\Scripts\pip install rivalcfg

After the installation (Linux)

Once Rivalcfg installed from sources (Git or PyPI), you will have to run the following command on udev-based Linux distro (Debian / Ubuntu / Fedora / …):

sudo ./rivalcfg.env/bin/rivalcfg --update-udev

Running Rivalcfg from the CLI

On Linux and macOS:

./rivalcfg.env/bin/rivalcfg --help

On Windows:

.\rivalcfg.env\Scripts\rivalcfg --help

Running Rivalcfg from a script (Bash)

To run Rivlacfg from a shell script, you can import the virtualenv at the start of the script (before calling the rivalcfg command for the first time).

Example:

#!/bin/bash

# Import the virtualenv
source /path/to/rivalcfg.env/bin/activate

# Call Rivalcfg
rivalcfg --help

Archlinux AUR Package

Use package rivalcfg

Warning

This package is no longer maintained.