Nicotine+

Testing

For those who like living on the bleeding edge, you can run the latest test build of Nicotine+ to test recent changes and bug fixes.

For information about Nicotine+ development procedures for maintainers, developers and code contributors, see DEVELOPING.md.

If you want to download the current stable version of Nicotine+, see DOWNLOADS.md.

GNU/Linux

PPA (Ubuntu/Debian)

To use the latest 3.4.0.dev1 packages on Ubuntu and Debian, add the nicotine-team/unstable PPA repository.

On Ubuntu and distributions based on it (e.g. Linux Mint, elementary OS, Pop!_OS, various Ubuntu flavors), run the following:

sudo add-apt-repository ppa:nicotine-team/unstable
sudo apt update; sudo apt install nicotine

On Debian and distributions based on it (e.g. Devuan, Peppermint OS), run the following:

sudo apt update; sudo apt install python3-launchpadlib software-properties-common
sudo add-apt-repository 'deb https://ppa.launchpadcontent.net/nicotine-team/unstable/ubuntu jammy main'
sudo apt update; sudo apt install nicotine

If you prefer to install a .deb package directly, you can download one here (for 3.3.11rc1) or here (for 3.4.0.dev1). Unlike the repository installation method, you need to download and install Nicotine+ from the link above every time you want to update to the latest build.

Flatpak

The latest Flatpak packages are built after every commit.

Snap

The latest Snap packages for 3.4.0.dev1 are published in the Snap Store, and can be installed by running the following:

sudo snap install nicotine-plus --edge

Other

See All Platforms for installing the test build of Nicotine+ on other distributions.

Windows

The latest installers are built after every commit.

Portable packages for 3.4.0.dev1 are also available. They can be run from any folder and do not require installation. User data files are stored in a portable\data folder next to the executable.

IMPORTANT: If you are upgrading from the standalone package, and wish to use your previous data files, you can rename the C:\Users\<USERNAME>\AppData\Roaming\nicotine folder to data, and place it inside the portable folder next to the executable. Alternatively, remove the portable folder to continue using the old AppData path.

Standalone packages are available for 3.3.11rc1. They always store user data files in C:\Users\<USERNAME>\AppData\Roaming\nicotine.

macOS

The latest installers are built after every commit.

IMPORTANT: You must follow these instructions the first time you start Nicotine+.

All Platforms

The following installation methods work out of the box on GNU/Linux, *BSD and illumos. On Windows, a MinGW development environment is required. On macOS, Homebrew is required. Consider using the Windows and macOS packages above if you do not need to modify the source code.

pip

The latest test build of Nicotine+ can be installed using pip. Ensure the runtime dependencies are installed, and run the following:

For testing 3.3.11rc1:

pip3 install git+https://github.com/nicotine-plus/nicotine-plus.git@3.3.x

For testing 3.4.0.dev1:

pip3 install git+https://github.com/nicotine-plus/nicotine-plus.git

To start Nicotine+:

nicotine

To update to the latest test build of Nicotine+, run the following:

For 3.3.11rc1:

pip3 install --upgrade git+https://github.com/nicotine-plus/nicotine-plus.git@3.3.x

For 3.4.0.dev1:

pip3 install --upgrade git+https://github.com/nicotine-plus/nicotine-plus.git

To uninstall Nicotine+, run:

pip3 uninstall nicotine-plus

Git

To run Nicotine+ directly from a local Git folder, ensure the runtime dependencies are installed, and run the following:

For testing 3.3.11rc1:

git clone https://github.com/nicotine-plus/nicotine-plus.git -b 3.3.x
cd nicotine-plus
./nicotine

For testing 3.4.0.dev1:

git clone https://github.com/nicotine-plus/nicotine-plus.git
cd nicotine-plus
./nicotine

To update to the latest test build of Nicotine+, run the following:

cd nicotine-plus
git pull