wvlover15/orpheusdl-musixmatch

OrpheusDL - Musixmatch

A Musixmatch module for the OrpheusDL modular archival music program

Report Bug · Request Feature

Table of content

• About OrpheusDL - Musixmatch
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Configuration
  • Global
• Contact

About OrpheusDL - Musixmatch

OrpheusDL - Musixmatch is a module written in Python which allows retrieving lyrics from Musixmatch for the modular music archival program.

Getting Started

Follow these steps to get a local copy of Orpheus up and running:

Prerequisites

• Already have OrpheusDL installed

Installation

Just clone the repo inside the folder orpheusdl/modules/

git clone https://github.com/yarrm80s/orpheusdl-musixmatch.git orpheusdl/modules/musixmatch

Usage

Either set musixmatch as your default lyrics provider in module_defaults, or call orpheus.py with the following option:

python orpheus.py -lr musixmatch https://open.qobuz.com/album/c9wsrrjh49ftb

Configuration

You can customize every module from Orpheus individually and also set general/global settings which are active in every loaded module. You'll find the configuration file here: config/settings.json

Global

"global": {
    "module_defaults": {
        "lyrics": "musixmatch",
        "covers": "default",
        "credits": "default"
    },
    "lyrics": {
        "embed_lyrics": true,
        "save_synced_lyrics": true
    },
}

module_defaults: Lets you select which module to automatically get lyrics/covers/credits from. If selecting default, it will use the main module for the same task.

lyrics:

• embed_lyrics will add the lyrics as a tag
• save_synced_lyrics stores synchronised lyrics in a .lrc

Contact

Yarrm80s - @yarrm80s

Dniel97 - @Dniel97

Project Link: OrpheusDL Musixmatch Public GitHub Repository