MediaElch

https://mediaelch.github.io/mediaelch-doc/
Admin
MediaElch is a MediaManager for Kodi, organizing movies, TV shows, concerts, and music by storing...
Tokens:16,870
Snippets:220
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install MediaElch After Building

Source: https://mediaelch.github.io/mediaelch-doc/contributing/build/fedora_36.html

Installs the compiled MediaElch application onto your system. This command requires `sudo` privileges.

```bash
sudo make install

```

--------------------------------

### Install MediaElch

Source: https://mediaelch.github.io/mediaelch-doc/contributing/build/ubuntu_22_04.html

Installs the built MediaElch application on the system after a successful build.

```bash
sudo make install
```

--------------------------------

### Install MediaElch

Source: https://mediaelch.github.io/mediaelch-doc/contributing/build/openSUSE_Tumbleweed.html

Installs MediaElch on the system after it has been successfully built. This command should be run from the MediaElch directory.

```bash
sudo cmake --build build --target install
```

--------------------------------

### Install Build Tools and Libraries

Source: https://mediaelch.github.io/mediaelch-doc/contributing/build/ubuntu_22_04.html

Installs essential build tools, Git, libcurl, libmediainfo, ffmpeg, and Qt development packages required for building MediaElch.

```bash
sudo apt install build-essential git
sudo apt install libcurl4-gnutls-dev # or libcurl4-openssl-dev
sudo apt install libmediainfo-dev

# ffmpeg is required at runtime to create random screenshots
sudo apt install ffmpeg

# Qt (alternative: download and install Qt from its official website)
sudo apt install \
    qt5-qmake \
    qtbase5-dev \
    qtbase5-dev-tools \
    qtdeclarative5-dev \
    qtmultimedia5-dev \
    qttools5-dev \
    qttools5-dev-tools \
    libqt5opengl5 \
    libqt5opengl5-dev \
    libqt5svg5 \
    libqt5svg5-dev
```

--------------------------------

### Install Qt 5 using zypper

Source: https://mediaelch.github.io/mediaelch-doc/contributing/build/openSUSE_Leap_15.html

Installs various Qt 5 components and development files using the zypper package manager.

```bash
zypper install \
    libqt5-qtbase libqt5-qtdeclarative-devel libqt5-qtdeclarative-tools \
    libqt5-qtmultimedia-devel libqt5-qttools libqt5-qttools-devel \
    libqt5-qtsvg-devel libQt5Concurrent5 libQt5Concurrent-devel \
    libQt5OpenGL5 libQt5OpenGL-devel libQt5Sql-devel

```

--------------------------------

### Install Dependencies and Build MediaElch (Command Line)

Source: https://mediaelch.github.io/mediaelch-doc/contributing/build/macos.html

Installs necessary tools and libraries using Homebrew, clones the MediaElch repository, updates submodules, downloads required headers via SVN, and then builds MediaElch using qmake and make.

```bash
# [Optional] Install git (it should have already been installed by XCode)
brew install git

# Install tools and dependencies
brew install subversion qt media-info ffmpeg

# Clone MediaElch
git clone https://github.com/Komet/MediaElch.git && cd MediaElch
git submodule update --init

# Download necessary headers
svn checkout https://github.com/MediaArea/MediaInfoLib/trunk/Source/MediaInfoDLL
svn checkout https://github.com/MediaArea/ZenLib/trunk/Source/ZenLib

# Build MediaElch
mkdir build && cd build
qmake ..
make -j4

```

--------------------------------

### Install Build Dependencies for MediaElch

Source: https://mediaelch.github.io/mediaelch-doc/contributing/build/fedora_36.html

Installs necessary development packages for building MediaElch on Fedora 36+ using Qt 6. Ensure you have `sudo` privileges.

```bash
sudo dnf install \
  qt6-qtbase-devel \
  qt6-qtmultimedia \
  qt6-qtmultimedia-devel \
  qt6-qttools \
  qt6-qttools-devel \
  qt6-qtdeclarative-devel \
  qt6-qtsvg \
  qt6-qtsvg-devel \
  qt6-qt5compat-devel \
  qt6-qt5compat \
  libmediainfo-devel

```

--------------------------------

### Install ffmpeg

Source: https://mediaelch.github.io/mediaelch-doc/contributing/build/openSUSE_Leap_15.html

Installs the ffmpeg package, which is required by MediaElch for creating screenshots. Ensure multimedia codecs are installed beforehand.

```bash
sudo zypper install ffmpeg

```

--------------------------------

### Install MediaElch using Chocolatey

Source: https://mediaelch.github.io/mediaelch-doc/download/windows.html

Use this command to install MediaElch if you have Chocolatey package manager installed on your Windows system.

```powershell
choco install mediaelch
```

--------------------------------

### Install ffmpeg

Source: https://mediaelch.github.io/mediaelch-doc/contributing/build/openSUSE_Tumbleweed.html

Installs the ffmpeg package, which is required by MediaElch for creating screenshots. Ensure multimedia codecs are installed separately if needed.

```bash
sudo zypper install ffmpeg
```

--------------------------------

### Install Development Tools and Dependencies

Source: https://mediaelch.github.io/mediaelch-doc/contributing/build/openSUSE_Leap_15.html

Installs essential development tools, MediaElch dependencies, OpenGL headers, and a specific GCC version required for building.

```bash
# Install development tools
sudo zypper install --type pattern devel_basis
# Install other dependencies
sudo zypper install libmediainfo0 libmediainfo-devel libpulse-devel
# Install OpenGL headers. Alternative OpenGL headers will work as well.
sudo zypper install Mesa-libGL-devel
# Install a newer version of GCC
sudo zypper install gcc8 gcc8-c++

```

--------------------------------

### Install MediaElch on openSUSE Tumbleweed

Source: https://mediaelch.github.io/mediaelch-doc/download/linux.html

Add the openSUSE build service repository for MediaElch and install it via zypper.

```bash
# openSUSE Tumbleweed
sudo zypper addrepo https://download.opensuse.org/repositories/home:bugwelle/openSUSE_Tumbleweed/home:bugwelle.repo
sudo zypper refresh
sudo zypper install MediaElch
```

--------------------------------

### Install MediaElch on openSUSE Leap 15.5

Source: https://mediaelch.github.io/mediaelch-doc/download/linux.html

Add the openSUSE build service repository for MediaElch and install it via zypper.

```bash
# openSUSE Leap 15.5
sudo zypper addrepo https://download.opensuse.org/repositories/home:bugwelle/15.5/home:bugwelle.repo
sudo zypper refresh
sudo zypper install MediaElch
```

--------------------------------

### Add Ubuntu PPA and Install MediaElch

Source: https://mediaelch.github.io/mediaelch-doc/download/linux.html

Use these commands to add the official MediaElch PPA to your Ubuntu system and then install the application.

```bash
sudo add-apt-repository ppa:mediaelch/mediaelch-stable
sudo apt-get update
# Install MediaElch
sudo apt-get install mediaelch
# Start MediaElch
MediaElch
```

--------------------------------

### Install MediaElch on openSUSE Leap 15.6

Source: https://mediaelch.github.io/mediaelch-doc/download/linux.html

Add the openSUSE build service repository for MediaElch and install it via zypper.

```bash
# openSUSE Leap 15.6
sudo zypper addrepo https://download.opensuse.org/repositories/home:bugwelle/15.6/home:bugwelle.repo
sudo zypper refresh
sudo zypper install MediaElch
```

--------------------------------

### Install Qt 6 and MediaElch Dependencies

Source: https://mediaelch.github.io/mediaelch-doc/contributing/build/openSUSE_Tumbleweed.html

Installs Qt 6 development packages and other essential libraries for MediaElch using zypper. Ensure you have the necessary repositories enabled.

```bash
# Install Qt 6
sudo zypper install \
    qt6-base-devel qt6-base-common-devel qt6-concurrent-devel \
    qt6-core-devel qt6-gui-devel qt6-imageformats-devel \
    qt6-multimedia-devel qt6-multimediawidgets-devel \
    qt6-qt5compat-devel qt6-sql-devel qt6-svg-devel \
    qt6-tools-devel quazip-qt6-devel qt6-linguist-devel

# Install development tools
sudo zypper install --type pattern devel_basis
# Install other dependencies
sudo zypper install libmediainfo0 libmediainfo-devel libpulse-devel
# Install OpenGL headers. Alternative OpenGL headers will work as well.
sudo zypper install Mesa-libGL-devel
# Install other dev tools explicitly
sudo zypper install git gcc 'gcc-c++' cmake
```

--------------------------------

### Folder and File Renaming Pattern Example

Source: https://mediaelch.github.io/mediaelch-doc/renaming.html

This example demonstrates a common pattern for renaming movie folders and files, including conditional logic for 3D movies and movieset information. Use this pattern to create a structured directory for your media library.

```text
Folder: {movieset}<movieset> - {/movieset}<title> (<year>)
File: <title>{3D}.3D{/3D}.<extension>
```

--------------------------------

### Update MediaElch using Chocolatey

Source: https://mediaelch.github.io/mediaelch-doc/download/windows.html

Use this command to upgrade MediaElch to the latest version if you installed it via Chocolatey.

```powershell
choco upgrade mediaelch
```

--------------------------------

### Build MediaElch from Source

Source: https://mediaelch.github.io/mediaelch-doc/contributing/build/openSUSE_Leap_15.html

Clones the MediaElch repository, configures the build using qmake, and compiles the application with parallel jobs. Optionally sets GCC versions.

```bash
# Optional, if you use non-default GCC
export CXX=g++-8; export CC=gcc-8;
# Clone with dependencies
git clone --recursive --depth=1 https://github.com/Komet/MediaElch.git
cd MediaElch
mkdir build && cd build
qmake ..
make -j4

```

--------------------------------

### Clone and Build MediaElch from Source

Source: https://mediaelch.github.io/mediaelch-doc/contributing/build/fedora_36.html

Clones the MediaElch repository, updates submodules, creates a build directory, configures the build with qmake, and compiles the project using make with 4 parallel jobs.

```bash
git clone https://github.com/Komet/MediaElch.git
cd MediaElch
git submodule update --init
mkdir build && cd build
qmake ..
make -j4

```

--------------------------------

### Clone MediaElch Repository and Initialize Submodules

Source: https://mediaelch.github.io/mediaelch-doc/contributing/build/windows.html

Use these Git commands to clone the MediaElch source code, navigate into the directory, and initialize its dependencies.

```bash
# Get MediaElch's source code
git clone https://github.com/Komet/MediaElch.git

# Change into the newly created directory
cd MediaElch

# Get dependencies
git submodule update --init

```

--------------------------------

### Clone Repository and Build MediaElch

Source: https://mediaelch.github.io/mediaelch-doc/contributing/build/ubuntu_22_04.html

Clones the MediaElch repository, updates submodules, creates a build directory, configures the build using qmake, and compiles the project with parallel jobs.

```bash
git clone https://github.com/Komet/MediaElch.git
cd MediaElch
git submodule update --init
mkdir build && cd build
qmake ..
make -j4
```

--------------------------------

### Conditional Placeholders for Renaming

Source: https://mediaelch.github.io/mediaelch-doc/renaming.html

These conditional placeholders can be used within your renaming patterns to apply specific logic based on movie attributes. For example, `{3D}{/3D}` is used to append '.3D' only if the movie is a 3D film.

```text
{bluray}{/bluray}
{dvd}{/dvd}
{3D}{/3D}
{movieset}<movieset>{/movieset}
{imdbId}<imdbId>{/imdbId}
{tmdbId}<tmdbId>{/tmdbId}
```

--------------------------------

### Clone MediaElch Repository and Configure Build

Source: https://mediaelch.github.io/mediaelch-doc/contributing/build/openSUSE_Tumbleweed.html

Clones the MediaElch repository with its submodules and configures the build using CMake. Adjust the number of parallel jobs (-j) based on your system's cores.

```bash
# Clone with dependencies
git clone --recursive --depth=1 https://github.com/Komet/MediaElch.git
cd MediaElch
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build -j 4
```

--------------------------------

### File Info Placeholders

Source: https://mediaelch.github.io/mediaelch-doc/export/create-theme.html

Use these placeholders to display detailed file information such as dimensions, codec, duration, and audio/subtitle languages.

```text
{{ FILEINFO.WIDTH }}
{{ FILEINFO.HEIGHT }}
{{ FILEINFO.ASPECT }}
{{ FILEINFO.CODEC }}
{{ FILEINFO.DURATION }}
{{ FILEINFO.AUDIO.CODEC }}        # all audio codecs joined by "|"
{{ FILEINFO.AUDIO.CHANNELS }}     # all audio channels joined by "|"
{{ FILEINFO.AUDIO.LANGUAGE }}     # all audio languages joined by "|"
{{ FILEINFO.SUBTITLES.LANGUAGE }} # all subtitle languages joined by "|"
```

--------------------------------

### Enable Portable Mode in MediaElch

Source: https://mediaelch.github.io/mediaelch-doc/portable-mode.html

Place this XML content in an advancedsettings.xml file within MediaElch's application directory to enable portable mode on Windows. This ensures settings and cache are stored locally.

```xml
<advancedsettings>
    <portableMode>true</portableMode>
</advancedsettings>

```

--------------------------------

### Add Qt bin directory to PATH

Source: https://mediaelch.github.io/mediaelch-doc/contributing/build/openSUSE_Leap_15.html

Appends the Qt binary directory to the system's PATH environment variable by modifying the ~/.bashrc file, allowing command-line access to Qt tools.

```bash
export PATH=$PATH:$HOME/Qt/5.15.2/gcc_64/bin

```

--------------------------------

### Set C++ Standard Library for CMake Build

Source: https://mediaelch.github.io/mediaelch-doc/contributing/build/macos.html

Configures the C++ standard library for CMake builds on macOS, addressing potential issues after Xcode updates. Use the export command for command-line builds or the set command within CMakeLists.txt.

```bash
# Bash (command line)
export CXXFLAGS="-stdlib=libc++"
# Or in CMake
set(CMAKE_CXX_FLAGS "-stdlib=libc++")

```
Tokens:
Raw