dakaraplayer 1.8.1

Media player for the Dakara Project

Dakara player

Interface between the Dakara server and a media player, for the Dakara project.

Installation

To install Dakara completely, you have to get all the parts of the project. Installation guidelines are provided over here:

• Dakara server;
• Dakara feeder.

System requirements

• Python3, for the magic to take place (supported versions: 3.7, 3.8, 3.9, 3.10 and 3.11).

At least one of there players:

• VLC (supported version: 3.0.0 and higher, note that versions 3.0.13 to 3.0.16 cannot be used);
• mpv (supported version: 0.27 and higher).

For 64 bits operating systems, you must install the equivalent version of the requirements. Linux and Windows are supported.

Virtual environment

It is strongly recommended to use the Dakara player within a virtual environment.

Install

Please ensure you have a recent enough version of setuptools:

pip install --upgrade "setuptools>=46.4.0"

Install the package with:

pip install dakaraplayer

If you have downloaded the repo, you can install the package directly with:

pip install .

Usage

The package provides the dakara-player play command which runs the player:

dakara-player play
# or
python -m dakara_player play

One instance of the Dakara server should be running.

For more help:

dakara-player -h
# or
python -m dakara_player -h

Before calling the command, you should create a config file with:

dakara-player create-config
# or
python -m dakara_player create-config

and complete it with your values. The file is stored in your user space: ~/.config/dakara on Linux, or $APPDATA\DakaraProject\dakara on Windows.

Configuration

The configuration is created with the previously cited command. Several aspect of the player can be configured with this file. Please check with the file documentation.

Authentication to the server can only be done with a player token that can be generated and copied from the web client. Please note that only a playlist manager can generate such a player token.

Customization

The different text screens used when the player is idle, or before a song, can be customized, both for the background and the text template. The program looks for custom files at startup in the user directory: ~/.local/share/dakara/player on Linux or $APPDATA\DakaraProject\dakara\player on Windows. Backgrounds are located in the backgrounds subfolder, and text templates in the templates subfolder. File names can be modified in the config file, see player.templates and player.backgrounds.

You can dump the default backgrounds and templates in the user directory as a starter with:

dakara-player create-resources
# or
python -m dakara_player create-resources

Development

Please read the developers documentation.

The MIT License (MIT)

Copyright (c) 2022 Dakara Project

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.