diff --git a/.github/ISSUE_TEMPLATE/1.bug_report.yml b/.github/ISSUE_TEMPLATE/1.bug_report.yml index a3b9180a..b69984dc 100644 --- a/.github/ISSUE_TEMPLATE/1.bug_report.yml +++ b/.github/ISSUE_TEMPLATE/1.bug_report.yml @@ -8,8 +8,8 @@ body: attributes: value: > **THIS IS NOT THE PLACE TO ASK FOR SUPPORT OR FEATURE REQUESTS!** - Please use [Plex Meta Manager Discord](https://metamanager.wiki/en/latest/discord/) and post your question under the `pmm-help` channel for support issues. - Please use [Plex Meta Manager Features](https://features.metamanager.wiki/) to request and upvote features. + Please use [Kometa Discord](https://kometa.wiki/en/latest/discord/) and post your question under the ` kometa-help` channel for support issues. + Please use [Kometa Features](https://features.kometa.wiki/) to request and upvote features. - type: input id: version attributes: diff --git a/.github/ISSUE_TEMPLATE/2.pmm_default.yml b/.github/ISSUE_TEMPLATE/2.defaults.yml similarity index 68% rename from .github/ISSUE_TEMPLATE/2.pmm_default.yml rename to .github/ISSUE_TEMPLATE/2.defaults.yml index 587414e0..fbc0126a 100644 --- a/.github/ISSUE_TEMPLATE/2.pmm_default.yml +++ b/.github/ISSUE_TEMPLATE/2.defaults.yml @@ -1,5 +1,5 @@ -name: PMM Default Issue -description: Post here if there is an issue with the pmm defaults or for missing images for pmm default overlays or posters. +name: Kometa Default Issue +description: Post here if there is an issue with the Kometa defaults or for missing images for Kometa default overlays or posters. title: '[Defaults]: ' labels: ['defaults'] assignees: ['meisnate12', 'bullmoose20', 'YozoraXCII'] @@ -9,8 +9,8 @@ body: attributes: value: > **THIS IS NOT THE PLACE TO ASK FOR SUPPORT OR FEATURE REQUESTS!** - Please use [Plex Meta Manager Discord](https://metamanager.wiki/en/latest/discord/) and post your question under the `pmm-support` channel for support issues. - Please use [Plex Meta Manager Features](https://features.metamanager.wiki/) to request and upvote features. + Please use [Kometa Discord](https://kometa.wiki/en/latest/discord/) and post your question under the `kometa-support` channel for support issues. + Please use [Kometa Features](https://features.kometa.wiki/) to request and upvote features. - type: input id: file attributes: diff --git a/.github/ISSUE_TEMPLATE/3.docs_request.yml b/.github/ISSUE_TEMPLATE/3.docs_request.yml index f864ae98..9ad66788 100644 --- a/.github/ISSUE_TEMPLATE/3.docs_request.yml +++ b/.github/ISSUE_TEMPLATE/3.docs_request.yml @@ -1,5 +1,5 @@ name: Wiki Issue -description: A request to update or improve Plex Meta Manager's wiki +description: A request to update or improve Kometa's wiki labels: ['status:not-yet-viewed', 'documentation'] assignees: 'meisnate12' @@ -8,8 +8,8 @@ body: attributes: value: > **THIS IS NOT THE PLACE TO ASK FOR SUPPORT OR FEATURE REQUESTS!** - Please use [Plex Meta Manager Discord](https://metamanager.wiki/en/latest/discord/) and post your question under the `pmm-support` channel for support issues. - Please use [Plex Meta Manager Features](https://features.metamanager.wiki/) to request and upvote features. + Please use [Kometa Discord](https://kometa.wiki/en/latest/discord/) and post your question under the ` kometa-support` channel for support issues. + Please use [Kometa Features](https://features.kometa.wiki/) to request and upvote features. - type: textarea attributes: label: What is the improvement or update to the Wiki you wish to see? @@ -18,6 +18,6 @@ body: - type: input attributes: label: Does the docs page already exist? Please link to it. - description: 'Example: https://metamanager.wiki/en/latest/config/operations.html' + description: 'Example: https://kometa.wiki/en/latest/config/operations.html' validations: required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 23234e93..ad979c34 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,11 +1,11 @@ blank_issues_enabled: false contact_links: - name: Feature Requests - url: https://features.metamanager.wiki + url: https://features.kometa.wiki about: Please use the features site to submit and vote on features. - - name: Plex Meta Manager Wiki - url: https://metamanager.wiki + - name: Kometa Wiki + url: https://kometa.wiki about: Please check the wiki to see if your question has already been answered. - name: Discord - url: https://metamanager.wiki/en/latest/discord/ - about: Please use the Plex Meta Manager Discord to ask for support. + url: https://kometa.wiki/en/latest/discord/ + about: Please use the Kometa Discord to ask for support. diff --git a/.github/heroku.png b/.github/heroku.png new file mode 100644 index 00000000..09d291d6 Binary files /dev/null and b/.github/heroku.png differ diff --git a/.github/logo.png b/.github/logo.png new file mode 100644 index 00000000..c6b31305 Binary files /dev/null and b/.github/logo.png differ diff --git a/.github/pmm.png b/.github/pmm.png deleted file mode 100644 index a93cbbf8..00000000 Binary files a/.github/pmm.png and /dev/null differ diff --git a/.github/pypi.svg b/.github/pypi.svg new file mode 100644 index 00000000..0480adcf --- /dev/null +++ b/.github/pypi.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/.github/release.png b/.github/release.png new file mode 100644 index 00000000..534bcc82 Binary files /dev/null and b/.github/release.png differ diff --git a/.github/workflows/develop.yml b/.github/workflows/develop.yml index b94930a6..8b02cd51 100644 --- a/.github/workflows/develop.yml +++ b/.github/workflows/develop.yml @@ -42,7 +42,7 @@ jobs: "BRANCH_NAME=develop" platforms: linux/amd64,linux/arm64,linux/arm/v7 push: true - tags: ${{ secrets.DOCKER_HUB_USERNAME }}/plex-meta-manager:develop + tags: ${{ secrets.DOCKER_HUB_USERNAME }}/kometa:develop cache-from: type=gha cache-to: type=gha,mode=max @@ -56,36 +56,38 @@ jobs: "BRANCH_NAME=develop" platforms: linux/amd64,linux/arm64,linux/arm/v7 push: true - tags: ${{ secrets.DOCKER_HUB_USERNAME }}/plex-meta-manager:lxml-develop + tags: ${{ secrets.DOCKER_HUB_USERNAME }}/kometa:lxml-develop cache-from: type=gha cache-to: type=gha,mode=max - name: Send Discord Commit Notification - uses: meisnate12/discord-notifications@master + uses: Kometa-Team/discord-notifications@master with: webhook_id: ${{ secrets.DEVELOP_WEBHOOK_ID }} webhook_token: ${{ secrets.DEVELOP_WEBHOOK_TOKEN }} - title: Plex Meta Manager Develop Commits - message: "<@&954835263731949623> - An update to Plex Meta Manager has been published and is available to users of the **develop** branch.\n\nWe **strongly** recommend users who previously switched to the `nightly` branch to resolve any previous issues to now switch back to the `develop` branch now." + title: Develop Commits + message: "<@&954835263731949623> - An update to Kometa has been published and is available to users of the **develop** branch.\n\nWe **strongly** recommend users who previously switched to the `nightly` branch to resolve any previous issues to now switch back to the `develop` branch now." commits: "true" - username: Metabot - avatar_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/develop/.github/pmm.png + username: Kobota + avatar_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/develop/.github/logo.png + author: Kometa Develop Release + author_icon_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/develop/.github/release.png - name: Discord Success Notification - uses: meisnate12/discord-notifications@master + uses: Kometa-Team/discord-notifications@master if: success() with: webhook_id: ${{ secrets.BUILD_WEBHOOK_ID }} webhook_token: ${{ secrets.BUILD_WEBHOOK_TOKEN }} title: "develop build: **Success**" - url: https://github.com/meisnate12/Plex-Meta-Manager/actions/runs/${{ github.run_id }} - username: Metabot - avatar_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/develop/.github/pmm.png + url: https://github.com/Kometa-Team/Kometa/actions/runs/${{ github.run_id }} + username: Kobota + avatar_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/develop/.github/logo.png author: Docker - author_icon_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/develop/.github/docker.png + author_icon_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/develop/.github/docker.png - name: Discord Failure Notification - uses: meisnate12/discord-notifications@master + uses: Kometa-Team/discord-notifications@master if: failure() with: webhook_id: ${{ secrets.BUILD_WEBHOOK_ID }} @@ -93,8 +95,8 @@ jobs: message: <@&1079153184007790652> title: "develop build: **Failure**" color: 0xe30c43 - url: https://github.com/meisnate12/Plex-Meta-Manager/actions/runs/${{ github.run_id }} - username: Metabot - avatar_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/develop/.github/pmm.png + url: https://github.com/Kometa-Team/Kometa/actions/runs/${{ github.run_id }} + username: Kobota + avatar_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/develop/.github/logo.png author: Docker - author_icon_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/develop/.github/docker.png + author_icon_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/develop/.github/docker.png diff --git a/.github/workflows/latest.yml b/.github/workflows/latest.yml index bca2fd75..627c78bb 100644 --- a/.github/workflows/latest.yml +++ b/.github/workflows/latest.yml @@ -36,7 +36,7 @@ jobs: file: ./Dockerfile platforms: linux/amd64,linux/arm64,linux/arm/v7 push: true - tags: ${{ secrets.DOCKER_HUB_USERNAME }}/plex-meta-manager:latest + tags: ${{ secrets.DOCKER_HUB_USERNAME }}/kometa:latest cache-from: type=gha cache-to: type=gha,mode=max @@ -48,25 +48,25 @@ jobs: file: ./Dockerfile.lxml platforms: linux/amd64,linux/arm64,linux/arm/v7 push: true - tags: ${{ secrets.DOCKER_HUB_USERNAME }}/plex-meta-manager:lxml-latest + tags: ${{ secrets.DOCKER_HUB_USERNAME }}/kometa:lxml-latest cache-from: type=gha cache-to: type=gha,mode=max - name: Discord Success Notification - uses: meisnate12/discord-notifications@master + uses: Kometa-Team/discord-notifications@master if: success() with: webhook_id: ${{ secrets.BUILD_WEBHOOK_ID }} webhook_token: ${{ secrets.BUILD_WEBHOOK_TOKEN }} title: "latest build: **Success**" - url: https://github.com/meisnate12/Plex-Meta-Manager/actions/runs/${{ github.run_id }} - username: Metabot - avatar_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/master/.github/pmm.png + url: https://github.com/Kometa-Team/Kometa/actions/runs/${{ github.run_id }} + username: Kobota + avatar_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/master/.github/logo.png author: Docker - author_icon_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/master/.github/docker.png + author_icon_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/master/.github/docker.png - name: Discord Failure Notification - uses: meisnate12/discord-notifications@master + uses: Kometa-Team/discord-notifications@master if: failure() with: webhook_id: ${{ secrets.BUILD_WEBHOOK_ID }} @@ -74,8 +74,8 @@ jobs: message: <@&1079153184007790652> title: "latest build: **Failure**" color: 0xe30c43 - url: https://github.com/meisnate12/Plex-Meta-Manager/actions/runs/${{ github.run_id }} - username: Metabot - avatar_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/master/.github/pmm.png + url: https://github.com/Kometa-Team/Kometa/actions/runs/${{ github.run_id }} + username: Kobota + avatar_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/master/.github/logo.png author: Docker - author_icon_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/master/.github/docker.png \ No newline at end of file + author_icon_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/master/.github/docker.png \ No newline at end of file diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index 3b716652..60d54007 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -42,7 +42,7 @@ jobs: "BRANCH_NAME=nightly" platforms: linux/amd64,linux/arm64 push: true - tags: ${{ secrets.DOCKER_HUB_USERNAME }}/plex-meta-manager:nightly + tags: ${{ secrets.DOCKER_HUB_USERNAME }}/kometa:nightly cache-from: type=gha cache-to: type=gha,mode=max @@ -56,36 +56,38 @@ jobs: "BRANCH_NAME=nightly" platforms: linux/amd64,linux/arm64 push: true - tags: ${{ secrets.DOCKER_HUB_USERNAME }}/plex-meta-manager:lxml-nightly + tags: ${{ secrets.DOCKER_HUB_USERNAME }}/kometa:lxml-nightly cache-from: type=gha cache-to: type=gha,mode=max - name: Send Discord Commit Notification - uses: meisnate12/discord-notifications@master + uses: Kometa-Team/discord-notifications@master with: webhook_id: ${{ secrets.NIGHTLY_WEBHOOK_ID }} webhook_token: ${{ secrets.NIGHTLY_WEBHOOK_TOKEN }} title: Nightly Commits - message: "<@&967002147520675840> - An update to Plex Meta Manager has now been published and is available to users of the **nightly** branch." + message: "<@&967002147520675840> - An update to Kometa has now been published and is available to users of the **nightly** branch." commits: "true" - username: Metabot - avatar_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/nightly/.github/pmm.png + username: Kobota + avatar_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/nightly/.github/logo.png + author: Kometa Nightly Release + author_icon_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/nightly/.github/release.png - name: Discord Success Notification - uses: meisnate12/discord-notifications@master + uses: Kometa-Team/discord-notifications@master if: success() with: webhook_id: ${{ secrets.BUILD_WEBHOOK_ID }} webhook_token: ${{ secrets.BUILD_WEBHOOK_TOKEN }} title: "nightly build: **Success**" - url: https://github.com/meisnate12/Plex-Meta-Manager/actions/runs/${{ github.run_id }} - username: Metabot - avatar_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/nightly/.github/pmm.png + url: https://github.com/Kometa-Team/Kometa/actions/runs/${{ github.run_id }} + username: Kobota + avatar_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/nightly/.github/logo.png author: Docker - author_icon_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/nightly/.github/docker.png + author_icon_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/nightly/.github/docker.png - name: Discord Failure Notification - uses: meisnate12/discord-notifications@master + uses: Kometa-Team/discord-notifications@master if: failure() with: webhook_id: ${{ secrets.BUILD_WEBHOOK_ID }} @@ -93,8 +95,8 @@ jobs: message: <@&1079153184007790652> title: "nightly build: **Failure**" color: 0xe30c43 - url: https://github.com/meisnate12/Plex-Meta-Manager/actions/runs/${{ github.run_id }} - username: Metabot - avatar_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/nightly/.github/pmm.png + url: https://github.com/Kometa-Team/Kometa/actions/runs/${{ github.run_id }} + username: Kobota + avatar_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/nightly/.github/logo.png author: Docker - author_icon_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/nightly/.github/docker.png + author_icon_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/nightly/.github/docker.png diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index f3e4c496..d3fb6864 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -12,12 +12,14 @@ jobs: steps: - name: Send Discord Release Notification - uses: meisnate12/discord-notifications@master + uses: Kometa-Team/discord-notifications@master with: webhook_id: ${{ secrets.RELEASE_WEBHOOK_ID }} webhook_token: ${{ secrets.RELEASE_WEBHOOK_TOKEN }} release: true - title: Plex Meta Manager Release VERSION - message: "<@&967002324646113290> - A new version of Plex Meta Manager has been released and is available to all users.\n\nWe **strongly** recommend users who previously switched to the `nightly` or `develop` branches to resolve any previous issues to now switch back to the `latest` branch now." - username: Metabot - avatar_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/master/.github/pmm.png \ No newline at end of file + title: Release VERSION + message: "<@&967002324646113290> - A new version of Kometa has been released and is available to all users.\n\nWe **strongly** recommend users who previously switched to the `nightly` or `develop` branches to resolve any previous issues to now switch back to the `latest` branch now." + username: Kobota + avatar_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/develop/.github/logo.png + author: Kometa Release + author_icon_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/develop/.github/release.png \ No newline at end of file diff --git a/.github/workflows/version.yml b/.github/workflows/version.yml index 041d827f..2a3cfbf0 100644 --- a/.github/workflows/version.yml +++ b/.github/workflows/version.yml @@ -44,7 +44,7 @@ jobs: file: ./Dockerfile platforms: linux/amd64,linux/arm64,linux/arm/v7 push: true - tags: ${{ secrets.DOCKER_HUB_USERNAME }}/plex-meta-manager:${{ steps.get_version.outputs.VERSION }} + tags: ${{ secrets.DOCKER_HUB_USERNAME }}/kometa:${{ steps.get_version.outputs.VERSION }} cache-from: type=gha cache-to: type=gha,mode=max @@ -56,25 +56,25 @@ jobs: file: ./Dockerfile.lxml platforms: linux/amd64,linux/arm64,linux/arm/v7 push: true - tags: ${{ secrets.DOCKER_HUB_USERNAME }}/plex-meta-manager:lxml-${{ steps.get_version.outputs.VERSION }} + tags: ${{ secrets.DOCKER_HUB_USERNAME }}/kometa:lxml-${{ steps.get_version.outputs.VERSION }} cache-from: type=gha cache-to: type=gha,mode=max - name: Discord Success Notification - uses: meisnate12/discord-notifications@master + uses: Kometa-Team/discord-notifications@master if: success() with: webhook_id: ${{ secrets.BUILD_WEBHOOK_ID }} webhook_token: ${{ secrets.BUILD_WEBHOOK_TOKEN }} title: "${{ steps.get_version.outputs.VERSION }} build: **Success**" - url: https://github.com/meisnate12/Plex-Meta-Manager/actions/runs/${{ github.run_id }} - username: Metabot - avatar_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/master/.github/pmm.png + url: https://github.com/Kometa-Team/Kometa/actions/runs/${{ github.run_id }} + username: Kobota + avatar_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/master/.github/logo.png author: Docker - author_icon_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/master/.github/docker.png + author_icon_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/master/.github/docker.png - name: Discord Failure Notification - uses: meisnate12/discord-notifications@master + uses: Kometa-Team/discord-notifications@master if: failure() with: webhook_id: ${{ secrets.BUILD_WEBHOOK_ID }} @@ -82,21 +82,21 @@ jobs: message: <@&1079153184007790652> title: "${{ steps.get_version.outputs.VERSION }} build: **Failure**" color: 0xe30c43 - url: https://github.com/meisnate12/Plex-Meta-Manager/actions/runs/${{ github.run_id }} - username: Metabot - avatar_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/master/.github/pmm.png + url: https://github.com/Kometa-Team/Kometa/actions/runs/${{ github.run_id }} + username: Kobota + avatar_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/master/.github/logo.png author: Docker - author_icon_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/master/.github/docker.png + author_icon_url: https://raw.githubusercontent.com/Kometa-Team/Kometa/master/.github/docker.png - name: Checkout Configs Repo uses: actions/checkout@v4 with: - repository: meisnate12/Plex-Meta-Manager-Configs + repository: Kometa-Team/Community-Configs token: ${{ secrets.PAT }} - path: pmmconfigs + path: kometaconfigs - name: Create & Push Tag - working-directory: ./pmmconfigs + working-directory: ./kometaconfigs run: | git tag ${{ steps.get_version.outputs.VERSION }} git push origin ${{ steps.get_version.outputs.VERSION }} diff --git a/.gitignore b/.gitignore index 00ce6413..cd999a0e 100644 --- a/.gitignore +++ b/.gitignore @@ -122,6 +122,7 @@ ENV/ env.bak/ venv.bak/ pmm-venv/ +kometa-venv/ # Spyder project settings .spyderproject diff --git a/Dockerfile b/Dockerfile index 861f956b..b812eb5c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -2,7 +2,7 @@ FROM python:3.11-slim-buster ARG BRANCH_NAME=master ENV BRANCH_NAME ${BRANCH_NAME} ENV TINI_VERSION v0.19.0 -ENV PMM_DOCKER True +ENV KOMETA_DOCKER True COPY requirements.txt requirements.txt RUN echo "**** install system packages ****" \ && apt-get update \ @@ -21,4 +21,4 @@ RUN echo "**** install system packages ****" \ && rm -rf /requirements.txt /tmp/* /var/tmp/* /var/lib/apt/lists/* COPY . / VOLUME /config -ENTRYPOINT ["/tini", "-s", "python3", "plex_meta_manager.py", "--"] +ENTRYPOINT ["/tini", "-s", "python3", "kometa.py", "--"] diff --git a/Dockerfile.lxml b/Dockerfile.lxml index cde540ca..2b90789a 100644 --- a/Dockerfile.lxml +++ b/Dockerfile.lxml @@ -2,8 +2,8 @@ FROM python:3.11-slim-buster ARG BRANCH_NAME=master ENV BRANCH_NAME ${BRANCH_NAME} ENV TINI_VERSION v0.19.0 -ENV PMM_DOCKER True -ENV PMM_LXML True +ENV KOMETA_DOCKER True +ENV KOMETA_LXML True COPY requirements.txt requirements.txt RUN sed -i -E "s/(lxml==).+/\15.1.1/" requirements.txt RUN echo "**** install system packages ****" \ @@ -23,4 +23,4 @@ RUN echo "**** install system packages ****" \ && rm -rf /requirements.txt /tmp/* /var/tmp/* /var/lib/apt/lists/* COPY . / VOLUME /config -ENTRYPOINT ["/tini", "-s", "python3", "plex_meta_manager.py", "--"] +ENTRYPOINT ["/tini", "-s", "python3", "kometa.py", "--"] diff --git a/README.md b/README.md index 218666d0..bc36ebbf 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,30 @@ -# PMM - -[![GitHub release (latest by date)](https://img.shields.io/github/v/release/meisnate12/Plex-Meta-Manager?style=plastic)](https://github.com/meisnate12/Plex-Meta-Manager/releases) -[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/meisnate12/plex-meta-manager?label=docker&sort=semver&style=plastic)](https://hub.docker.com/r/meisnate12/plex-meta-manager) -[![Docker Pulls](https://img.shields.io/docker/pulls/meisnate12/plex-meta-manager?style=plastic)](https://hub.docker.com/r/meisnate12/plex-meta-manager) -[![Develop GitHub commits since latest stable release (by SemVer)](https://img.shields.io/github/commits-since/meisnate12/plex-meta-manager/latest/develop?label=Commits%20in%20Develop&style=plastic)](https://github.com/meisnate12/Plex-Meta-Manager/tree/develop) -[![Nightly GitHub commits since latest stable release (by SemVer)](https://img.shields.io/github/commits-since/meisnate12/plex-meta-manager/latest/nightly?label=Commits%20in%20Nightly&style=plastic)](https://github.com/meisnate12/Plex-Meta-Manager/tree/nightly) - -[![Discord](https://img.shields.io/discord/822460010649878528?color=%2300bc8c&label=Discord&style=plastic)](https://metamanager.wiki/en/latest/discord/) -[![Reddit](https://img.shields.io/badge/%2Fr%2Fplexmetamanager-e05d44?style=plastic&logo=Reddit&logoColor=white&labelColor=0e8a6a&color=00bc8c)](https://www.reddit.com/r/PlexMetaManager/) -[![Wiki](https://img.shields.io/readthedocs/plex-meta-manager?color=%2300bc8c&style=plastic)](https://metamanager.wiki) -[![Translations](https://img.shields.io/weblate/progress/plex-meta-manager?color=00bc8c&server=https%3A%2F%2Ftranslations.metamanager.wiki&style=plastic)](https://translations.metamanager.wiki/projects/plex-meta-manager/#languages) +# Kometa + +[![GitHub release (latest by date)](https://img.shields.io/github/v/release/Kometa-Team/Kometa?style=plastic)](https://github.com/Kometa-Team/Kometa/releases) +[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/kometateam/kometa?label=docker&sort=semver&style=plastic)](https://hub.docker.com/r/kometateam/kometa) +[![Docker Pulls](https://img.shields.io/docker/pulls/kometateam/kometa?style=plastic)](https://hub.docker.com/r/kometateam/kometa) +[![Develop GitHub commits since latest stable release (by SemVer)](https://img.shields.io/github/commits-since/Kometa-Team/Kometa/latest/develop?label=Commits%20in%20Develop&style=plastic)](https://github.com/Kometa-Team/Kometa/tree/develop) +[![Nightly GitHub commits since latest stable release (by SemVer)](https://img.shields.io/github/commits-since/Kometa-Team/Kometa/latest/nightly?label=Commits%20in%20Nightly&style=plastic)](https://github.com/Kometa-Team/Kometa/tree/nightly) + +[![Discord](https://img.shields.io/discord/822460010649878528?color=%2300bc8c&label=Discord&style=plastic)](https://kometa.wiki/en/latest/discord/) +[![Reddit](https://img.shields.io/badge/%2Fr%2Fkometa-e05d44?style=plastic&logo=Reddit&logoColor=white&labelColor=0e8a6a&color=00bc8c)](https://www.reddit.com/r/kometa/) +[![Wiki](https://img.shields.io/readthedocs/kometa?color=%2300bc8c&style=plastic)](https://kometa.wiki) +[![Translations](https://img.shields.io/weblate/progress/kometa?color=00bc8c&server=https%3A%2F%2Ftranslations.kometa.wiki&style=plastic)](https://translations.kometa.wiki/projects/kometa/#languages) [![GitHub Sponsors](https://img.shields.io/github/sponsors/meisnate12?color=%238a2be2&style=plastic)](https://github.com/sponsors/meisnate12) [![Sponsor or Donate](https://img.shields.io/badge/-Sponsor%2FDonate-blueviolet?style=plastic)](https://github.com/sponsors/meisnate12) -[![Feature Requests](https://img.shields.io/badge/Feature%20Requests-blueviolet?style=plastic)](https://features.metamanager.wiki/) +[![Feature Requests](https://img.shields.io/badge/Feature%20Requests-blueviolet?style=plastic)](https://features.kometa.wiki/) -Plex Meta Manager is a powerful tool designed to give you complete control over your media libraries. With Plex Meta Manager, you can take your customization to the next level, with granular control over metadata, collections, overlays, and much more. +Kometa is a powerful tool designed to give you complete control over your media libraries. With Kometa, you can take your customization to the next level, with granular control over metadata, collections, overlays, and much more. -Transform your media library with Plex Meta Manager and discover its full potential! Connect to third-party services like TMDb, Trakt, and IMDb, among others, to create one-of-a-kind collections, overlays and more. Your media library will stand out and be tailored to your specific needs. +Transform your media library with Kometa and discover its full potential! Connect to third-party services like TMDb, Trakt, and IMDb, among others, to create one-of-a-kind collections, overlays and more. Your media library will stand out and be tailored to your specific needs. -## What Can Plex-Meta-Manager Do? +## What Can Kometa Do? ### Overhaul Your Media Libraries - Elevate your library with beautifully crafted metadata - customize artwork, titles, summaries, and more to create a stunning library. -### PMM Defaults +### Kometa Defaults - Take advantage of pre-made modular Collections & Overlays to reduce the manual effort and get to the good stuff with less effort! @@ -40,63 +40,69 @@ Transform your media library with Plex Meta Manager and discover its full potent ## Demo Video -The below YouTube video has been created by one of our community members to showcase some of the things that Plex Meta Manager can do for you. +The below YouTube video has been created by one of our community members to showcase some of the things that Kometa can do for you. -[![Plex Meta Manager](https://img.youtube.com/vi/nTfCUtKWTYI/0.jpg)](https://www.youtube.com/watch?v=nTfCUtKWTYI "Plex Meta Manager") +[![Kometa](https://img.youtube.com/vi/nTfCUtKWTYI/0.jpg)](https://www.youtube.com/watch?v=nTfCUtKWTYI "Kometa") -## Example Plex Meta Manager Libraries +## Demo Video + +The below YouTube video has been created by one of our community members to showcase some of the things that Kometa can do for you. + +[![Kometa](https://img.youtube.com/vi/nTfCUtKWTYI/0.jpg)](https://www.youtube.com/watch?v=nTfCUtKWTYI "Kometa") -Here are some examples of the things you can achieve using Plex Meta Manager! +## Example Kometa Libraries -**Example Movie Collections using the [Plex Meta Manager Defaults](https://metamanager.wiki/en/latest/defaults/collections/)** (click to enlarge): +Here are some examples of the things you can achieve using Kometa! -![Movie Collection Preview](https://metamanager.wiki/en/latest/images/movie-collection-preview.png) +**Example Movie Collections using the [Kometa Defaults](https://kometa.wiki/en/latest/defaults/collections/)** (click to enlarge): -**Example Show Overlays using the [Plex Meta Manager Defaults](https://metamanager.wiki/en/latest/defaults/overlays)** (click to enlarge): +![Movie Collection Preview](https://kometa.wiki/en/latest/images/movie-collection-preview.png) -![Show Library Preview](https://metamanager.wiki/en/latest/images/show-library-preview.png) +**Example Show Overlays using the [Kometa Defaults](https://kometa.wiki/en/latest/defaults/overlays)** (click to enlarge): -## Plex Meta Manager Defaults +![Show Library Preview](https://kometa.wiki/en/latest/images/show-library-preview.png) -Want your library to look like the above images? With the [PMM Defaults](https://metamanager.wiki/en/latest/defaults/guide/) you can! These powerful and modular files were designed by the Plex Meta Manager team to make it simple to create a personalized, one-of-a-kind media collection without the hassle of manually defining each one. +## Kometa Defaults -Want to see what the community has to offer? Check out the [Plex Meta Manager Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs) repository on GitHub to see user-submitted configuration files, or even add your own to the mix! +Want your library to look like the above images? With the [Kometa Defaults](https://kometa.wiki/en/latest/defaults/guide/) you can! These powerful and modular files were designed by the Kometa team to make it simple to create a personalized, one-of-a-kind media collection without the hassle of manually defining each one. -With Plex Meta Manager, you can also manage metadata for all your media types, from movies and shows to music and more. And since your metadata is managed outside your libraries, you'll never have to worry about losing your customizations in the event of a media server database loss, you can simply reapply them! It is also easy to move your customizations between servers if you need to. +Want to see what the community has to offer? Check out the [Kometa Community Configs](https://github.com/Kometa-Team/Community-Configs) repository on GitHub to see user-submitted configuration files, or even add your own to the mix! + +With Kometa, you can also manage metadata for all your media types, from movies and shows to music and more. And since your metadata is managed outside your libraries, you'll never have to worry about losing your customizations in the event of a media server database loss, you can simply reapply them! It is also easy to move your customizations between servers if you need to. ## Getting Started -To get started with Plex Meta Manager, follow these simple steps: +To get started with Kometa, follow these simple steps: -1. Install Plex Meta Manager on your device. You can find the installation instructions for a variety of platforms [here](https://metamanager.wiki/en/latest/pmm/install/overview/). +1. Install Kometa on your device. You can find the installation instructions for a variety of platforms [here](https://kometa.wiki/en/latest/kometa/install/overview/). -2. Once you have installed Plex Meta Manager, create your [Configuration File](https://metamanager.wiki/en/latest/config/overview/). This file contains important information such as URLs and credentials needed to connect to services like Plex and TMDb +2. Once you have installed Kometa, create your [Configuration File](https://kometa.wiki/en/latest/config/overview/). This file contains important information such as URLs and credentials needed to connect to services like Plex and TMDb -3. After creating the Configuration File, you can start updating Metadata and building automatic Collections by creating a [Collection File](https://metamanager.wiki/en/latest/files/collections/) for each Library you want to work with. If you'd rather use some of our pre-made Collection Files, take a look at the [Plex Meta Manager Defaults](https://metamanager.wiki/en/latest/defaults/guide/) +3. After creating the Configuration File, you can start updating Metadata and building automatic Collections by creating a [Collection File](https://kometa.wiki/en/latest/files/collections/) for each Library you want to work with. If you'd rather use some of our pre-made Collection Files, take a look at the [Kometa Defaults](https://kometa.wiki/en/latest/defaults/guide/) -4. Finally, check out the [Wiki](https://metamanager.wiki/), you'll find new and exciting ways to truly unlock the potential of your libraries. +4. Finally, check out the [Wiki](https://kometa.wiki/), you'll find new and exciting ways to truly unlock the potential of your libraries. ## Step-by-Step Guides -If you're a beginner to the concepts of Python, Git and/or Plex Meta Manager and find the above steps challenging, don't worry. We've got some step-by-step guides that can help you get started. These guides will take you through the process of installing Plex Meta Manager, creating your Configuration File and getting some basic Collections up and running. +If you're a beginner to the concepts of Python, Git and/or Kometa and find the above steps challenging, don't worry. We've got some step-by-step guides that can help you get started. These guides will take you through the process of installing Kometa, creating your Configuration File and getting some basic Collections up and running. For those who need full installation walkthroughs, please refer to the following walkthrough guides: - * [Local Walkthrough](https://metamanager.wiki/en/latest/pmm/install/local/) - follow this if you are running the script directly on Windows, OS X, or Linux - * [Docker Walkthrough](https://metamanager.wiki/en/latest/pmm/install/docker/) - this discusses using Docker at the command line + * [Local Walkthrough](https://kometa.wiki/en/latest/kometa/install/local/) - follow this if you are running the script directly on Windows, OS X, or Linux + * [Docker Walkthrough](https://kometa.wiki/en/latest/kometa/install/docker/) - this discusses using Docker at the command line If you are using unRAID, Kubernetes, QNAP, or Synology refer to the following basic guide to Docker container setup for each system: -**this doesn't cover the PMM setup specifics found in the guides above with regard to creating the config file and collection file, so you may want to go through the [Docker Walkthrough](https://metamanager.wiki/en/latest/pmm/install/docker/) first on your computer to gain that understanding.** +**this doesn't cover the Kometa setup specifics found in the guides above with regard to creating the config file and collection file, so you may want to go through the [Docker Walkthrough](https://kometa.wiki/en/latest/kometa/install/docker/) first on your computer to gain that understanding.** - * [unRAID Walkthrough](https://metamanager.wiki/en/latest/pmm/install/unraid/) - * [Kubernetes Walkthrough](https://metamanager.wiki/en/latest/pmm/install/kubernetes/) - * [QNAP Walkthrough](https://metamanager.wiki/en/latest/pmm/install/qnap/) - * [Synology Walkthrough](https://metamanager.wiki/en/latest/pmm/install/synology/) + * [unRAID Walkthrough](https://kometa.wiki/en/latest/kometa/install/unraid/) + * [Kubernetes Walkthrough](https://kometa.wiki/en/latest/kometa/install/kubernetes/) + * [QNAP Walkthrough](https://kometa.wiki/en/latest/kometa/install/qnap/) + * [Synology Walkthrough](https://kometa.wiki/en/latest/kometa/install/synology/) ## Example Usage -Plex Meta Manager puts you in control of your media library by letting you create custom Collections that make discovering and organizing your content a breeze. With powerful search and filtering options, you can build Collections based on popular builders like TMDb, IMDb, Trakt, and many more. +Kometa puts you in control of your media library by letting you create custom Collections that make discovering and organizing your content a breeze. With powerful search and filtering options, you can build Collections based on popular builders like TMDb, IMDb, Trakt, and many more. Imagine having Collections like these at your fingertips: @@ -108,32 +114,32 @@ Imagine having Collections like these at your fingertips: * Actors * Decades -Plex Meta Manager gives you endless possibilities to curate and organize your media library any way you want. Create custom Collections and Overlays that fit your unique preferences and make discovering your content effortless. +Kometa gives you endless possibilities to curate and organize your media library any way you want. Create custom Collections and Overlays that fit your unique preferences and make discovering your content effortless. -But if you don't want to spend time manually creating Collections and Overlays, we've got you covered. Check out the [PMM Defaults](https://metamanager.wiki/en/latest/defaults/guide/) - a handcrafted selection of tried-and-tested Collections and Overlays made by the Plex Meta Manager team. +But if you don't want to spend time manually creating Collections and Overlays, we've got you covered. Check out the [Kometa Defaults](https://kometa.wiki/en/latest/defaults/guide/) - a handcrafted selection of tried-and-tested Collections and Overlays made by the Kometa team. ## Develop & Nightly Branches -The Develop and Nightly branches are "beta" versions of Plex Meta Manager that are updated more frequently than the stable version (Master branch). These branches are where bug fixes, new features, and other changes are added before being released to the Master branch. +The Develop and Nightly branches are "beta" versions of Kometa that are updated more frequently than the stable version (Master branch). These branches are where bug fixes, new features, and other changes are added before being released to the Master branch. -However, these branches (especially Nightly) are recommended for more technical users who don't mind updating frequently to get the latest changes. Keep in mind that these beta branches may have bugs or other issues that could cause problems with Plex Meta Manager or your media server. So, if you're not comfortable with technical issues, it's best to stick with the Master branch. +However, these branches (especially Nightly) are recommended for more technical users who don't mind updating frequently to get the latest changes. Keep in mind that these beta branches may have bugs or other issues that could cause problems with Kometa or your media server. So, if you're not comfortable with technical issues, it's best to stick with the Master branch.
Develop Branch (click to expand) -[![Develop GitHub commits since latest stable release (by SemVer)](https://img.shields.io/github/commits-since/meisnate12/plex-meta-manager/latest/develop?label=Commits%20in%20Develop&style=plastic)](https://github.com/meisnate12/Plex-Meta-Manager/tree/develop) +[![Develop GitHub commits since latest stable release (by SemVer)](https://img.shields.io/github/commits-since/Kometa-Team/Kometa/latest/develop?label=Commits%20in%20Develop&style=plastic)](https://github.com/Kometa-Team/Kometa/tree/develop) -The [develop](https://github.com/meisnate12/Plex-Meta-Manager/tree/develop) branch has the most updated **documented** fixes and enhancements to Plex Meta Manager. This version is tested and documented to some degree, but it is still an active Develop branch, so there may be rough edges. +The [develop](https://github.com/Kometa-Team/Kometa/tree/develop) branch has the most updated **documented** fixes and enhancements to Kometa. This version is tested and documented to some degree, but it is still an active Develop branch, so there may be rough edges. Switching to `develop`: ````{tab} Running in Docker Add ":develop" to the image name in your run command or configuration: ``` -meisnate12/plex-meta-manager:develop +kometateam/kometa:develop ``` ```` ````{tab} Running on the Host -In the directory where you cloned PMM: +In the directory where you cloned Kometa: ```bash git checkout develop ``` @@ -143,7 +149,7 @@ git checkout master ``` ```` -If switching to the develop branch, it is recommended to also use the [develop branch of the wiki](https://metamanager.wiki/en/develop/), which documents any changes made from the Master branch. +If switching to the develop branch, it is recommended to also use the [develop branch of the wiki](https://kometa.wiki/en/develop/), which documents any changes made from the Master branch.
@@ -152,22 +158,22 @@ If switching to the develop branch, it is recommended to also use the [develop b
Nightly Branch (click to expand) -[![Nightly GitHub commits since latest stable release (by SemVer)](https://img.shields.io/github/commits-since/meisnate12/plex-meta-manager/latest/nightly?label=Commits%20in%20Nightly&style=plastic)](https://github.com/meisnate12/Plex-Meta-Manager/tree/nightly) +[![Nightly GitHub commits since latest stable release (by SemVer)](https://img.shields.io/github/commits-since/Kometa-Team/Kometa/latest/nightly?label=Commits%20in%20Nightly&style=plastic)](https://github.com/Kometa-Team/Kometa/tree/nightly) **This branch will have squashed commits which can cause `git pull`/`git fetch` to error you can use `git reset origin/nightly --hard` to fix the branch.** -There is also a [nightly](https://github.com/meisnate12/Plex-Meta-Manager/tree/nightly) branch which will have the absolute latest version of the script, but it could easily break, there is no guarantee that it even works, and any new features will not be documented until they have progressed enough to reach the develop branch. +There is also a [nightly](https://github.com/Kometa-Team/Kometa/tree/nightly) branch which will have the absolute latest version of the script, but it could easily break, there is no guarantee that it even works, and any new features will not be documented until they have progressed enough to reach the develop branch. Switching to `nightly`: ````{tab} Running in Docker Add ":nightly" to the image name in your run command or configuration: ``` -meisnate12/plex-meta-manager:nightly +kometateam/kometa:nightly ``` ```` ````{tab} Running on the Host -In the directory where you cloned PMM: +In the directory where you cloned Kometa: ```bash git checkout nightly ``` @@ -177,30 +183,29 @@ git checkout master ``` ```` -As this branch is subject to extreme change, there is no promise of the feature being documented in the [nightly](https://metamanager.wiki/en/nightly/) branch of the wiki and all discussions relating to changes made in the nightly branch will be held within the [Plex Meta Manager Discord Server](https://metamanager.wiki/en/latest/discord/). +As this branch is subject to extreme change, there is no promise of the feature being documented in the [nightly](https://kometa.wiki/en/nightly/) branch of the wiki and all discussions relating to changes made in the nightly branch will be held within the [Kometa Discord Server](https://kometa.wiki/en/latest/discord/).
## Discord Support Server -If you're looking for support for any questions or issues you might have, or if you just want to be a part of our growing community, Join the [Plex Meta Manager Discord Server](https://metamanager.wiki/en/latest/discord/). +If you're looking for support for any questions or issues you might have, or if you just want to be a part of our growing community, Join the [Kometa Discord Server](https://kometa.wiki/en/latest/discord/). ## Feature Requests -At Plex Meta Manager, we value our community's input and actively seek feedback to drive the evolution of our product. We want to hear your ideas on how to enhance Plex Meta Manager, and we encourage you to visit our [Feature Request](https://features.metamanager.wiki/features) page to share your thoughts or vote on what features you would like to see added next. Your voice matters and helps shape the future of Plex Meta Manager, so please don't hesitate to join in the conversation and be a part of our community-driven development process. +At Kometa, we value our community's input and actively seek feedback to drive the evolution of our product. We want to hear your ideas on how to enhance Kometa, and we encourage you to visit our [Feature Request](https://features.kometa.wiki/features) page to share your thoughts or vote on what features you would like to see added next. Your voice matters and helps shape the future of Kometa, so please don't hesitate to join in the conversation and be a part of our community-driven development process. ## Errors and Configuration Questions -If you're having trouble, we recommend first joining the [Plex Meta Manager Discord Server](https://metamanager.wiki/en/latest/discord/) and seeking support there. If that isn't possible for you, here's what you can do: +If you're having trouble, we recommend first joining the [Kometa Discord Server](https://kometa.wiki/en/latest/discord/) and seeking support there. If that isn't possible for you, here's what you can do: -* If you get an error, update to the latest version and check if the issue persists. If it does, report the bug by filling out the [Bug Report](https://github.com/meisnate12/Plex-Meta-Manager/issues/new?assignees=meisnate12&labels=status%3Anot-yet-viewed%2C+bug&template=bug_report.md&title=Bug%3A+) template. -* If you spot a mistake or have an idea to improve the [Plex Meta Manager Wiki](https://metamanager.wiki/), submit a request using the [Wiki Request](https://github.com/meisnate12/Plex-Meta-Manager/issues/new?assignees=meisnate12&labels=status%3Anot-yet-viewed%2C+documentation&template=3.docs_request.yml&title=%5BDocs%5D%3A+) template. -* If you have a question about metadata configuration, start a discussion on the [Discussions](https://github.com/meisnate12/Plex-Meta-Manager/discussions). Remember, the community helps shape the future of Plex Meta Manager, so your input is valuable! +* If you get an error, update to the latest version and check if the issue persists. If it does, report the bug by filling out the [Bug Report](https://github.com/Kometa-Team/Kometa/issues/new?assignees=meisnate12&labels=status%3Anot-yet-viewed%2C+bug&template=bug_report.md&title=Bug%3A+) template. +* If you spot a mistake or have an idea to improve the [Kometa Wiki](https://kometa.wiki/), submit a request using the [Wiki Request](https://github.com/Kometa-Team/Kometa/issues/new?assignees=meisnate12&labels=status%3Anot-yet-viewed%2C+documentation&template=3.docs_request.yml&title=%5BDocs%5D%3A+) template. +* If you have a question about metadata configuration, start a discussion on the [Discussions](https://github.com/Kometa-Team/Kometa/discussions). Remember, the community helps shape the future of Kometa, so your input is valuable! -For support on any of the above, visit the [Discord server](https://metamanager.wiki/en/latest/discord/). +For support on any of the above, visit the [Discord server](https://kometa.wiki/en/latest/discord/). ## Contributing * Pull Requests are greatly encouraged, please submit all Pull Requests to the nightly branch. -
- +
\ No newline at end of file diff --git a/config/config.yml.template b/config/config.yml.template index e45d7a48..780c294d 100644 --- a/config/config.yml.template +++ b/config/config.yml.template @@ -1,36 +1,36 @@ ## This file is a template remove the .template to use the file -libraries: # This is called out once within the config.yml file - Movies: # These are names of libraries in your Plex - remove_overlays: false # Set this to true to remove all overlays +libraries: # This is called out once within the config.yml file + Movies: # These are names of libraries in your Plex + remove_overlays: false # Set this to true to remove all overlays collection_files: - - pmm: basic # This is a file within PMM's defaults folder - - pmm: imdb # This is a file within PMM's defaults folder + - default: basic # This is a file within Kometa's defaults folder + - default: imdb # This is a file within Kometa's defaults folder # see the wiki for how to use local files, folders, URLs, or files from git overlay_files: - - pmm: ribbon # This is a file within PMM's defaults folder + - default: ribbon # This is a file within Kometa's defaults folder # see the wiki for how to use local files, folders, URLs, or files from git TV Shows: - remove_overlays: false # Set this to true to remove all overlays + remove_overlays: false # Set this to true to remove all overlays collection_files: - - pmm: basic # This is a file within PMM's defaults folder - - pmm: imdb # This is a file within PMM's defaults folder + - default: basic # This is a file within Kometa's defaults folder + - default: imdb # This is a file within Kometa's defaults folder # see the wiki for how to use local files, folders, URLs, or files from git overlay_files: - - pmm: ribbon # This is a file within PMM's defaults folder + - default: ribbon # This is a file within Kometa's defaults folder # see the wiki for how to use local files, folders, URLs, or files from git Anime: collection_files: - - pmm: basic # This is a file within PMM's defaults folder - - pmm: anilist # This is a file within PMM's defaults folder + - default: basic # This is a file within Kometa's defaults folder + - default: anilist # This is a file within Kometa's defaults folder # see the wiki for how to use local files, folders, URLs, or files from git Music: collection_files: - - file: config/Music.yml # This is a local file THAT YOU MIGHT CREATE + - file: config/Music.yml # This is a local file THAT YOU MIGHT CREATE playlist_files: - - pmm: playlist # This is a file within PMM's defaults folder + - default: playlist # This is a file within Kometa's defaults folder template_variables: - libraries: Movies, TV Shows # list of libraries that you want the PMM Defaults playlists to look at + libraries: Movies, TV Shows # list of libraries that you want the Kometa Defaults playlists to look at # see the wiki for how to use local files, folders, URLs, or files from git settings: run_order: @@ -74,13 +74,13 @@ settings: playlist_report: false verify_ssl: true custom_repo: -webhooks: # Can be individually specified per library as well +webhooks: # Can be individually specified per library as well error: version: run_start: run_end: changes: -plex: # Can be individually specified per library as well; REQUIRED for the script to run +plex: # Can be individually specified per library as well; REQUIRED for the script to run url: http://192.168.1.12:32400 token: #################### timeout: 60 @@ -89,10 +89,10 @@ plex: # Can be individually specified per library as empty_trash: false optimize: false verify_ssl: -tmdb: # REQUIRED for the script to run +tmdb: # REQUIRED for the script to run apikey: ################################ language: en -tautulli: # Can be individually specified per library as well +tautulli: # Can be individually specified per library as well url: http://192.168.1.12:8181 apikey: ################################ github: @@ -108,10 +108,10 @@ notifiarr: gotify: url: http://192.168.1.12:80 token: #################################### -anidb: # Not required for AniDB builders unless you want mature content +anidb: # Not required for AniDB builders unless you want mature content username: ###### password: ###### -radarr: # Can be individually specified per library as well +radarr: # Can be individually specified per library as well url: http://192.168.1.12:7878 token: ################################ add_missing: false @@ -126,7 +126,7 @@ radarr: # Can be individually specified per library as search: false radarr_path: plex_path: -sonarr: # Can be individually specified per library as well +sonarr: # Can be individually specified per library as well url: http://192.168.1.12:8989 token: ################################ add_missing: false diff --git a/defaults/award/bafta.yml b/defaults/award/bafta.yml index 38e69055..7294d4ea 100644 --- a/defaults/award/bafta.yml +++ b/defaults/award/bafta.yml @@ -2,11 +2,11 @@ # British Academy of Film and Television Arts Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/bafta # +# https://kometa.wiki/en/latest/defaults/award/bafta # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: 130 diff --git a/defaults/award/berlinale.yml b/defaults/award/berlinale.yml index 10e985e1..f71c9e69 100644 --- a/defaults/award/berlinale.yml +++ b/defaults/award/berlinale.yml @@ -2,11 +2,11 @@ # Berlinale Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/berlinale # +# https://kometa.wiki/en/latest/defaults/award/berlinale # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: 130 diff --git a/defaults/award/cannes.yml b/defaults/award/cannes.yml index 939523db..9e215b32 100644 --- a/defaults/award/cannes.yml +++ b/defaults/award/cannes.yml @@ -2,11 +2,11 @@ # Cannes Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/cannes # +# https://kometa.wiki/en/latest/defaults/award/cannes # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: 130 diff --git a/defaults/award/cesar.yml b/defaults/award/cesar.yml index 180d3b70..952fbe5d 100644 --- a/defaults/award/cesar.yml +++ b/defaults/award/cesar.yml @@ -2,11 +2,11 @@ # Cesar Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/cesar # +# https://kometa.wiki/en/latest/defaults/award/cesar # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: 130 diff --git a/defaults/award/choice.yml b/defaults/award/choice.yml index 83116bcc..cd19eb50 100644 --- a/defaults/award/choice.yml +++ b/defaults/award/choice.yml @@ -2,11 +2,11 @@ # Critics Choice Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/choice # +# https://kometa.wiki/en/latest/defaults/award/choice # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: 130 diff --git a/defaults/award/emmy.yml b/defaults/award/emmy.yml index 9d34df7e..da330cce 100644 --- a/defaults/award/emmy.yml +++ b/defaults/award/emmy.yml @@ -2,11 +2,11 @@ # Emmy Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/emmy # +# https://kometa.wiki/en/latest/defaults/award/emmy # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: 130 diff --git a/defaults/award/golden.yml b/defaults/award/golden.yml index 4e5e18d2..45730b88 100644 --- a/defaults/award/golden.yml +++ b/defaults/award/golden.yml @@ -2,11 +2,11 @@ # Golden Globes Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/golden # +# https://kometa.wiki/en/latest/defaults/award/golden # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: 130 diff --git a/defaults/award/nfr.yml b/defaults/award/nfr.yml index b8cb4cd0..c6e1ea6a 100644 --- a/defaults/award/nfr.yml +++ b/defaults/award/nfr.yml @@ -2,11 +2,11 @@ # National Film Registry Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/nfr # +# https://kometa.wiki/en/latest/defaults/award/nfr # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: 130 diff --git a/defaults/award/oscars.yml b/defaults/award/oscars.yml index e783c141..f7d52e72 100644 --- a/defaults/award/oscars.yml +++ b/defaults/award/oscars.yml @@ -2,11 +2,11 @@ # Academy Awards (Oscars) Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/oscars # +# https://kometa.wiki/en/latest/defaults/award/oscars # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: 130 diff --git a/defaults/award/pca.yml b/defaults/award/pca.yml index 6833436e..0396083e 100644 --- a/defaults/award/pca.yml +++ b/defaults/award/pca.yml @@ -2,11 +2,11 @@ # People's Choice Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/pca # +# https://kometa.wiki/en/latest/defaults/award/pca # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: 130 diff --git a/defaults/award/razzie.yml b/defaults/award/razzie.yml index 5458ad81..7e2caabb 100644 --- a/defaults/award/razzie.yml +++ b/defaults/award/razzie.yml @@ -2,11 +2,11 @@ # Razzie Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/razzie # +# https://kometa.wiki/en/latest/defaults/award/razzie # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: 130 diff --git a/defaults/award/sag.yml b/defaults/award/sag.yml index b0064ba2..84067106 100644 --- a/defaults/award/sag.yml +++ b/defaults/award/sag.yml @@ -2,11 +2,11 @@ # Screen Actors Guild Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/sag # +# https://kometa.wiki/en/latest/defaults/award/sag # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: 130 diff --git a/defaults/award/separator_award.yml b/defaults/award/separator_award.yml index 8c8b0091..fcece668 100644 --- a/defaults/award/separator_award.yml +++ b/defaults/award/separator_award.yml @@ -2,11 +2,11 @@ # Award Separator Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/separator_award # +# https://kometa.wiki/en/latest/defaults/award/separator_award # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: 130 diff --git a/defaults/award/spirit.yml b/defaults/award/spirit.yml index 04abe0d7..6d42c689 100644 --- a/defaults/award/spirit.yml +++ b/defaults/award/spirit.yml @@ -2,11 +2,11 @@ # Independent Spirit Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/spirit # +# https://kometa.wiki/en/latest/defaults/award/spirit # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: 130 diff --git a/defaults/award/sundance.yml b/defaults/award/sundance.yml index 71ede179..db7a729c 100644 --- a/defaults/award/sundance.yml +++ b/defaults/award/sundance.yml @@ -2,11 +2,11 @@ # Sundance Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/sundance # +# https://kometa.wiki/en/latest/defaults/award/sundance # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: 130 diff --git a/defaults/award/tiff.yml b/defaults/award/tiff.yml index a0cecc12..506a9b0e 100644 --- a/defaults/award/tiff.yml +++ b/defaults/award/tiff.yml @@ -2,11 +2,11 @@ # Toronto International Film Festival Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/tiff # +# https://kometa.wiki/en/latest/defaults/award/tiff # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: 130 diff --git a/defaults/award/venice.yml b/defaults/award/venice.yml index 369bff64..298ba76c 100644 --- a/defaults/award/venice.yml +++ b/defaults/award/venice.yml @@ -2,11 +2,11 @@ # Venice Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/venice # +# https://kometa.wiki/en/latest/defaults/award/venice # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: 130 diff --git a/defaults/both/actor.yml b/defaults/both/actor.yml index 515068cf..c37154bd 100644 --- a/defaults/both/actor.yml +++ b/defaults/both/actor.yml @@ -2,11 +2,11 @@ # Actor Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/actor # +# https://kometa.wiki/en/latest/defaults/both/actor # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "140" diff --git a/defaults/both/aspect.yml b/defaults/both/aspect.yml index d9492ce8..980e1987 100644 --- a/defaults/both/aspect.yml +++ b/defaults/both/aspect.yml @@ -2,21 +2,21 @@ # Aspect Ratio Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/aspect # +# https://kometa.wiki/en/latest/defaults/both/aspect # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "125" translations: - pmm: translations + default: translations templates: aspect: template: - url_poster: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager-Images/master/aspect/<>.jpg + url_poster: https://raw.githubusercontent.com/Kometa-Team/Default-Images/master/aspect/<>.jpg summary: A collection of media items with the aspect ratio of <>. collections: diff --git a/defaults/both/audio_language.yml b/defaults/both/audio_language.yml index b82ea9c0..a6bf46c6 100644 --- a/defaults/both/audio_language.yml +++ b/defaults/both/audio_language.yml @@ -2,11 +2,11 @@ # Audio Language Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/audio_language # +# https://kometa.wiki/en/latest/defaults/both/audio_language # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "090" diff --git a/defaults/both/based.yml b/defaults/both/based.yml index 57490a01..3934d679 100644 --- a/defaults/both/based.yml +++ b/defaults/both/based.yml @@ -2,11 +2,11 @@ # "Based On..." Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/based # +# https://kometa.wiki/en/latest/defaults/both/based # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "085" @@ -33,7 +33,7 @@ dynamic_collections: - arr template_variables: mdblist_list: - default: https://mdblist.com/lists/plexmetamanager/based_on_<>_<>s + default: https://mdblist.com/lists/k0meta/based_on_<>_<>s image: default: based/<> translation_key: diff --git a/defaults/both/collectionless.yml b/defaults/both/collectionless.yml index 316737d3..819df7fe 100644 --- a/defaults/both/collectionless.yml +++ b/defaults/both/collectionless.yml @@ -2,7 +2,7 @@ # Collectionless Collection # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/collectionless # +# https://kometa.wiki/en/latest/defaults/both/collectionless # ############################################################################## templates: @@ -15,7 +15,7 @@ templates: # check2 sort_title: ~_Collectionless collection_order: alpha - url_poster: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager-Images/master/collectionless.jpg + url_poster: https://raw.githubusercontent.com/Kometa-Team/Default-Images/master/collectionless.jpg optional: - collection_mode - exclude diff --git a/defaults/both/content_rating_au.yml b/defaults/both/content_rating_au.yml index 535e50cf..02315a40 100644 --- a/defaults/both/content_rating_au.yml +++ b/defaults/both/content_rating_au.yml @@ -3,11 +3,11 @@ # Adapted by 2wenty2wo # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/content_rating_au # +# https://kometa.wiki/en/latest/defaults/both/content_rating_au # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "110" diff --git a/defaults/both/content_rating_cs.yml b/defaults/both/content_rating_cs.yml index 1c04998a..07af28ec 100644 --- a/defaults/both/content_rating_cs.yml +++ b/defaults/both/content_rating_cs.yml @@ -2,11 +2,11 @@ # CommonSense Content Rating Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/content_rating_cs # +# https://kometa.wiki/en/latest/defaults/both/content_rating_cs # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "110" diff --git a/defaults/both/content_rating_de.yml b/defaults/both/content_rating_de.yml index 4b27c050..2e04a992 100644 --- a/defaults/both/content_rating_de.yml +++ b/defaults/both/content_rating_de.yml @@ -2,11 +2,11 @@ # DE Content Rating Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/content_rating_de # +# https://kometa.wiki/en/latest/defaults/both/content_rating_de # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "110" diff --git a/defaults/both/content_rating_mal.yml b/defaults/both/content_rating_mal.yml index 8f3486ad..fe6e61f0 100644 --- a/defaults/both/content_rating_mal.yml +++ b/defaults/both/content_rating_mal.yml @@ -2,11 +2,11 @@ # MAL Content Rating Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/content_rating_mal # +# https://kometa.wiki/en/latest/defaults/both/content_rating_mal # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "110" diff --git a/defaults/both/content_rating_nz.yml b/defaults/both/content_rating_nz.yml index a0b91d6d..cf256bf8 100644 --- a/defaults/both/content_rating_nz.yml +++ b/defaults/both/content_rating_nz.yml @@ -3,11 +3,11 @@ # Adapted by nzvengeance # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/content_rating_nz # +# https://kometa.wiki/en/latest/defaults/both/content_rating_nz # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "110" diff --git a/defaults/both/content_rating_uk.yml b/defaults/both/content_rating_uk.yml index 3d307ca7..2a186d80 100644 --- a/defaults/both/content_rating_uk.yml +++ b/defaults/both/content_rating_uk.yml @@ -2,11 +2,11 @@ # UK Content Rating Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/content_rating_uk # +# https://kometa.wiki/en/latest/defaults/both/content_rating_uk # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "110" diff --git a/defaults/both/genre.yml b/defaults/both/genre.yml index 32fef2b3..a2784aae 100644 --- a/defaults/both/genre.yml +++ b/defaults/both/genre.yml @@ -2,11 +2,11 @@ # Genre Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/genre # +# https://kometa.wiki/en/latest/defaults/both/genre # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "060" diff --git a/defaults/both/resolution.yml b/defaults/both/resolution.yml index 962e476a..2b09ed2b 100644 --- a/defaults/both/resolution.yml +++ b/defaults/both/resolution.yml @@ -2,11 +2,11 @@ # Resolution Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/resolution # +# https://kometa.wiki/en/latest/defaults/both/resolution # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "120" conditionals: diff --git a/defaults/both/streaming.yml b/defaults/both/streaming.yml index e7c8a428..ac516e60 100644 --- a/defaults/both/streaming.yml +++ b/defaults/both/streaming.yml @@ -2,11 +2,11 @@ # Streaming Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/streaming # +# https://kometa.wiki/en/latest/defaults/both/streaming # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "030" @@ -64,7 +64,7 @@ templates: cache_builders: 1 smart_label: <>>> sync_mode: <>>> - mdblist_list: https://mdblist.com/lists/plexmetamanager/<>-<> + mdblist_list: https://mdblist.com/lists/k0meta/<>-<> tmdb_discover: limit: <> with_watch_providers: <> diff --git a/defaults/both/studio.yml b/defaults/both/studio.yml index 402a07f1..648f28af 100644 --- a/defaults/both/studio.yml +++ b/defaults/both/studio.yml @@ -2,11 +2,11 @@ # Studio Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/studio # +# https://kometa.wiki/en/latest/defaults/both/studio # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "070" @@ -274,6 +274,7 @@ dynamic_collections: - Bosque Ranch Productions - Box to Box Films - Brandywine Productions + - Broken Lizard Industries - Broken Road Productions - Calt Production - Canal+ @@ -290,6 +291,7 @@ dynamic_collections: - Chimp Television - Chris Morgan Productions - Cinergi Pictures Entertainment + - Codeblack Entertainment - Columbia Pictures - Constantin Film - Cowboy Films @@ -297,6 +299,7 @@ dynamic_collections: - Dark Horse Entertainment - Davis Entertainment - DC Comics + - Dimension Films - Dino De Laurentiis Company - Don Simpson Jerry Bruckheimer Films - Doozer @@ -374,6 +377,7 @@ dynamic_collections: - Live Entertainment - Lord Miller Productions - Lucasfilm Ltd + - Magic Light Pictures - Magnolia Pictures - Malevolent Films - Mandalay Entertainment diff --git a/defaults/both/subtitle_language.yml b/defaults/both/subtitle_language.yml index ca5fe0f1..8418d924 100644 --- a/defaults/both/subtitle_language.yml +++ b/defaults/both/subtitle_language.yml @@ -2,11 +2,11 @@ # Subtitle Language Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/subtitle_language # +# https://kometa.wiki/en/latest/defaults/both/subtitle_language # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "095" diff --git a/defaults/both/universe.yml b/defaults/both/universe.yml index b5a37f5d..95eacbde 100644 --- a/defaults/both/universe.yml +++ b/defaults/both/universe.yml @@ -2,11 +2,11 @@ # Universe Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/universe # +# https://kometa.wiki/en/latest/defaults/both/universe # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "040" @@ -88,18 +88,18 @@ dynamic_collections: middle: https://trakt.tv/users/oya-kesh/lists/middle-earth # check2 mdblist_url: - avp: https://mdblist.com/lists/plexmetamanager/external/16872 - arrow: https://mdblist.com/lists/plexmetamanager/external/15113 - dca: https://mdblist.com/lists/plexmetamanager/external/15405 - dcu: https://mdblist.com/lists/plexmetamanager/external/15107 - fast: https://mdblist.com/lists/plexmetamanager/external/9246 - marvel: https://mdblist.com/lists/plexmetamanager/external/15110 - mummy: https://mdblist.com/lists/plexmetamanager/external/9249 - rocky: https://mdblist.com/lists/plexmetamanager/external/9248 - star: https://mdblist.com/lists/plexmetamanager/external/15105 - askew: https://mdblist.com/lists/plexmetamanager/external/15362 - wizard: https://mdblist.com/lists/plexmetamanager/external/23683 - xmen: https://mdblist.com/lists/plexmetamanager/external/9244 + avp: https://mdblist.com/lists/k0meta/external/16872 + arrow: https://mdblist.com/lists/k0meta/external/15113 + dca: https://mdblist.com/lists/k0meta/external/15405 + dcu: https://mdblist.com/lists/k0meta/external/15107 + fast: https://mdblist.com/lists/k0meta/external/9246 + marvel: https://mdblist.com/lists/k0meta/external/15110 + mummy: https://mdblist.com/lists/k0meta/external/9249 + rocky: https://mdblist.com/lists/k0meta/external/9248 + star: https://mdblist.com/lists/k0meta/external/15105 + askew: https://mdblist.com/lists/k0meta/external/15362 + wizard: https://mdblist.com/lists/k0meta/external/23683 + xmen: https://mdblist.com/lists/k0meta/external/9244 # check3 image: default: universe/<> diff --git a/defaults/both/year.yml b/defaults/both/year.yml index 637acdaa..6dd4d10a 100644 --- a/defaults/both/year.yml +++ b/defaults/both/year.yml @@ -2,11 +2,11 @@ # Year Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/year # +# https://kometa.wiki/en/latest/defaults/both/year # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "105" diff --git a/defaults/chart/anilist.yml b/defaults/chart/anilist.yml index 5ad14b6d..91ec8c85 100644 --- a/defaults/chart/anilist.yml +++ b/defaults/chart/anilist.yml @@ -2,11 +2,11 @@ # AniList Charts Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/chart/anilist # +# https://kometa.wiki/en/latest/defaults/chart/anilist # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "020" image: chart/<> diff --git a/defaults/chart/basic.yml b/defaults/chart/basic.yml index 24809715..25a9c001 100644 --- a/defaults/chart/basic.yml +++ b/defaults/chart/basic.yml @@ -2,11 +2,11 @@ # Basic Charts Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/chart/basic # +# https://kometa.wiki/en/latest/defaults/chart/basic # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "010" image: chart/<> diff --git a/defaults/chart/imdb.yml b/defaults/chart/imdb.yml index 87e111b7..2143aefe 100644 --- a/defaults/chart/imdb.yml +++ b/defaults/chart/imdb.yml @@ -2,11 +2,11 @@ # IMDb Charts Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/chart/imdb # +# https://kometa.wiki/en/latest/defaults/chart/imdb # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "020" image: chart/<> diff --git a/defaults/chart/myanimelist.yml b/defaults/chart/myanimelist.yml index 2195d0df..06f2ccc2 100644 --- a/defaults/chart/myanimelist.yml +++ b/defaults/chart/myanimelist.yml @@ -2,11 +2,11 @@ # MyAnimeList Charts Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/chart/myanimelist # +# https://kometa.wiki/en/latest/defaults/chart/myanimelist # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "020" image: chart/<> diff --git a/defaults/chart/other_chart.yml b/defaults/chart/other_chart.yml index c186c1e8..2bc9e251 100644 --- a/defaults/chart/other_chart.yml +++ b/defaults/chart/other_chart.yml @@ -2,11 +2,11 @@ # Other Charts Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/chart/other # +# https://kometa.wiki/en/latest/defaults/chart/other # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "020" image: chart/<> @@ -18,7 +18,7 @@ templates: anidb_popular: <> commonsense: - mdblist_list: https://mdblist.com/lists/plexmetamanager/cssfamilies<>s + mdblist_list: https://mdblist.com/lists/k0meta/cssfamilies<>s collections: AniDB Popular: diff --git a/defaults/chart/separator_chart.yml b/defaults/chart/separator_chart.yml index 6029b04d..c9d710c1 100644 --- a/defaults/chart/separator_chart.yml +++ b/defaults/chart/separator_chart.yml @@ -2,11 +2,11 @@ # Chart Separator Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/separator_chart # +# https://kometa.wiki/en/latest/defaults/award/separator_chart # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "020" diff --git a/defaults/chart/tautulli.yml b/defaults/chart/tautulli.yml index a6cf0024..0260a7d5 100644 --- a/defaults/chart/tautulli.yml +++ b/defaults/chart/tautulli.yml @@ -2,11 +2,11 @@ # Tautulli Charts Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/chart/tautulli # +# https://kometa.wiki/en/latest/defaults/chart/tautulli # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "020" image: chart/<> diff --git a/defaults/chart/tmdb.yml b/defaults/chart/tmdb.yml index 78206645..1cb350de 100644 --- a/defaults/chart/tmdb.yml +++ b/defaults/chart/tmdb.yml @@ -2,11 +2,11 @@ # TMDb Charts Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/chart/tmdb # +# https://kometa.wiki/en/latest/defaults/chart/tmdb # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "020" image: chart/<> diff --git a/defaults/chart/trakt.yml b/defaults/chart/trakt.yml index f96ca7c0..366f546c 100644 --- a/defaults/chart/trakt.yml +++ b/defaults/chart/trakt.yml @@ -2,11 +2,11 @@ # Trakt Charts Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/chart/trakt # +# https://kometa.wiki/en/latest/defaults/chart/trakt # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "020" image: chart/<> diff --git a/defaults/movie/content_rating_us.yml b/defaults/movie/content_rating_us.yml index d3c14854..6f99af17 100644 --- a/defaults/movie/content_rating_us.yml +++ b/defaults/movie/content_rating_us.yml @@ -2,11 +2,11 @@ # US Content Rating Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/content_rating_us # +# https://kometa.wiki/en/latest/defaults/both/content_rating_us # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "110" diff --git a/defaults/movie/continent.yml b/defaults/movie/continent.yml index 937c5d2c..50eb6d78 100644 --- a/defaults/movie/continent.yml +++ b/defaults/movie/continent.yml @@ -3,11 +3,11 @@ # Created by Adam Pope, bartolomesorianol, Bullmoose20 & Sohjiro # # Artwork Credit to Duhniel, Bullmoose20, and Wiki Commons # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/movie/continent # +# https://kometa.wiki/en/latest/defaults/movie/continent # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "082" diff --git a/defaults/movie/country.yml b/defaults/movie/country.yml index 6c67c23c..698b0ff6 100644 --- a/defaults/movie/country.yml +++ b/defaults/movie/country.yml @@ -3,11 +3,11 @@ # Created by Yozora, Bullmoose20, & Sohjiro # # Artwork Credit to Duhniel # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/movie/country # +# https://kometa.wiki/en/latest/defaults/movie/country # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "080" diff --git a/defaults/movie/decade.yml b/defaults/movie/decade.yml index a2d58041..bc755044 100644 --- a/defaults/movie/decade.yml +++ b/defaults/movie/decade.yml @@ -2,11 +2,11 @@ # Decade Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/movie/decade # +# https://kometa.wiki/en/latest/defaults/movie/decade # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "100" diff --git a/defaults/movie/director.yml b/defaults/movie/director.yml index 5c206cd1..111fab12 100644 --- a/defaults/movie/director.yml +++ b/defaults/movie/director.yml @@ -2,11 +2,11 @@ # Director Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/movie/director # +# https://kometa.wiki/en/latest/defaults/movie/director # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "150" diff --git a/defaults/movie/franchise.yml b/defaults/movie/franchise.yml index 20362529..3e5e06a3 100644 --- a/defaults/movie/franchise.yml +++ b/defaults/movie/franchise.yml @@ -2,7 +2,7 @@ # Franchise Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/movie/franchise # +# https://kometa.wiki/en/latest/defaults/movie/franchise # ############################################################################## templates: diff --git a/defaults/movie/producer.yml b/defaults/movie/producer.yml index a9f35144..65f609d1 100644 --- a/defaults/movie/producer.yml +++ b/defaults/movie/producer.yml @@ -2,11 +2,11 @@ # Producer Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/movie/producer # +# https://kometa.wiki/en/latest/defaults/movie/producer # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "160" diff --git a/defaults/movie/region.yml b/defaults/movie/region.yml index 697f45d0..f02d9e37 100644 --- a/defaults/movie/region.yml +++ b/defaults/movie/region.yml @@ -3,11 +3,11 @@ # Created by Adam Pope, bartolomesorianol, Bullmoose20 & Sohjiro # # Artwork Credit to Duhniel, Bullmoose20, and Wiki Commons # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/movie/region # +# https://kometa.wiki/en/latest/defaults/movie/region # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "081" diff --git a/defaults/movie/seasonal.yml b/defaults/movie/seasonal.yml index 2d43add5..6d131f02 100644 --- a/defaults/movie/seasonal.yml +++ b/defaults/movie/seasonal.yml @@ -2,11 +2,11 @@ # Seasonal Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/movie/seasonal # +# https://kometa.wiki/en/latest/defaults/movie/seasonal # ############################################################################## external_templates: - pmm: templates + default: templates templates: holiday: @@ -197,13 +197,13 @@ dynamic_collections: # check7 mdblist_list: aapi: - - https://mdblist.com/lists/plexmetamanager/asian-american-pacific-islander-heritage-month + - https://mdblist.com/lists/k0meta/asian-american-pacific-islander-heritage-month disabilities: - - https://mdblist.com/lists/plexmetamanager/day-of-persons-with-disabilities + - https://mdblist.com/lists/k0meta/day-of-persons-with-disabilities lgbtq: - - https://mdblist.com/lists/plexmetamanager/lgbtq-pride-month + - https://mdblist.com/lists/k0meta/lgbtq-pride-month latinx: - - https://mdblist.com/lists/plexmetamanager/latinx-heritage-month + - https://mdblist.com/lists/k0meta/latinx-heritage-month # check8 trakt_list: black_history: diff --git a/defaults/movie/writer.yml b/defaults/movie/writer.yml index 3227320e..e304c590 100644 --- a/defaults/movie/writer.yml +++ b/defaults/movie/writer.yml @@ -2,11 +2,11 @@ # Writer Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/movie/writer # +# https://kometa.wiki/en/latest/defaults/movie/writer # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "170" diff --git a/defaults/overlays/aspect.yml b/defaults/overlays/aspect.yml index a17661c6..0423bf98 100644 --- a/defaults/overlays/aspect.yml +++ b/defaults/overlays/aspect.yml @@ -2,11 +2,11 @@ # Aspect Ratio Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/aspect # +# https://kometa.wiki/en/latest/defaults/overlays/aspect # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: default: text_<>: <> diff --git a/defaults/overlays/audio_codec.yml b/defaults/overlays/audio_codec.yml index 50b1a89c..f603ca9c 100644 --- a/defaults/overlays/audio_codec.yml +++ b/defaults/overlays/audio_codec.yml @@ -3,11 +3,11 @@ # Created by Yozora, Bullmoose20, & Sohjiro # # Credit to Magic815 for base images # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/audio_codec # +# https://kometa.wiki/en/latest/defaults/overlays/audio_codec # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: default: standard_value: 105 @@ -38,7 +38,7 @@ external_templates: value: 0 - horizontal_align: [left, right] value: 15 - pmm: + default: conditions: - file.exists: false file_<>.exists: false diff --git a/defaults/overlays/commonsense.yml b/defaults/overlays/commonsense.yml index 6b1751cf..8381f985 100644 --- a/defaults/overlays/commonsense.yml +++ b/defaults/overlays/commonsense.yml @@ -2,11 +2,11 @@ # Commonsense Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/commonsense # +# https://kometa.wiki/en/latest/defaults/overlays/commonsense # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: default: key: <> @@ -45,7 +45,7 @@ external_templates: value: 0 - horizontal_align: [left, right] value: 15 - pmm: + default: conditions: - file.exists: false file_<>.exists: false diff --git a/defaults/overlays/content_rating_au.yml b/defaults/overlays/content_rating_au.yml index 28f10b1c..a0e18390 100644 --- a/defaults/overlays/content_rating_au.yml +++ b/defaults/overlays/content_rating_au.yml @@ -3,11 +3,11 @@ # Adapted by 2wenty2wo # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/content_rating_au # +# https://kometa.wiki/en/latest/defaults/overlays/content_rating_au # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: default: key: <> @@ -25,7 +25,7 @@ external_templates: conditions: - color: false value: "" - pmm: + default: conditions: - file.exists: false file_<>.exists: false diff --git a/defaults/overlays/content_rating_de.yml b/defaults/overlays/content_rating_de.yml index 0829d1ba..35447484 100644 --- a/defaults/overlays/content_rating_de.yml +++ b/defaults/overlays/content_rating_de.yml @@ -2,11 +2,11 @@ # DE Content Rating Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/content_rating_de # +# https://kometa.wiki/en/latest/defaults/overlays/content_rating_de # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: default: key: <> @@ -24,7 +24,7 @@ external_templates: conditions: - color: false value: "" - pmm: + default: conditions: - file.exists: false file_<>.exists: false diff --git a/defaults/overlays/content_rating_nz.yml b/defaults/overlays/content_rating_nz.yml index 630b16b9..633c9321 100644 --- a/defaults/overlays/content_rating_nz.yml +++ b/defaults/overlays/content_rating_nz.yml @@ -3,11 +3,11 @@ # Adapted by nzvengeance # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/content_rating_nz # +# https://kometa.wiki/en/latest/defaults/overlays/content_rating_nz # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: default: key: <> @@ -25,7 +25,7 @@ external_templates: conditions: - color: false value: "" - pmm: + default: conditions: - file.exists: false file_<>.exists: false diff --git a/defaults/overlays/content_rating_uk.yml b/defaults/overlays/content_rating_uk.yml index 9852620b..efe0064d 100644 --- a/defaults/overlays/content_rating_uk.yml +++ b/defaults/overlays/content_rating_uk.yml @@ -2,11 +2,11 @@ # UK Content Rating Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/content_rating_uk # +# https://kometa.wiki/en/latest/defaults/overlays/content_rating_uk # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: default: key: <> @@ -24,7 +24,7 @@ external_templates: conditions: - color: false value: "" - pmm: + default: conditions: - file.exists: false file_<>.exists: false diff --git a/defaults/overlays/content_rating_us_movie.yml b/defaults/overlays/content_rating_us_movie.yml index 89f8bfe5..f3c8258c 100644 --- a/defaults/overlays/content_rating_us_movie.yml +++ b/defaults/overlays/content_rating_us_movie.yml @@ -1,12 +1,12 @@ -###################################################################################### -# US Content Rating Movie Overlay # -# Created by Yozora, Bullmoose20, & Sohjiro # -# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/content_rating_us_movie # -###################################################################################### +############################################################################## +# US Content Rating Movie Overlay # +# Created by Yozora, Bullmoose20, & Sohjiro # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://kometa.wiki/en/latest/defaults/overlays/content_rating_us_movie # +############################################################################## external_templates: - pmm: templates + default: templates template_variables: default: key: <> @@ -24,7 +24,7 @@ external_templates: conditions: - color: false value: "" - pmm: + default: conditions: - file.exists: false file_<>.exists: false diff --git a/defaults/overlays/content_rating_us_show.yml b/defaults/overlays/content_rating_us_show.yml index b53c534e..9621259b 100644 --- a/defaults/overlays/content_rating_us_show.yml +++ b/defaults/overlays/content_rating_us_show.yml @@ -1,12 +1,12 @@ -###################################################################################### -# US Content Rating Show Overlay # -# Created by Yozora, Bullmoose20, & Sohjiro # -# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/content_rating_us_show # -###################################################################################### +############################################################################## +# US Content Rating Show Overlay # +# Created by Yozora, Bullmoose20, & Sohjiro # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://kometa.wiki/en/latest/defaults/overlays/content_rating_us_show # +############################################################################## external_templates: - pmm: templates + default: templates template_variables: default: key: <> @@ -24,7 +24,7 @@ external_templates: conditions: - color: false value: "" - pmm: + default: conditions: - file.exists: false file_<>.exists: false diff --git a/defaults/overlays/direct_play.yml b/defaults/overlays/direct_play.yml index a7975624..2a07154b 100644 --- a/defaults/overlays/direct_play.yml +++ b/defaults/overlays/direct_play.yml @@ -3,11 +3,11 @@ # Created by Yozora, Bullmoose20, & Sohjiro # # Credit to Magic815 for base images # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/direct_play # +# https://kometa.wiki/en/latest/defaults/overlays/direct_play # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: default: horizontal_align: center @@ -31,7 +31,7 @@ external_templates: value: 0 - horizontal_align: [left, right] value: 15 - pmm: + default: conditions: - file.exists: false file_<>.exists: false diff --git a/defaults/overlays/episode_info.yml b/defaults/overlays/episode_info.yml index 4feeacd8..6fecc799 100644 --- a/defaults/overlays/episode_info.yml +++ b/defaults/overlays/episode_info.yml @@ -2,11 +2,11 @@ # Episode Info Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/episode_info # +# https://kometa.wiki/en/latest/defaults/overlays/episode_info # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: default: horizontal_align: right diff --git a/defaults/overlays/images/network/color/ANIMAX.png b/defaults/overlays/images/network/color/ANIMAX.png new file mode 100644 index 00000000..9aa7abe3 Binary files /dev/null and b/defaults/overlays/images/network/color/ANIMAX.png differ diff --git a/defaults/overlays/images/network/white/ANIMAX.png b/defaults/overlays/images/network/white/ANIMAX.png new file mode 100644 index 00000000..0111d2ee Binary files /dev/null and b/defaults/overlays/images/network/white/ANIMAX.png differ diff --git a/defaults/overlays/images/studio/bigger/Broken Lizard Industries.png b/defaults/overlays/images/studio/bigger/Broken Lizard Industries.png new file mode 100644 index 00000000..418c316b Binary files /dev/null and b/defaults/overlays/images/studio/bigger/Broken Lizard Industries.png differ diff --git a/defaults/overlays/images/studio/bigger/Codeblack Entertainment.png b/defaults/overlays/images/studio/bigger/Codeblack Entertainment.png new file mode 100644 index 00000000..b4e42ccc Binary files /dev/null and b/defaults/overlays/images/studio/bigger/Codeblack Entertainment.png differ diff --git a/defaults/overlays/images/studio/bigger/Dimension Films.png b/defaults/overlays/images/studio/bigger/Dimension Films.png new file mode 100644 index 00000000..396f29a7 Binary files /dev/null and b/defaults/overlays/images/studio/bigger/Dimension Films.png differ diff --git a/defaults/overlays/images/studio/bigger/Magic Light Pictures.png b/defaults/overlays/images/studio/bigger/Magic Light Pictures.png new file mode 100644 index 00000000..f90930a1 Binary files /dev/null and b/defaults/overlays/images/studio/bigger/Magic Light Pictures.png differ diff --git a/defaults/overlays/images/studio/standard/Broken Lizard Industries.png b/defaults/overlays/images/studio/standard/Broken Lizard Industries.png new file mode 100644 index 00000000..5cd26692 Binary files /dev/null and b/defaults/overlays/images/studio/standard/Broken Lizard Industries.png differ diff --git a/defaults/overlays/images/studio/standard/Codeblack Entertainment.png b/defaults/overlays/images/studio/standard/Codeblack Entertainment.png new file mode 100644 index 00000000..2f45cf86 Binary files /dev/null and b/defaults/overlays/images/studio/standard/Codeblack Entertainment.png differ diff --git a/defaults/overlays/images/studio/standard/Dimension Films.png b/defaults/overlays/images/studio/standard/Dimension Films.png new file mode 100644 index 00000000..04dc02db Binary files /dev/null and b/defaults/overlays/images/studio/standard/Dimension Films.png differ diff --git a/defaults/overlays/images/studio/standard/Magic Light Pictures.png b/defaults/overlays/images/studio/standard/Magic Light Pictures.png new file mode 100644 index 00000000..b00bb348 Binary files /dev/null and b/defaults/overlays/images/studio/standard/Magic Light Pictures.png differ diff --git a/defaults/overlays/language_count.yml b/defaults/overlays/language_count.yml index 3529a3fc..844079c1 100644 --- a/defaults/overlays/language_count.yml +++ b/defaults/overlays/language_count.yml @@ -3,11 +3,11 @@ # Created by Yozora, Bullmoose20, & Sohjiro # # Credit to Magic815 for base images # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/language_count # +# https://kometa.wiki/en/latest/defaults/overlays/language_count # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: default: horizontal_align: center @@ -34,7 +34,7 @@ external_templates: value: 0 - horizontal_align: [left, right] value: 15 - pmm: + default: conditions: - file.exists: false file_<>.exists: false diff --git a/defaults/overlays/languages.yml b/defaults/overlays/languages.yml index 047dbb7c..50388741 100644 --- a/defaults/overlays/languages.yml +++ b/defaults/overlays/languages.yml @@ -2,11 +2,11 @@ # Audio/Subtitle Language Flags Overlays # # Created by Yozora, Bullmoose20, Cpt Kuesel, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/languages # +# https://kometa.wiki/en/latest/defaults/overlays/languages # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: conditionals: final_align: @@ -32,7 +32,7 @@ external_templates: value: 26 - style: square value: - pmm_<>: + default_<>: conditions: - file.exists: false url.exists: false diff --git a/defaults/overlays/mediastinger.yml b/defaults/overlays/mediastinger.yml index 9bda9c5d..5c3f75bc 100644 --- a/defaults/overlays/mediastinger.yml +++ b/defaults/overlays/mediastinger.yml @@ -2,11 +2,11 @@ # MediaStinger Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/mediastinger # +# https://kometa.wiki/en/latest/defaults/overlays/mediastinger # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: default: horizontal_align: right @@ -30,7 +30,7 @@ external_templates: value: 0 - horizontal_align: [left, right] value: 15 - pmm: + default: conditions: - file.exists: false file_<>.exists: false diff --git a/defaults/overlays/network.yml b/defaults/overlays/network.yml index 2c646f8a..46aaeec4 100644 --- a/defaults/overlays/network.yml +++ b/defaults/overlays/network.yml @@ -2,11 +2,11 @@ # Network Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/network # +# https://kometa.wiki/en/latest/defaults/overlays/network # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: run_definition: - <>>> @@ -35,7 +35,7 @@ external_templates: value: 0 - horizontal_align: [left, right] value: 15 - pmm: + default: conditions: - file.exists: false file_<>.exists: false @@ -129,6 +129,10 @@ overlays: variables: { weight: 10} template: [name: standard, {name: networks, search: [Animal Planet, Animal Planet Brasil, Animal Planet Deutschland]}] + ANIMAX: + variables: { weight: 10} + template: [name: standard, name: networks] + Angel Studios: variables: { weight: 10} template: [name: standard, {name: networks, search: [Angel Studios, VidAngel]}] diff --git a/defaults/overlays/ratings.yml b/defaults/overlays/ratings.yml index 1bf47a92..a84d323e 100644 --- a/defaults/overlays/ratings.yml +++ b/defaults/overlays/ratings.yml @@ -2,7 +2,7 @@ # Ratings Overlays # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/ratings # +# https://kometa.wiki/en/latest/defaults/overlays/ratings # ############################################################################## templates: @@ -13,8 +13,8 @@ templates: rating<>_url: <> rating<>_git: <> rating<>_repo: <> - pmm: rating/<>_image_url>><> - rating<>_pmm: <> + default: rating/<>_image_url>><> + rating<>_default: <> weight: 100 font: fonts/Inter-Bold.ttf rating<>_font: <> @@ -76,10 +76,10 @@ templates: conditions: - image_level: Top rating<>_image: rt_tomato - value: https://mdblist.com/lists/plexmetamanager/certifiedfresh<>s + value: https://mdblist.com/lists/k0meta/certifiedfresh<>s - image_level: Top rating<>_image: metacritic - value: https://mdblist.com/lists/plexmetamanager/metacriticmustsee<>s + value: https://mdblist.com/lists/k0meta/metacriticmustsee<>s imdb_top: conditions: - image_level: Top @@ -433,7 +433,7 @@ templates: - rating<>: [critic, audience, user] image_level: Rotten value: lt - rating<>_pmm: + rating<>_default: conditions: - file.exists: false url.exists: false @@ -459,7 +459,7 @@ templates: url: <>_url>> git: <>_git>> repo: <>_repo>> - pmm: <>_pmm>> + default: <>_default>> group: rating<>_group weight: <> horizontal_offset: <>_horizontal_offset>> diff --git a/defaults/overlays/resolution.yml b/defaults/overlays/resolution.yml index 2ed23577..da50a1ba 100644 --- a/defaults/overlays/resolution.yml +++ b/defaults/overlays/resolution.yml @@ -3,11 +3,11 @@ # Created by Yozora, Bullmoose20, & Sohjiro # # Credit to Magic815 for base images # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/resolution # +# https://kometa.wiki/en/latest/defaults/overlays/resolution # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: conditionals: suppress_overlays: @@ -123,7 +123,7 @@ external_templates: conditions: - type: resolution_dovetail value: top - pmm: + default: conditions: - type: [edition, edition_dovetail] file.exists: false diff --git a/defaults/overlays/ribbon.yml b/defaults/overlays/ribbon.yml index c59410a8..db1b0ee8 100644 --- a/defaults/overlays/ribbon.yml +++ b/defaults/overlays/ribbon.yml @@ -2,11 +2,11 @@ # Ribbon Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/ribbon # +# https://kometa.wiki/en/latest/defaults/overlays/ribbon # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: default: style: yellow @@ -20,7 +20,7 @@ external_templates: value: black - style: red value: red - pmm: + default: conditions: - file.exists: false file_<>.exists: false @@ -42,7 +42,7 @@ templates: optional: - mdb_key - imdb_key - mdblist_list: https://mdblist.com/lists/plexmetamanager/<><>s + mdblist_list: https://mdblist.com/lists/k0meta/<><>s imdb_chart: <>_<>s overlays: diff --git a/defaults/overlays/runtimes.yml b/defaults/overlays/runtimes.yml index f02b969f..b3aa1843 100644 --- a/defaults/overlays/runtimes.yml +++ b/defaults/overlays/runtimes.yml @@ -2,11 +2,11 @@ # Runtimes Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/runtimes # +# https://kometa.wiki/en/latest/defaults/overlays/runtimes # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: default: text: "Runtime: " diff --git a/defaults/overlays/status.yml b/defaults/overlays/status.yml index bdb3dbff..11879576 100644 --- a/defaults/overlays/status.yml +++ b/defaults/overlays/status.yml @@ -2,11 +2,11 @@ # Status Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/status # +# https://kometa.wiki/en/latest/defaults/overlays/status # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: text_<>: <> group: status diff --git a/defaults/overlays/streaming.yml b/defaults/overlays/streaming.yml index 57ebb5c2..fd444f39 100644 --- a/defaults/overlays/streaming.yml +++ b/defaults/overlays/streaming.yml @@ -3,11 +3,11 @@ # Created by Yozora, Bullmoose20, & Sohjiro # # Credit to Magic815 for base images # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/streaming # +# https://kometa.wiki/en/latest/defaults/overlays/streaming # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: group: streaming default: @@ -32,7 +32,7 @@ external_templates: value: 0 - horizontal_align: [left, right] value: 15 - pmm: + default: conditions: - file.exists: false file_<>.exists: false @@ -94,7 +94,7 @@ templates: - region: CA key: ["1899", "37"] value: False - mdblist_list: https://mdblist.com/lists/plexmetamanager/<>-<> + mdblist_list: https://mdblist.com/lists/k0meta/<>-<> tmdb_discover: limit: <> with_watch_providers: <> @@ -171,5 +171,5 @@ overlays: template: [name: standard, name: mdb_streaming] hayu: - variables: {key: "8", originals_key: hayu, weight: 10, allowed_libraries: show} + variables: {key: "223", originals_key: hayu, weight: 10, allowed_libraries: show} template: [name: standard, name: mdb_streaming] diff --git a/defaults/overlays/studio.yml b/defaults/overlays/studio.yml index 4a7668f5..c72cb781 100644 --- a/defaults/overlays/studio.yml +++ b/defaults/overlays/studio.yml @@ -2,11 +2,11 @@ # Studio Overlay # # Created by Yozora, Bullmoose20, anon_fawkes Arial-Z & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/studios # +# https://kometa.wiki/en/latest/defaults/overlays/studios # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: default: width_value: 470 @@ -44,7 +44,7 @@ external_templates: value: 0 - horizontal_align: [left, right] value: 15 - pmm: + default: conditions: - file.exists: false file_<>.exists: false @@ -766,6 +766,9 @@ overlays: Brandywine Productions: template: [name: standard, name: studios] + Broken Lizard Industries: + template: [name: standard, name: studios] + Broken Road Productions: template: [name: standard, name: studios] @@ -814,6 +817,9 @@ overlays: Cinergi Pictures Entertainment: template: [name: standard, name: studios] + Codeblack Entertainment: + template: [name: standard, name: studios] + Columbia Pictures: template: [name: standard, {name: studios, search: [Columbia Pictures, Columbia TriStar]}] @@ -835,6 +841,9 @@ overlays: DC Comics: template: [name: standard, {name: studios, search: [DC Comics, DC Films, DC Entertainment]}] + Dimension Films: + template: [name: standard, name: studios] + Dino De Laurentiis Company: template: [name: standard, name: studios] @@ -1066,6 +1075,9 @@ overlays: Lucasfilm Ltd: template: [name: standard, {name: studios, search: [Lucasfilm Ltd, Lucasfilm Ltd., Lucasfilm, Lucasfilm Animation]}] + Magic Light Pictures: + template: [name: standard, name: studios] + Magnolia Pictures: template: [name: standard, name: studios] @@ -1481,4 +1493,4 @@ overlays: template: [name: standard, name: studios] Working Title Films: - template: [name: standard, name: studios] + template: [name: standard, name: studios] \ No newline at end of file diff --git a/defaults/overlays/templates.yml b/defaults/overlays/templates.yml index 87f9588c..b7d1209d 100644 --- a/defaults/overlays/templates.yml +++ b/defaults/overlays/templates.yml @@ -11,7 +11,9 @@ templates: url_<>: <> git_<>: <> repo_<>: <> - pmm_<>: <> + default: <> + pmm_<>: <> + default_<>: <>>> font_<>: <> font_size_<>: <> font_color_<>: <> @@ -83,7 +85,7 @@ templates: url: <>>> git: <>>> repo: <>>> - pmm: <>>> + default: <>>> group: <> queue: <> weight: <>>> diff --git a/defaults/overlays/versions.yml b/defaults/overlays/versions.yml index 5b2cda9c..848d131a 100644 --- a/defaults/overlays/versions.yml +++ b/defaults/overlays/versions.yml @@ -3,11 +3,11 @@ # Created by Yozora, Bullmoose20, & Sohjiro # # Credit to Magic815 for base images # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/versions # +# https://kometa.wiki/en/latest/defaults/overlays/versions # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: default: vertical_align: top @@ -47,7 +47,7 @@ external_templates: value: 0 - horizontal_align: [left, right] value: 15 - pmm: + default: conditions: - file.exists: false file_<>.exists: false diff --git a/defaults/overlays/video_format.yml b/defaults/overlays/video_format.yml index 6f202621..c05ca734 100644 --- a/defaults/overlays/video_format.yml +++ b/defaults/overlays/video_format.yml @@ -3,11 +3,11 @@ # Created by Yozora, Bullmoose20, & Sohjiro # # Credit to Magic815 for base images # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/video_format # +# https://kometa.wiki/en/latest/defaults/overlays/video_format # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: default: text_<>: <> diff --git a/defaults/playlist.yml b/defaults/playlist.yml index dc488971..669ec98f 100644 --- a/defaults/playlist.yml +++ b/defaults/playlist.yml @@ -2,11 +2,11 @@ # Playlists # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/playlist # +# https://kometa.wiki/en/latest/defaults/playlist # ############################################################################## external_templates: - pmm: templates + default: templates templates: playlist: @@ -36,7 +36,7 @@ templates: item_radarr_tag_<>: <> item_sonarr_tag_<>: <> trakt_list_<>: <> - url_poster_<>: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager-Images/master/playlist/<>.jpg + url_poster_<>: https://raw.githubusercontent.com/Kometa-Team/Default-Images/master/playlist/<>.jpg name_<>: <> sync_to_users_<>: <> exclude_users_<>: <> diff --git a/defaults/show/content_rating_us.yml b/defaults/show/content_rating_us.yml index 52415b76..968581ca 100644 --- a/defaults/show/content_rating_us.yml +++ b/defaults/show/content_rating_us.yml @@ -2,11 +2,11 @@ # US Content Rating Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/content_rating_us # +# https://kometa.wiki/en/latest/defaults/both/content_rating_us # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "110" diff --git a/defaults/show/continent.yml b/defaults/show/continent.yml index d55db1b8..9a95a894 100644 --- a/defaults/show/continent.yml +++ b/defaults/show/continent.yml @@ -3,11 +3,11 @@ # Created by Adam Pope, bartolomesorianol, Bullmoose20 & Sohjiro # # Artwork Credit to Duhniel, Bullmoose20, and Wiki Commons # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/show/continent # +# https://kometa.wiki/en/latest/defaults/show/continent # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "082" diff --git a/defaults/show/country.yml b/defaults/show/country.yml index 62c8836c..fc6c9463 100644 --- a/defaults/show/country.yml +++ b/defaults/show/country.yml @@ -3,11 +3,11 @@ # Created by Yozora, Bullmoose20, & Sohjiro # # Artwork Credit to Duhniel # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/show/country # +# https://kometa.wiki/en/latest/defaults/show/country # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "080" diff --git a/defaults/show/decade.yml b/defaults/show/decade.yml index a6e70bf1..f6a92fda 100644 --- a/defaults/show/decade.yml +++ b/defaults/show/decade.yml @@ -2,11 +2,11 @@ # Decade Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/show/decade # +# https://kometa.wiki/en/latest/defaults/show/decade # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "100" diff --git a/defaults/show/franchise.yml b/defaults/show/franchise.yml index dc69c038..053f414b 100644 --- a/defaults/show/franchise.yml +++ b/defaults/show/franchise.yml @@ -1,9 +1,9 @@ ############################################################################## # Franchise Collections # # Created by Yozora, Bullmoose20, & Sohjiro # -# Additional contributions by the PMM Community # +# Additional contributions by the Kometa Community # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/show/franchise # +# https://kometa.wiki/en/latest/defaults/show/franchise # ############################################################################## templates: @@ -24,7 +24,7 @@ templates: item_sonarr_tag_<>: <> sonarr_monitor_<>: <> collection_order_<>: <> - url_poster_<>: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager-Images/master/franchise/<>.jpg + url_poster_<>: https://raw.githubusercontent.com/Kometa-Team/Default-Images/master/franchise/<>.jpg optional: - name_<> - summary_<> diff --git a/defaults/show/network.yml b/defaults/show/network.yml index 147e220b..46130b6a 100644 --- a/defaults/show/network.yml +++ b/defaults/show/network.yml @@ -2,11 +2,11 @@ # Network Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/show/network # +# https://kometa.wiki/en/latest/defaults/show/network # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "050" @@ -55,6 +55,7 @@ dynamic_collections: - AMC - AMC+ - Animal Planet + - ANIMAX - Angel Studios - Antena 3 - Apple TV+ diff --git a/defaults/show/region.yml b/defaults/show/region.yml index 9fe3ceb5..819df3b1 100644 --- a/defaults/show/region.yml +++ b/defaults/show/region.yml @@ -3,11 +3,11 @@ # Created by Adam Pope, bartolomesorianol, Bullmoose20 & Sohjiro # # Artwork Credit to Duhniel, Bullmoose20, and Wiki Commons # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/show/region # +# https://kometa.wiki/en/latest/defaults/show/region # ############################################################################## external_templates: - pmm: templates + default: templates template_variables: collection_section: "081" diff --git a/defaults/templates.yml b/defaults/templates.yml index 4ed14345..654ee1c2 100644 --- a/defaults/templates.yml +++ b/defaults/templates.yml @@ -5,7 +5,7 @@ templates: key: separator sep_style: orig collection_section: "00" - url_poster_<>: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager-Images/master/separators/<>/<>.jpg + url_poster_<>: https://raw.githubusercontent.com/Kometa-Team/Default-Images/master/separators/<>/<>.jpg sort_prefix: "!" sort_title: <><>_!<> optional: @@ -76,7 +76,7 @@ templates: sort_title: <<sort_prefix>><<collection_section>><<pre>><<order_<<key>>>><<sort>> item_radarr_tag_<<key>>: <<item_radarr_tag>> item_sonarr_tag_<<key>>: <<item_sonarr_tag>> - url_poster: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager-Images/master/<<image>>.jpg + url_poster: https://raw.githubusercontent.com/Kometa-Team/Default-Images/master/<<image>>.jpg file_poster_<<key>>: <<file_poster>> url_background_<<key>>: <<url_background>> file_background_<<key>>: <<file_background>> @@ -161,7 +161,7 @@ templates: tmdb_person: default: - url_poster: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager-People-<<style>>/master/<<key_name_first_letter>>/Images/<<key_encoded>><<extra>>.jpg + url_poster: https://raw.githubusercontent.com/Kometa-Team/People-Images-<<style>>/master/<<key_name_first_letter>>/Images/<<key_encoded>><<extra>>.jpg url_poster_<<key>>: <<url_poster>> tmdb_person_offset_<<key>>: <<tmdb_person_offset>> optional: diff --git a/docs/assets/background.jpg b/docs/assets/background.jpg new file mode 100644 index 00000000..e46e7bae Binary files /dev/null and b/docs/assets/background.jpg differ diff --git a/docs/assets/favicon.png b/docs/assets/favicon.png index 947d8f39..79c7d18b 100644 Binary files a/docs/assets/favicon.png and b/docs/assets/favicon.png differ diff --git a/docs/assets/icon.png b/docs/assets/icon.png index 2fe13596..be9b3999 100644 Binary files a/docs/assets/icon.png and b/docs/assets/icon.png differ diff --git a/docs/assets/logo-dark.png b/docs/assets/logo-dark.png deleted file mode 100644 index 7407243f..00000000 Binary files a/docs/assets/logo-dark.png and /dev/null differ diff --git a/docs/assets/logo-full.png b/docs/assets/logo-full.png new file mode 100644 index 00000000..77807936 Binary files /dev/null and b/docs/assets/logo-full.png differ diff --git a/docs/assets/logo-full.webp b/docs/assets/logo-full.webp deleted file mode 100644 index 4dd9ed0f..00000000 Binary files a/docs/assets/logo-full.webp and /dev/null differ diff --git a/docs/assets/logo.png b/docs/assets/logo.png index ec05ba24..ed667fe3 100644 Binary files a/docs/assets/logo.png and b/docs/assets/logo.png differ diff --git a/docs/assets/logomark.png b/docs/assets/logomark.png index cf03a804..be9b3999 100644 Binary files a/docs/assets/logomark.png and b/docs/assets/logomark.png differ diff --git a/docs/config/auth.md b/docs/config/auth.md index c71a612a..a95da5b3 100644 --- a/docs/config/auth.md +++ b/docs/config/auth.md @@ -1,30 +1,31 @@ # Trakt and MyAnimeList Authentication -When trying to authorize Trakt or MyAnimeList, PMM needs to run in interactive mode so that you can enter details. This is problematic on some setups [namely docker] where entering interactive mode is not always simple. +When trying to authorize Trakt or MyAnimeList, Kometa needs to run in interactive mode so that you can enter details. This is problematic on some setups [namely docker] where entering interactive mode is not always simple. These scripts allow you to authorize Trakt and MyAnimeList here on the wiki. Once authorized, the script will give you a YAML block that you will copy into the config.yml, replacing the existing `trakt` and/or `myanimelist` sections. -The source code for these scripts can be found on [Chazlarson's GitHub Repository](https://github.com/chazlarson/PMM_Auth) +The source code for these scripts can be found on the [Trakt-MAL-OAuth Repository](https://github.com/Kometa-Team/Trakt-MAL-OAuth). + ## Usage 1. Enter client ID and secret. 2. For Trakt, if you didn't retrieve a PIN yourself less than ten minutes ago, click the button, and enter the PIN in the field. 3. For MyAnimeList, click the button to authenticate and get the required "localhost URL" 4. Click "Submit" -5. Copy and paste the result into your PMM config. +5. Copy and paste the result into your Kometa config. -<iframe src="https://pmm-auth-8e685ca9b226.herokuapp.com/" width="100%" height="700" style="border:0px solid black;"></iframe> +<iframe src="https://kometa-auth-2cb6c5672416.herokuapp.com/" width="100%" height="700" style="border:0px solid black;"></iframe> ## Running the Authentication Scripts Locally -For users who want full control over the scripts and would prefer the run them locally, you can run the script in docker or python by downloading the scripts from [Chazlarson's GitHub Repository](https://github.com/chazlarson/PMM_Auth) +For users who want full control over the scripts and would prefer the run them locally, you can run the script in docker or python by following the instructions in the [Trakt-MAL-OAuth Repository](https://github.com/Kometa-Team/Trakt-MAL-OAuth). ??? abstract "Click for instructions on how to run the scripts locally" - Ensure you have downloaded a copy of the script from [Chazlarson's GitHub Repository](https://github.com/chazlarson/PMM_Auth). If you have downloaded the ZIP, extract it to your desired location. + Ensure you have downloaded a copy of the [Trakt-MAL-OAuth Repository](https://github.com/Kometa-Team/Trakt-MAL-OAuth). If you have downloaded the ZIP file, extract it to your desired location. {% - include-markdown "https://raw.githubusercontent.com/chazlarson/PMM_Auth/main/README.md" + include-markdown "https://raw.githubusercontent.com/Kometa-Team/Trakt-MAL-OAuth/master/README.md" start="You can run it in Docker or Python." %} diff --git a/docs/config/file_types.md b/docs/config/file_types.md index 43363fd2..9af24942 100644 --- a/docs/config/file_types.md +++ b/docs/config/file_types.md @@ -25,7 +25,7 @@ These are the File types that can be utilized against Plex servers: - file: config/TVShows.yml - folder: config/TV Shows/ overlay_files: - - pmm: imdb + - default: imdb - repo: overlays playlist_files: - url: https://somewhere.com/Playlists.yml @@ -33,16 +33,16 @@ These are the File types that can be utilized against Plex servers: **Unlike the others, Playlist Files are not defined per-library.** - Within the above example, PMM will: + Within the above example, Kometa will: - * First, look within the root of the PMM directory (also known as `config/`) for a collection file named - `TVShows.yml`. If this file does not exist, PMM will skip the entry and move to the next one in the list. + * First, look within the root of the Kometa directory (also known as `config/`) for a collection file named + `TVShows.yml`. If this file does not exist, Kometa will skip the entry and move to the next one in the list. - * Then, look within the root of the PMM directory (also known as `config/`) for a directory called `TV Shows`, and + * Then, look within the root of the Kometa directory (also known as `config/`) for a directory called `TV Shows`, and then load any collection files within that directory. - * Then, look in the [defaults folder](https://github.com/meisnate12/Plex-Meta-Manager/tree/master/defaults) within - the local PMM folder [or docker container] for a file called `imdb.yml`. + * Then, look in the [defaults folder](https://github.com/Kometa-Team/Kometa/tree/master/defaults) within + the local Kometa folder [or docker container] for a file called `imdb.yml`. * Then, look within the Custom Defined Repo for a file called `overlays.yml`. diff --git a/docs/config/files.md b/docs/config/files.md index 38b1fab2..bfa31b17 100644 --- a/docs/config/files.md +++ b/docs/config/files.md @@ -1,6 +1,6 @@ # File Blocks -When using Plex Meta Manager, the structure of each library is made using File Blocks +When using Kometa, the structure of each library is made using File Blocks ???+ example "Example Library Structure" @@ -8,12 +8,12 @@ When using Plex Meta Manager, the structure of each library is made using File B libraries: Movies: collection_files: - - pmm: imdb + - default: imdb ``` - In the above example, `collection_files` is the type of File, which tells PMM that the entries that follow will - create/update collections and `- pmm:` is the type of Path, which PMM that the file it is looking for is a PMM - Defaults file. + In the above example, `collection_files` is the type of File, which tells Kometa that the entries that follow will + create/update collections and `- default:` is the type of Path, which Kometa that the file it is looking for is a + Kometa Defaults file. These ideas will be further outlined on this page. @@ -32,31 +32,31 @@ Every file block under the parent attribute begins with a `-`. ???+ example "Example Block" - This example has 2 blocks each using location type `pmm` with the path being `tmdb` and `imdb` respectively under - the parent attribute `collection_files`. + This example has 2 blocks each using location type `- default` with the path being `tmdb` and `imdb` respectively + under the parent attribute `collection_files`. ```yaml libraries: Movies: collection_files: # Parent Attribute - - pmm: tmdb # Block 1 - - pmm: imdb # Block 2 + - default: tmdb # Block 1 + - default: imdb # Block 2 ``` ### Location Types and Paths There are multiple location types that can be used to call a file. They can either be on the local system, online at an -url, part of the [PMM Defaults](../defaults/guide.md), directly from the -[PMM User Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs) repository, or from another -[`Custom Repository`](settings.md). +url, part of the [Kometa Defaults](../defaults/guide.md), directly from the +[Kometa Community Configs](https://github.com/Kometa-Team/Community-Configs) repository, or from another +[`Custom Repository`](settings.md#custom-repo). The location types are outlined as follows: ??? blank "`file` - Used to run a local file.<a class="headerlink" href="#file" title="Permanent link">¶</a>" - <div id="file" />Used to run a file which is located within the system that PMM is being run from. + <div id="file" />Used to run a file which is located within the system that Kometa is being run from. - File locations need to be accessible to PMM at those paths; this is typically only something you need to consider + File locations need to be accessible to Kometa at those paths; this is typically only something you need to consider when using Docker. ???+ example "Example" @@ -70,11 +70,11 @@ The location types are outlined as follows: ??? blank "`folder` - Used to run all local files in a directory.<a class="headerlink" href="#folder" title="Permanent link">¶</a>" - <div id="folder" />Used to run all files located in a directory which is located within the system that PMM is being - run from. + <div id="folder" />Used to run all files located in a directory which is located within the system that Kometa is + being run from. - Folder locations need to be accessible to PMM at those paths; this is typically only something you need to consider - when using Docker. + Folder locations need to be accessible to Kometa at those paths; this is typically only something you need to + consider when using Docker. ???+ example "Example" @@ -101,9 +101,9 @@ The location types are outlined as follows: - url: https://example.com/path/to/file.yml ``` -??? blank "`pmm` - Used to run a built-in [PMM Defaults](../defaults/guide.md) file.<a class="headerlink" href="#pmm" title="Permanent link">¶</a>" +??? blank "`default` - Used to run one of the built-in [Kometa Defaults](../defaults/guide.md) file.<a class="headerlink" href="#default" title="Permanent link">¶</a>" - <div id="pmm" />Used to run a built-in PMM Defaults file. The values you'd enter here are listed in the + <div id="default" />Used to run a built-in Kometa Defaults file. The values you'd enter here are listed in the [default usage guide](../defaults/guide.md). ???+ example "Example" @@ -112,13 +112,13 @@ The location types are outlined as follows: libraries: Movies: collection_files: - - pmm: oscars + - default: oscars ``` -??? blank "`git` - Used to run a file hosted on the [PMM User Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs) repository.<a class="headerlink" href="#git" title="Permanent link">¶</a>" +??? blank "`git` - Used to run a file hosted on the [Kometa Community Configs](https://github.com/Kometa-Team/Community-Configs) repository.<a class="headerlink" href="#git" title="Permanent link">¶</a>" <div id="git" />Used to run a file hosted on the - [PMM User Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs) repository. + [Kometa User Configs](https://github.com/Kometa-Team/Community-Configs) repository. Note that you enter the bits of the items path relative to the top level of the repo [`meisnate12/People`] and you don't need the `.yml` extension. @@ -129,7 +129,7 @@ The location types are outlined as follows: libraries: Movies: collection_files: - - git: meisnate12/People # this links to https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/meisnate12/People.yml + - git: meisnate12/People # this links to https://github.com/Kometa-Team/Community-Configs/blob/master/meisnate12/People.yml ``` ??? blank "`repo` - Used to run a file hosted on a custom repository.<a class="headerlink" href="#repo" title="Permanent link">¶</a>" @@ -143,7 +143,7 @@ The location types are outlined as follows: ???+ example "Example" This is assuming the `custom_repo` setting is - `https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/meisnate12`. + `https://github.com/Kometa-Team/Community-Configs/tree/master/meisnate12`. ```yaml libraries: @@ -167,7 +167,7 @@ You can have some control of the files from inside your Configuration file by us **Attribute:** `template_variables` - **Accepted Values:** [Dictionary](../pmm/yaml.md#dictionaries) of values specified by each particular file. + **Accepted Values:** [Dictionary](../kometa/yaml.md#dictionaries) of values specified by each particular file. **Default Value:** `None` @@ -177,17 +177,17 @@ You can have some control of the files from inside your Configuration file by us libraries: TV Shows: collection_files: - - pmm: genre + - default: genre template_variables: schedule_separator: never collection_mode: hide - - pmm: actor # Notice how the `-` starts this block + - default: actor # Notice how the `-` starts this block template_variables: schedule_separator: never collection_mode: hide ``` - In this example there will be two template variables added to every template in the git file pmm: genre. + In this example there will be two template variables added to every template in the git file default: genre. `schedule_separator` is set to `never` to not show a separator in this section and `collection_mode` is set to `hide`. @@ -219,7 +219,7 @@ You can have some control of the files from inside your Configuration file by us collection_files: - file: config/Movies.yml schedule: weekly(friday) - - pmm: actors + - default: actors schedule: weekly(saturday) playlist_files: - file: config/Playlists.yml @@ -233,8 +233,8 @@ You can have some control of the files from inside your Configuration file by us ???+ tip - Assets can be stored anywhere on the host system that PMM has visibility of (i.e. if using docker, the directory - must be mounted/visible to the docker container). + Assets can be stored anywhere on the host system that Kometa has visibility of (i.e. if using docker, the + directory must be mounted/visible to the docker container). <hr style="margin: 0px;"> @@ -252,10 +252,10 @@ You can have some control of the files from inside your Configuration file by us collection_files: - file: config/Movies.yml asset_directory: <path_to_assets>/Movies - - pmm: actors + - default: actors asset_directory: <path_to_assets>/people overlay_files: - - pmm: imdb + - default: imdb playlist_files: - file: config/Playlists.yml asset_directory: diff --git a/docs/config/libraries.md b/docs/config/libraries.md index 28cae104..a7b16faa 100644 --- a/docs/config/libraries.md +++ b/docs/config/libraries.md @@ -6,9 +6,9 @@ search: # Library Attributes Within the [Configuration File](overview.md), the `libraries` attribute specifies the Plex libraries that the user wants -Plex Meta Manager to act on. +Kometa to act on. -Attributes are used to instruct Plex Meta Manager what actions to take, such as "load the following libraries" or +Attributes are used to instruct Kometa what actions to take, such as "load the following libraries" or "execute the following Collection Definition files". These attributes can be specified individually per library, or can be inherited from the global value if it has been set. If an attribute is specified at both the library and global level, then the library level attribute will take priority. @@ -21,7 +21,7 @@ The available attributes for each library are as follows: <div id="library-name" />*Required only when trying to use multiple servers with the same name.* - Each library that the user wants Plex Meta Manager to interact with must be documented with a library attribute. + Each library that the user wants Kometa to interact with must be documented with a library attribute. A library attribute is represented by the mapping name (i.e. `Movies` or `TV Shows`), this must have a unique name that correlates with a library of the same name within the Plex Media Server. @@ -81,12 +81,12 @@ The available attributes for each library are as follows: TV Shows: collection_files: - file: config/TV Shows.yml - - pmm: tmdb - - pmm: network + - default: tmdb + - default: network ``` - By default, when `collection_files` is missing Plex Meta Manager will look within the root PMM directory for a - collection file called `<MAPPING_NAME>.yml`. In this example, Plex Meta Manager will look for a file named + By default, when `collection_files` is missing Kometa will look within the root Kometa directory for a + collection file called `<MAPPING_NAME>.yml`. In the example below, Kometa will look for a file named `TV Shows.yml`. ```yaml @@ -102,11 +102,11 @@ The available attributes for each library are as follows: ???+ tip - As of Plex Meta Manager 1.20.0 "Metadata Files" refers to YAML files which refers to managing the metadata of + As of Kometa 1.20.0 "Metadata Files" refers to YAML files which refers to managing the metadata of items [movies, shows, music] within your library, and "Collection Files" refers to YAML files which define Collections. - In previous version of Plex Meta Manager, "Metadata Files" could mean either of the above. + In previous version of Kometa, "Metadata Files" could mean either of the above. <hr style="margin: 0px;"> @@ -200,7 +200,7 @@ The available attributes for each library are as follows: **Attribute:** `template_variables` - **Accepted Values:** [Dictionary](../pmm/yaml.md#dictionaries) of values specified by each particular file. + **Accepted Values:** [Dictionary](../kometa/yaml.md#dictionaries) of values specified by each particular file. **Default Value:** `None` @@ -259,7 +259,7 @@ The available attributes for each library are as follows: libraries: Movies: collection_files: - - pmm: imdb + - default: imdb operations: mass_critic_rating_update: tmdb split_duplicates: true @@ -272,7 +272,7 @@ The available attributes for each library are as follows: ???+ warning "Proceed with Caution" When set to `true`, this will remove all overlays from your library every run, but will not delete - the overlaid images from your system, resulting in [image bloat](../pmm/scripts/image-cleanup.md). + the overlaid images from your system, resulting in [image bloat](../kometa/scripts/imagemaid.md). <hr style="margin: 0px;"> @@ -301,7 +301,7 @@ The available attributes for each library are as follows: ???+ warning "Proceed with Caution" When set to `true`, this will reapply all overlays on each run even if there is no need to do so, which will result in - [image bloat](../pmm/scripts/image-cleanup.md). + [image bloat](../kometa/scripts/imagemaid.md). <hr style="margin: 0px;"> @@ -331,7 +331,7 @@ The available attributes for each library are as follows: ???+ warning "Proceed with Caution" This will reset all posters to the desired source on each run and will reapply - all overlays on each run, which will result in [image bloat](../pmm/scripts/image-cleanup.md). + all overlays on each run, which will result in [image bloat](../kometa/scripts/imagemaid.md). <hr style="margin: 0px;"> @@ -357,7 +357,7 @@ The available attributes for each library are as follows: <div id="schedule-overlays" />Used to schedule overlays to run when desired. Overlays are applied all at once in a batch therefore you cannot schedule individual Overlay Files, as any unscheduled overlay file will be removed each - time PMM is run. + time Kometa is run. <hr style="margin: 0px;"> @@ -397,7 +397,7 @@ The available attributes for each library are as follows: libraries: Movies: collection_files: - - pmm: imdb + - default: imdb settings: asset_directory: config/asssets/Movies ``` @@ -639,18 +639,18 @@ This example is an advanced version of the library mappings which highlights som Movies: collection_files: - file: config/Movies.yml - - pmm: imdb - - pmm: studio - - pmm: genre - - pmm: actor + - default: imdb + - default: studio + - default: genre + - default: actor operations: mass_critic_rating_update: tmdb split_duplicates: true TV Shows: collection_files: - file: config/TV Shows.yml - - pmm: tmdb - - pmm: network + - default: tmdb + - default: network remove_overlays: false overlay_files: - file: config/Overlays.yml @@ -661,12 +661,12 @@ This example is an advanced version of the library mappings which highlights som token: #################### collection_files: - file: config/TV Shows.yml - - pmm: tmdb - - pmm: network + - default: tmdb + - default: network Anime: collection_files: - file: config/Anime.yml - - pmm: myanimelist + - default: myanimelist radarr: url: http://192.168.1.45:7878 token: ################################ @@ -684,6 +684,6 @@ This example is an advanced version of the library mappings which highlights som monitor: true availability: announced quality_profile: HD-1080p - tag: pmm + tag: kometa search: false ``` diff --git a/docs/config/myanimelist.md b/docs/config/myanimelist.md index 93ffc80d..d4845330 100644 --- a/docs/config/myanimelist.md +++ b/docs/config/myanimelist.md @@ -25,17 +25,17 @@ mal: | `client_secret` | MyAnimeList Application Client Secret | :fontawesome-solid-circle-check:{ .green } | | `localhost_url` | MyAnimeList Authorization URL | :fontawesome-solid-circle-xmark:{ .red } | -All other attributes will be filled in by Plex Meta Manager. +All other attributes will be filled in by Kometa. -To connect to MyAnimeList.net you must create a MyAnimeList application and supply Plex Meta Manager the `client id` and +To connect to MyAnimeList.net you must create a MyAnimeList application and supply Kometa the `client id` and `client secret` provided, please do the following: 1. [Click here to create a MyAnimeList API application.](https://myanimelist.net/apiconfig/create) -2. Enter an `App Name` for the application. Ex. `Plex Meta Manager` +2. Enter an `App Name` for the application. Ex. `Kometa` 3. Select `web` for `App Type`. -4. Enter an `App Description` for the application Ex. `Plex Meta Manager manages metadata and collections` +4. Enter an `App Description` for the application Ex. `Kometa manages metadata and collections` 5. Enter `http://localhost/` for `App Redirect URL`. -6. Enter `https://github.com/meisnate12/Plex-Meta-Manager` for `Homepage URL`. +6. Enter `https://github.com/Kometa-Team/Kometa` for `Homepage URL`. 7. Select `non-commercial` for `Commercial / Non-Commercial`. 8. Enter any name under `Name / Company Name`. 9. Select `hobbyist` for `Purpose of Use`. @@ -66,19 +66,19 @@ To connect to MyAnimeList.net you must create a MyAnimeList application and supp You will need to stop that web server while you're doing this in order to grab that localhost URL. -19. Run PMM and the auth will be completed. +19. Run Kometa and the auth will be completed. -## Alternative Way of Letting PMM make the URL +## Alternative Way of Letting Kometa make the URL -You can record just your `client_id` and `client_secret` and pmm will create the url for you described below. +You can record just your `client_id` and `client_secret` and Kometa will create the url for you described below. -On the first run, Plex Meta Manager will walk the user through the OAuth flow by producing a MyAnimeList URL for the +On the first run, Kometa will walk the user through the OAuth flow by producing a MyAnimeList URL for the user to follow. After following the URL login to MyAnimeList.net and authorize the application by clicking the `Allow` button which will redirect the user to `http://localhost/`. -Copy the entire URL and paste it into Plex Meta Manager and if the URL is correct then Plex Meta Manager will populate +Copy the entire URL and paste it into Kometa and if the URL is correct then Kometa will populate the `authorization` sub-attributes to use in subsequent runs. On first run: @@ -112,7 +112,7 @@ You will need to stop that web server while you're doing this in order to grab t ``` | URL: http://localhost/?code=BOING -| Saving authorization information to /path/to/Plex-Meta-Manager/config/config.yml | +| Saving authorization information to /path/to/kometa/config/config.yml | | My Anime List Connection Successful | |====================================================================================================| diff --git a/docs/config/operations.md b/docs/config/operations.md index 288c664b..6c44826d 100644 --- a/docs/config/operations.md +++ b/docs/config/operations.md @@ -16,7 +16,7 @@ When not using a list under `operations` the whole operations value is one block libraries: Movies: collection_files: - - pmm: imdb + - default: imdb operations: mass_critic_rating_update: tmdb split_duplicates: true @@ -33,7 +33,7 @@ You can create individual blocks of operations by using a list under `operations libraries: Movies: collection_files: - - pmm: imdb + - default: imdb operations: - schedule: weekly(friday) mass_critic_rating_update: tmdb @@ -78,10 +78,10 @@ You can create individual blocks of operations by using a list under `operations **Accepted Values:** There are a few different options to determine how the `delete_collections` works. <table class="clearTable"> - <tr><td>`managed: true`</td><td>Collection must be Managed to be deleted<br>(collection has the `PMM` label)</td></tr> - <tr><td>`managed: false`</td><td>Collection must be Unmanaged to be deleted<br>(collection does not have the `PMM` label)</td></tr> - <tr><td>`configured: true`</td><td>Collection must be Configured to be deleted<br>(collection is in the config file of the specific PMM run)</td></tr> - <tr><td>`configured: false`</td><td>Collection must be Unconfigured to be deleted<br>(collection is not in the config file of the specific PMM run)</td></tr> + <tr><td>`managed: true`</td><td>Collection must be Managed to be deleted<br>(collection has the `Kometa` label)</td></tr> + <tr><td>`managed: false`</td><td>Collection must be Unmanaged to be deleted<br>(collection does not have the `Kometa` label)</td></tr> + <tr><td>`configured: true`</td><td>Collection must be Configured to be deleted<br>(collection is in the config file of the specific Kometa run)</td></tr> + <tr><td>`configured: false`</td><td>Collection must be Unconfigured to be deleted<br>(collection is not in the config file of the specific Kometa run)</td></tr> <tr><td>`less: ###`</td><td>Collection must contain less than the given number of items to be deleted.<br>### is a Number greater than 0<br>Optional value which if undefined means collections will be deleted regardless of how many items they have</td></tr> </table> @@ -89,7 +89,7 @@ You can create individual blocks of operations by using a list under `operations ???+ example "Example" - Removes all Managed Collections (Collections with the `PMM` Label) that are not configured in the Current Run. + Removes all Managed Collections (Collections with the `Kometa` Label) that are not configured in the Current Run. ```yaml libraries: @@ -316,8 +316,8 @@ You can create individual blocks of operations by using a list under `operations no matter what happens with this mass rating update operation, the icons in the Plex UI will remain Rotten Tomatoes. The human who decided to put TMDb ratings in the critic slot and Letterboxd ratings in the audience slot is the only party who knows that the ratings are no longer Rotten Tomatoes. One primary use of this feature - is to put ratings overlays on posters. More information on what PMM can do with these ratings can be found - [here](../pmm/guides/ratings.md). + is to put ratings overlays on posters. More information on what Kometa can do with these ratings can be found + [here](../kometa/guides/ratings.md). <hr style="margin: 0px;"> @@ -385,8 +385,8 @@ You can create individual blocks of operations by using a list under `operations no matter what happens with this mass rating update operation, the icons in the Plex UI will remain Rotten Tomatoes. The human who decided to put TMDb ratings in the critic slot and Letterboxd ratings in the audience slot is the only party who knows that the ratings are no longer Rotten Tomatoes. One primary use of this feature - is to put ratings overlays on posters. More information on what PMM can do with these ratings can be found - [here](../pmm/guides/ratings.md). + is to put ratings overlays on posters. More information on what Kometa can do with these ratings can be found + [here](../kometa/guides/ratings.md). <hr style="margin: 0px;"> @@ -432,8 +432,8 @@ You can create individual blocks of operations by using a list under `operations ???+ warning - When used in combination with Overlays, this could cause PMM to reset the poster and then reapply all overlays - on each run, which will result in [image bloat](../pmm/scripts/image-cleanup.md). + When used in combination with Overlays, this could cause Kometa to reset the poster and then reapply all overlays + on each run, which will result in [image bloat](../kometa/scripts/imagemaid.md). <hr style="margin: 0px;"> @@ -468,8 +468,8 @@ You can create individual blocks of operations by using a list under `operations ???+ warning - When used in combination with Overlays, this could cause PMM to reset the background and then reapply all - overlays on each run, which will result in [image bloat](../pmm/scripts/image-cleanup.md). + When used in combination with Overlays, this could cause Kometa to reset the background and then reapply all + overlays on each run, which will result in [image bloat](../kometa/scripts/imagemaid.md). <hr style="margin: 0px;"> @@ -812,12 +812,12 @@ You can create individual blocks of operations by using a list under `operations ###### Metadata Backup -??? blank "`metadata_backup` - Creates/Maintains a PMM Metadata File for the library.<a class="headerlink" href="#metadata-backup" title="Permanent link">¶</a>" +??? blank "`metadata_backup` - Creates/Maintains a Kometa Metadata File for the library.<a class="headerlink" href="#metadata-backup" title="Permanent link">¶</a>" - <div id="metadata-backup" />Creates/Maintains a Plex Meta Manager Metadata File with a full `metadata` mapping based + <div id="metadata-backup" />Creates/Maintains a Kometa Metadata File with a full `metadata` mapping based on the library's items locked attributes. - If you point to an existing Metadata File then PMM will Sync the changes to the file, so you won't lose non plex + If you point to an existing Metadata File then Kometa will Sync the changes to the file, so you won't lose non plex changes in the file. <hr style="margin: 0px;"> diff --git a/docs/config/overview.md b/docs/config/overview.md index 2f23ae8b..16abf692 100644 --- a/docs/config/overview.md +++ b/docs/config/overview.md @@ -1,15 +1,14 @@ # Config File -Plex Meta Manager uses a YAML configuration file; this file contains settings that determine how Plex Meta Manager -behaves, and the required connection details needed to connect to Plex Media Server, Radarr, Sonarr, and other -third-party services via API. +Kometa uses a YAML configuration file; this file contains settings that determine how Kometa behaves, and the required +connection details needed to connect to Plex Media Server, Radarr, Sonarr, and other third-party services via API. -By default, and unless otherwise stated, Plex Meta Manager looks for the configuration file at `/config/config.yml`. +By default, and unless otherwise stated, Kometa looks for the configuration file at `/config/config.yml`. A template Configuration File can be found in the -[GitHub Repo](https://github.com/meisnate12/Plex-Meta-Manager/blob/master/config/config.yml.template). +[GitHub Repo](https://github.com/Kometa-Team/Kometa/blob/master/config/config.yml.template). -This table outlines the third-party services that Plex Meta Manager can make use of. Each service has specific +This table outlines the third-party services that Kometa can make use of. Each service has specific requirements for setup that can be found by clicking the links within the table. | Attribute | Required | diff --git a/docs/config/playlists.md b/docs/config/playlists.md index 6b4a7846..db270837 100644 --- a/docs/config/playlists.md +++ b/docs/config/playlists.md @@ -4,8 +4,8 @@ As playlists are not tied to one specific library and can combine media from mul special [Playlist Files](../files/playlists.md) to work. Within the [Configuration File](overview.md), the `playlist_files` attribute specifies the -[File Blocks](../config/files.md#blocks) of the [Playlist Files](../files/playlists.md) that the user wants Plex Meta -Manager to act on. +[File Blocks](../config/files.md#blocks) of the [Playlist Files](../files/playlists.md) that the user wants Kometa to +act on. **The libraries used in the playlist attribute `libraries` must be defined under the `libraries` attribute of the [Configuration File](overview.md).** @@ -13,7 +13,7 @@ Manager to act on. ```yaml playlist_files: - file: config/playlists.yml - - pmm: playlist + - default: playlist ``` ???+ example "Example" @@ -25,22 +25,22 @@ playlist_files: Movies: collection_files: - file: config/Movies.yml - - pmm: imdb - - pmm: studio - - pmm: genre - - pmm: actor + - default: imdb + - default: studio + - default: genre + - default: actor operations: mass_critic_rating_update: tmdb split_duplicates: true TV Shows: collection_files: - file: config/TV Shows.yml - - pmm: tmdb - - pmm: network + - default: tmdb + - default: network remove_overlays: false overlay_files: - file: config/Overlays.yml playlist_files: - file: config/playlists.yml - - pmm: playlist + - default: playlist ``` \ No newline at end of file diff --git a/docs/config/plex.md b/docs/config/plex.md index 82b40650..7cbd8f18 100644 --- a/docs/config/plex.md +++ b/docs/config/plex.md @@ -47,7 +47,7 @@ recommended to use `HTTPS`. # Multi-Plex Instance Setup: -The below config.yml extract details how to set up multiple Plex servers within the one PMM instance, in this example +The below config.yml extract details how to set up multiple Plex servers within the one Kometa instance, in this example there are two plex servers which are receiving the same Collection File: ```yaml diff --git a/docs/config/radarr.md b/docs/config/radarr.md index 13dd91cb..d3020eae 100644 --- a/docs/config/radarr.md +++ b/docs/config/radarr.md @@ -11,7 +11,7 @@ they're found missing while updating a library's collections. Radarr V2 may work, but it is not supported. Please upgrade to V3 if you can. -Items in your List Exclusions will be ignored by PMM. +Items in your List Exclusions will be ignored by Kometa. A `radarr` mapping can be either in the root of the config file as global mapping for all libraries, or you can specify the `radarr` mapping individually per library. @@ -32,29 +32,29 @@ radarr: monitor: false availability: announced quality_profile: HD-1080p - tag: pmm + tag: kometa search: false radarr_path: /media plex_path: /share/CACHEDEV1_DATA/Multimedia ``` -| Attribute | Allowed Values | Default | Required | -|:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------|:------------------------------------------:| -| `url` | Radarr URL (Including URL Base if set).<br>**Example:** http://192.168.1.12:32788 | N/A | :fontawesome-solid-circle-check:{ .green } | -| `token` | Radarr API Token. | N/A | :fontawesome-solid-circle-check:{ .green } | -| `add_missing` | Adds all missing movies found from all collections to Radarr.<br>Use the `radarr_add_missing` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to add missing per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | -| `add_existing` | Adds all existing movies in collections to Radarr.<br>Use the `radarr_add_existing` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to add existing per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | -| `upgrade_existing` | Upgrades all existing movies in collections to match the Quality Profile of the collection.<br>Use the `radarr_upgrade_existing` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to upgrade the Quality Profile per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | -| `monitor_existing` | Ensures all existing movies in collections match your monitor setting.<br>Use the `radarr_monitor_existing` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to match the monitor setting per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | -| `ignore_cache` | Ignores PMM's cache when adding items to Radarr.<br>Use the `radarr_ignore_cache` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to ignore per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | -| `root_folder_path` | Default Root Folder Path to use when adding new movies.<br>Use the `radarr_folder` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to set the Root Folder per collection. | N/A | :fontawesome-solid-circle-check:{ .green } | -| `monitor` | Monitor the movie when adding new movies.<br>Use the `radarr_monitor` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to set the Monitor value per collection.<br>**Options:** `true`, `false` | true | :fontawesome-solid-circle-xmark:{ .red } | -| `availability` | Default Minimum Availability to use when adding new movies.<br>Use the `radarr_availability` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to set the Availability per collection.<br>**Options:** `announced`, `cinemas`, `released`, `db` | `announced` | :fontawesome-solid-circle-check:{ .green } | -| `quality_profile` | Default Quality Profile to use when adding new movies.<br>Use the `radarr_quality` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to set the Quality Profile per collection. | N/A | :fontawesome-solid-circle-check:{ .green } | -| `tag` | Default list or comma-separated string of tags to use when adding new movies.<br>Use the `radarr_tag` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to set the Tags per collection. | ` ` | :fontawesome-solid-circle-xmark:{ .red } | -| `search` | Start search for missing movie when adding new movies.<br>Use the `radarr_search` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to set the search value per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | -| `plex_path` | When using `add_existing` or `radarr_add_all` Convert this part of the path to `radarr_path`. | ` ` | :fontawesome-solid-circle-xmark:{ .red } | -| `radarr_path` | When using `add_existing` or `radarr_add_all` Convert the `plex_path` part of the path to this. | ` ` | :fontawesome-solid-circle-xmark:{ .red } | +| Attribute | Allowed Values | Default | Required | +|:-------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------|:------------------------------------------:| +| `url` | Radarr URL (Including URL Base if set).<br>**Example:** http://192.168.1.12:32788 | N/A | :fontawesome-solid-circle-check:{ .green } | +| `token` | Radarr API Token. | N/A | :fontawesome-solid-circle-check:{ .green } | +| `add_missing` | Adds all missing movies found from all collections to Radarr.<br>Use the `radarr_add_missing` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to add missing per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | +| `add_existing` | Adds all existing movies in collections to Radarr.<br>Use the `radarr_add_existing` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to add existing per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | +| `upgrade_existing` | Upgrades all existing movies in collections to match the Quality Profile of the collection.<br>Use the `radarr_upgrade_existing` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to upgrade the Quality Profile per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | +| `monitor_existing` | Ensures all existing movies in collections match your monitor setting.<br>Use the `radarr_monitor_existing` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to match the monitor setting per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | +| `ignore_cache` | Ignores Kometa's cache when adding items to Radarr.<br>Use the `radarr_ignore_cache` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to ignore per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | +| `root_folder_path` | Default Root Folder Path to use when adding new movies.<br>Use the `radarr_folder` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to set the Root Folder per collection. | N/A | :fontawesome-solid-circle-check:{ .green } | +| `monitor` | Monitor the movie when adding new movies.<br>Use the `radarr_monitor` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to set the Monitor value per collection.<br>**Options:** `true`, `false` | true | :fontawesome-solid-circle-xmark:{ .red } | +| `availability` | Default Minimum Availability to use when adding new movies.<br>Use the `radarr_availability` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to set the Availability per collection.<br>**Options:** `announced`, `cinemas`, `released`, `db` | `announced` | :fontawesome-solid-circle-check:{ .green } | +| `quality_profile` | Default Quality Profile to use when adding new movies.<br>Use the `radarr_quality` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to set the Quality Profile per collection. | N/A | :fontawesome-solid-circle-check:{ .green } | +| `tag` | Default list or comma-separated string of tags to use when adding new movies.<br>Use the `radarr_tag` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to set the Tags per collection. | ` ` | :fontawesome-solid-circle-xmark:{ .red } | +| `search` | Start search for missing movie when adding new movies.<br>Use the `radarr_search` [Radarr Setting](../files/arr.md#radarr-definition-settings) in the collection definition to set the search value per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | +| `plex_path` | When using `add_existing` or `radarr_add_all` Convert this part of the path to `radarr_path`. | ` ` | :fontawesome-solid-circle-xmark:{ .red } | +| `radarr_path` | When using `add_existing` or `radarr_add_all` Convert the `plex_path` part of the path to this. | ` ` | :fontawesome-solid-circle-xmark:{ .red } | ???+ tip diff --git a/docs/config/schedule.md b/docs/config/schedule.md index f96e228c..ab6e857b 100644 --- a/docs/config/schedule.md +++ b/docs/config/schedule.md @@ -1,14 +1,14 @@ -# Scheduling Parts of PMM +# Scheduling Parts of Kometa -Plex Meta Manager allows you to schedule libraries, files, overlays, operations, and more so that runs can be tailored +Kometa allows you to schedule libraries, files, overlays, operations, and more so that runs can be tailored to suit your needs. This is particularly handy for users who have a lot of libraries or run a lot of Metadata/Operations on their libraries. ### IMPORTANT: -These schedules do not trigger PMM to run; they control what PMM will do if it happens to be running at the scheduled -time. `weekly(sunday)`, for example, does not mean "run PMM on Sunday to do this thing"; it means "If PMM is running, +These schedules do not trigger Kometa to run; they control what Kometa will do if it happens to be running at the scheduled +time. `weekly(sunday)`, for example, does not mean "run Kometa on Sunday to do this thing"; it means "If Kometa is running, and it's Sunday, do this thing". The scheduling options are: @@ -26,7 +26,7 @@ The scheduling options are: | All | Requires that all comma separated scheduling options inside its brackets be meet in order to run | all[Options] | `all[weekly(sunday), hourly(17)]` | * `daily` is the default when `schedule` is not specified. -* You can run the script multiple times per day but using the `--time` command line argument detailed on the [Run Commands & Environmental Variables Page](../pmm/environmental.md). +* You can run Kometa multiple times per day but using the `--time` command line argument detailed on the [Run Commands & Environmental Variables Page](../kometa/environmental.md). * You can have multiple scheduling options as a list. * You can use the `delete_not_scheduled` setting to delete Collections that are skipped due to not being scheduled. @@ -49,10 +49,10 @@ The scheduling options are: schedule: weekly(sunday) collection_files: - file: config/Movies.yml - - pmm: imdb - - pmm: studio - - pmm: genre - - pmm: actor + - default: imdb + - default: studio + - default: genre + - default: actor operations: mass_critic_rating_update: tmdb ``` @@ -75,13 +75,13 @@ The scheduling options are: collection_files: - file: config/Movies.yml schedule: weekly(monday) - - pmm: imdb + - default: imdb schedule: weekly(tuesday) - folder: config/Movies/ schedule: weekly(wednesday) - - pmm: genre + - default: genre schedule: weekly(thursday) - - pmm: actor + - default: actor schedule: weekly(friday) metadata_files: - file: config/metadata.yml @@ -107,9 +107,9 @@ The scheduling options are: Movies: schedule_overlays: weekly(saturday) overlay_files: - - pmm: audio_codec - - pmm: resolution - - pmm: video_format + - default: audio_codec + - default: resolution + - default: video_format ``` ??? blank "Scheduling Individual Collections<a class="headerlink" href="#schedule-collection" title="Permanent link">¶</a>" @@ -120,7 +120,7 @@ The scheduling options are: ???+ example "Example" Below is an example of a collection which has been scheduled to run on a Sunday. In this scenario, if you run - PMM on a Monday, this collection will be skipped but any other collections which do not have a scheduled defined + Kometa on a Monday, this collection will be skipped but any other collections which do not have a scheduled defined will be run. ```yaml @@ -150,7 +150,7 @@ The scheduling options are: libraries: Movies: collection_files: - - pmm: imdb + - default: imdb operations: schedule: weekly(friday) mass_critic_rating_update: tmdb @@ -163,7 +163,7 @@ The scheduling options are: libraries: Movies: collection_files: - - pmm: imdb + - default: imdb operations: - schedule: weekly(friday) mass_critic_rating_update: tmdb @@ -180,7 +180,7 @@ The scheduling options are: ???+ example "Example" In this example, the collection will be pinned to your home screen for the month of December and on January 1st - will no longer be pinned (you must run PMM on 1st January for the removal of the pin to happen) + will no longer be pinned (you must run Kometa on 1st January for the removal of the pin to happen) ```yaml collections: diff --git a/docs/config/settings.md b/docs/config/settings.md index b8622159..02f53ca6 100644 --- a/docs/config/settings.md +++ b/docs/config/settings.md @@ -27,10 +27,10 @@ Attributes set at the collection level will take priority over any library or gl The available setting attributes which can be set at each level are outlined below: -??? blank "`cache` - Used to control PMM's cache database.<a class="headerlink" href="#cache" title="Permanent link">¶</a>" +??? blank "`cache` - Used to control Kometa's cache database.<a class="headerlink" href="#cache" title="Permanent link">¶</a>" - <div id="cache" />Allow Plex Meta Manager to create and maintain a local cache database for faster subsequent - processing. The cache file is created in the same directory as the configuration file. + <div id="cache" />Allow Kometa to create and maintain a local cache database for faster subsequent processing. The + cache file is created in the same directory as the configuration file. <hr style="margin: 0px;"> @@ -76,8 +76,8 @@ The available setting attributes which can be set at each level are outlined bel ???+ tip - Assets can be stored anywhere on the host system that PMM has visibility of (i.e. if using docker, the directory - must be mounted/visible to the docker container). + Assets can be stored anywhere on the host system that Kometa has visibility of (i.e. if using docker, the + directory must be mounted/visible to the docker container). <hr style="margin: 0px;"> @@ -105,7 +105,7 @@ The available setting attributes which can be set at each level are outlined bel ??? blank "`asset_folders` - Used to control the asset directory folder structure.<a class="headerlink" href="#asset-folders" title="Permanent link">¶</a>" - <div id="asset-folders" />While `true`, PMM will search the `asset_directory` for a dedicated folder per item vs + <div id="asset-folders" />While `true`, Kometa will search the `asset_directory` for a dedicated folder per item vs while false will look for an image. i.e. When `true` the example path would be `<asset_directory_path>/Star Wars/poster.png` instead of @@ -132,7 +132,7 @@ The available setting attributes which can be set at each level are outlined bel <div id="asset-depth" />Specify how many folder levels to scan for an item within the asset directory. - At each asset level, PMM will look for either `medianame.ext` [such as Star Wars.png] or a dedicated folder + At each asset level, Kometa will look for either `medianame.ext` [such as Star Wars.png] or a dedicated folder containing `poster.ext`. i.e. `<path_to_assets>/Star Wars/poster.png` and `<path_to_assets>/Star Wars.png` are both asset depth 0, whilst @@ -381,7 +381,7 @@ The available setting attributes which can be set at each level are outlined bel ??? blank "`default_collection_order` - Used to set the `collection_order` for every collection run.<a class="headerlink" href="#default-collection-order" title="Permanent link">¶</a>" - <div id="default-collection-order" />Set the `collection_order` for every collection run by PMM unless the + <div id="default-collection-order" />Set the `collection_order` for every collection run by Kometa unless the collection has a specific `collection_order`. ???+ tip @@ -515,8 +515,9 @@ The available setting attributes which can be set at each level are outlined bel ??? blank "`missing_only_released` - Used to filter unreleased items from missing lists.<a class="headerlink" href="#missing-only-released" title="Permanent link">¶</a>" - <div id="missing-only-released" />Whilst running a collection or playlist, when PMM handles missing items to either - report it to the user, report it to a file, or send it to Radarr/Sonarr all unreleased items will be filtered out. + <div id="missing-only-released" />Whilst running a collection or playlist, when Kometa handles missing items to + either report it to the user, report it to a file, or send it to Radarr/Sonarr all unreleased items will be + filtered out. <hr style="margin: 0px;"> @@ -535,9 +536,9 @@ The available setting attributes which can be set at each level are outlined bel missing_only_released: true ``` -??? blank "`show_unmanaged` - Used to show collections not managed by PMM.<a class="headerlink" href="#show-unmanaged" title="Permanent link">¶</a>" +??? blank "`show_unmanaged` - Used to show collections not managed by Kometa.<a class="headerlink" href="#show-unmanaged" title="Permanent link">¶</a>" - <div id="show-unmanaged" />List all collections not managed by Plex Meta Manager at the end of each run. + <div id="show-unmanaged" />List all collections not managed by Kometa at the end of each run. <hr style="margin: 0px;"> @@ -558,8 +559,7 @@ The available setting attributes which can be set at each level are outlined bel ??? blank "`show_unconfigured` - Used to show collections not in the current run.<a class="headerlink" href="#show-unconfigured" title="Permanent link">¶</a>" - <div id="show-unconfigured" />List all collections not configured in the current Plex Meta Manager run at the end of - each run. + <div id="show-unconfigured" />List all collections not configured in the current Kometa run at the end of each run. <hr style="margin: 0px;"> @@ -944,7 +944,7 @@ The available setting attributes which can be set at each level are outlined bel ???+ note Ensure you are using the raw GitHub link (i.e. - https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/meisnate12 ) + https://github.com/Kometa-Team/Community-Configs/tree/master/meisnate12) <hr style="margin: 0px;"> @@ -960,7 +960,7 @@ The available setting attributes which can be set at each level are outlined bel ```yaml settings: - custom_repo: https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/meisnate12 + custom_repo: https://github.com/Kometa-Team/Community-Configs/tree/master/meisnate12 ``` ??? blank "`verify_ssl` - Turn SSL Verification on or off.<a class="headerlink" href="#verify-ssl" title="Permanent link">¶</a>" diff --git a/docs/config/sonarr.md b/docs/config/sonarr.md index 6ca48552..3560273d 100644 --- a/docs/config/sonarr.md +++ b/docs/config/sonarr.md @@ -11,7 +11,7 @@ found missing while updating a library's collections. Sonarr V2 may work, but it is not supported please upgrade to V3 if you can. -Items in your List Exclusions will be ignored by PMM. +Items in your List Exclusions will be ignored by Kometa. A `sonarr` mapping can be either in the root of the config file as global mapping for all libraries, or you can specify the `sonarr` mapping individually per library. @@ -35,33 +35,33 @@ sonarr: language_profile: English series_type: standard season_folder: true - tag: pmm + tag: kometa search: false cutoff_search: false sonarr_path: /media plex_path: /share/CACHEDEV1_DATA/Multimedia ``` -| Attribute | Allowed Values | Default | Required | -|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:------------------------------------------:| -| `url` | Sonarr URL (Including URL Base if set).<br>**Example:** http://192.168.1.12:32788 | N/A | :fontawesome-solid-circle-check:{ .green } | -| `token` | Sonarr API Token. | N/A | :fontawesome-solid-circle-check:{ .green } | -| `add_missing` | Adds all missing shows found from all collections to Sonarr.<br>Use the `sonarr_add_missing` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to add missing per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | -| `add_existing` | Adds all existing shows in collections to Sonarr.<br>Use the `sonarr_add_existing` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to add existing per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | -| `upgrade_existing` | Upgrades all existing shows in collections to match the Quality Profile of the collection.<br>Use the `sonarr_upgrade_existing` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to upgrade the Quality Profile per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | -| `monitor_existing` | Ensures all existing shows in collections match your monitor setting.<br>Use the `sonarr_monitor_existing` [Sonarr Setting](../files/arr.md#sonarr-definition-settings) in the collection definition to match the monitor setting per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | -| `ignore_cache` | Ignores PMM's cache when adding items to Sonarr.<br>Use the `sonarr_ignore_cache` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to ignore per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | -| `root_folder_path` | Default Root Folder Path to use when adding new shows.<br>Use the `sonarr_folder` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to set the Root Folder per collection. | N/A | :fontawesome-solid-circle-check:{ .green } | -| `monitor` | Default Monitor to use when adding new shows.<br>Use the `sonarr_monitor` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to set the Monitor value per collection.<br>**Values:** <table class="clearTable"><tr><td>`all`</td><td>All episodes except specials</td></tr><tr><td>`future`</td><td>Episodes that have not aired yet</td></tr><tr><td>`missing`</td><td>Episodes that do not have files or have not aired yet</td></tr><tr><td>`existing`</td><td>Episodes that have files or have not aired yet</td></tr><tr><td>`pilot`</td><td>The first episode, all others will be ignored</td></tr><tr><td>`first`</td><td>All episodes of the first season, all others will be ignored</td></tr><tr><td>`latest`</td><td>All episodes of the latest season and future seasons</td></tr><tr><td>`none`</td><td>No episodes</td></tr></table> | `all` | :fontawesome-solid-circle-xmark:{ .red } | -| `quality_profile` | Default Quality Profile to use when adding new shows.<br>Use the `sonarr_quality` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to set the Quality Profile per collection. | N/A | :fontawesome-solid-circle-check:{ .green } | -| `language_profile` | Default Language Profile to use when adding new shows.<br>Use the `sonarr_language` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to set the Language Profile per collection. | First Profile | :fontawesome-solid-circle-xmark:{ .red } | -| `series_type` | Default Series Type to use when adding new shows.<br>Use the `sonarr_series` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to set the Series Type per collection.<br>**Values:** <table class="clearTable"><tr><td>`standard`</td><td>Episodes released with SxxEyy pattern</td></tr><tr><td>`daily`</td><td>Episodes released daily that use year-month-day pattern (2017-05-25)</td></tr><tr><td>`anime`</td><td>Episodes released using an absolute episode number</td></tr></table>`standard`: Episodes released with SxxEyy pattern<br>`daily`: Episodes released daily or less frequently that use year-month-day (2017-05-25)<br>`anime`: Episodes released using an absolute episode number | `standard` | :fontawesome-solid-circle-xmark:{ .red } | -| `season_folder` | Use the Season Folder Option when adding new shows.<br>Use the `sonarr_season` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to set the season folder value per collection. <br>**boolean:** true or false | true | :fontawesome-solid-circle-xmark:{ .red } | -| `tag` | Default list or comma-separated string of tags to use when adding new shows.<br>Use the `sonarr_tag` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to set the tags per collection. | ` ` | :fontawesome-solid-circle-xmark:{ .red } | -| `search` | Start search for missing episodes when adding new shows.<br>Use the `sonarr_search` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to set the search value per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | -| `cutoff_search` | Start search for cutoff unmet episodes when adding new shows.<br>Use the `sonarr_cutoff_search` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to set the cutoff search value per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | -| `plex_path` | When using `add_existing` or `sonarr_add_all` Convert this part of the path to `sonarr_path`. | ` ` | :fontawesome-solid-circle-xmark:{ .red } | -| `sonarr_path` | When using `add_existing` or `sonarr_add_all` Convert the `plex_path` part of the path to this. | ` ` | :fontawesome-solid-circle-xmark:{ .red } | +| Attribute | Allowed Values | Default | Required | +|:-------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:------------------------------------------:| +| `url` | Sonarr URL (Including URL Base if set).<br>**Example:** http://192.168.1.12:32788 | N/A | :fontawesome-solid-circle-check:{ .green } | +| `token` | Sonarr API Token. | N/A | :fontawesome-solid-circle-check:{ .green } | +| `add_missing` | Adds all missing shows found from all collections to Sonarr.<br>Use the `sonarr_add_missing` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to add missing per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | +| `add_existing` | Adds all existing shows in collections to Sonarr.<br>Use the `sonarr_add_existing` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to add existing per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | +| `upgrade_existing` | Upgrades all existing shows in collections to match the Quality Profile of the collection.<br>Use the `sonarr_upgrade_existing` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to upgrade the Quality Profile per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | +| `monitor_existing` | Ensures all existing shows in collections match your monitor setting.<br>Use the `sonarr_monitor_existing` [Sonarr Setting](../files/arr.md#sonarr-definition-settings) in the collection definition to match the monitor setting per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | +| `ignore_cache` | Ignores Kometa's cache when adding items to Sonarr.<br>Use the `sonarr_ignore_cache` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to ignore per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | +| `root_folder_path` | Default Root Folder Path to use when adding new shows.<br>Use the `sonarr_folder` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to set the Root Folder per collection. | N/A | :fontawesome-solid-circle-check:{ .green } | +| `monitor` | Default Monitor to use when adding new shows.<br>Use the `sonarr_monitor` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to set the Monitor value per collection.<br>**Values:** <table class="clearTable"><tr><td>`all`</td><td>All episodes except specials</td></tr><tr><td>`future`</td><td>Episodes that have not aired yet</td></tr><tr><td>`missing`</td><td>Episodes that do not have files or have not aired yet</td></tr><tr><td>`existing`</td><td>Episodes that have files or have not aired yet</td></tr><tr><td>`pilot`</td><td>The first episode, all others will be ignored</td></tr><tr><td>`first`</td><td>All episodes of the first season, all others will be ignored</td></tr><tr><td>`latest`</td><td>All episodes of the latest season and future seasons</td></tr><tr><td>`none`</td><td>No episodes</td></tr></table> | `all` | :fontawesome-solid-circle-xmark:{ .red } | +| `quality_profile` | Default Quality Profile to use when adding new shows.<br>Use the `sonarr_quality` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to set the Quality Profile per collection. | N/A | :fontawesome-solid-circle-check:{ .green } | +| `language_profile` | Default Language Profile to use when adding new shows.<br>Use the `sonarr_language` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to set the Language Profile per collection. | First Profile | :fontawesome-solid-circle-xmark:{ .red } | +| `series_type` | Default Series Type to use when adding new shows.<br>Use the `sonarr_series` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to set the Series Type per collection.<br>**Values:** <table class="clearTable"><tr><td>`standard`</td><td>Episodes released with SxxEyy pattern</td></tr><tr><td>`daily`</td><td>Episodes released daily that use year-month-day pattern (2017-05-25)</td></tr><tr><td>`anime`</td><td>Episodes released using an absolute episode number</td></tr></table>`standard`: Episodes released with SxxEyy pattern<br>`daily`: Episodes released daily or less frequently that use year-month-day (2017-05-25)<br>`anime`: Episodes released using an absolute episode number | `standard` | :fontawesome-solid-circle-xmark:{ .red } | +| `season_folder` | Use the Season Folder Option when adding new shows.<br>Use the `sonarr_season` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to set the season folder value per collection. <br>**boolean:** true or false | true | :fontawesome-solid-circle-xmark:{ .red } | +| `tag` | Default list or comma-separated string of tags to use when adding new shows.<br>Use the `sonarr_tag` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to set the tags per collection. | ` ` | :fontawesome-solid-circle-xmark:{ .red } | +| `search` | Start search for missing episodes when adding new shows.<br>Use the `sonarr_search` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to set the search value per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | +| `cutoff_search` | Start search for cutoff unmet episodes when adding new shows.<br>Use the `sonarr_cutoff_search` [Sonarr Settings](../files/arr.md#sonarr-definition-settings) in the collection definition to set the cutoff search value per collection.<br>**boolean:** true or false | false | :fontawesome-solid-circle-xmark:{ .red } | +| `plex_path` | When using `add_existing` or `sonarr_add_all` Convert this part of the path to `sonarr_path`. | ` ` | :fontawesome-solid-circle-xmark:{ .red } | +| `sonarr_path` | When using `add_existing` or `sonarr_add_all` Convert the `plex_path` part of the path to this. | ` ` | :fontawesome-solid-circle-xmark:{ .red } | ???+ tip diff --git a/docs/config/tmdb.md b/docs/config/tmdb.md index a3f7f0fc..8d4a515f 100644 --- a/docs/config/tmdb.md +++ b/docs/config/tmdb.md @@ -4,7 +4,7 @@ search: --- # TMDb Attributes -Configuring [TheMovieDb](https://www.themoviedb.org/) is required in order to run Plex Meta Manager. +Configuring [TheMovieDb](https://www.themoviedb.org/) is required in order to run Kometa. A `tmdb` mapping is in the root of the config file. diff --git a/docs/config/trakt.md b/docs/config/trakt.md index 80704bce..5f1d24fe 100644 --- a/docs/config/trakt.md +++ b/docs/config/trakt.md @@ -29,9 +29,9 @@ trakt: | `client_secret` | Trakt Application Client Secret | N/A | :fontawesome-solid-circle-check:{ .green } | | `pin` | Trakt Pin | None | :fontawesome-solid-circle-xmark:{ .red } | -* All other attributes will be filled in by Plex Meta Manager. +* All other attributes will be filled in by Kometa. -To connect to Trakt.tv you must create a Trakt application and supply Plex Meta Manager the `client_id`, +To connect to Trakt.tv you must create a Trakt application and supply Kometa the `client_id`, `client_secret`, and `pin` provided, please do the following: 1. [Click here to create a Trakt API application.](https://trakt.tv/oauth/applications/new) @@ -47,7 +47,7 @@ To connect to Trakt.tv you must create a Trakt application and supply Plex Meta ???+ warning - Run Plex Meta Manager shortly after obtaining your PIN; the PIN may expire at some point. + Run Kometa shortly after obtaining your PIN; the PIN may expire at some point. ## Online Authorization diff --git a/docs/config/webhooks.md b/docs/config/webhooks.md index 30a22820..98ab4a83 100644 --- a/docs/config/webhooks.md +++ b/docs/config/webhooks.md @@ -10,7 +10,7 @@ Below is a `webhooks` mapping example and the full set of attributes: ```yaml webhooks: - error: https://www.myspecialdomain.com/pmm + error: https://www.myspecialdomain.com/kometa version: run_start: run_end: diff --git a/docs/defaults/award/bafta.md b/docs/defaults/award/bafta.md index e57477af..44cb0da3 100644 --- a/docs/defaults/award/bafta.md +++ b/docs/defaults/award/bafta.md @@ -24,7 +24,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: bafta + - default: bafta ``` ## Template Variables @@ -37,9 +37,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -75,7 +75,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: bafta + - default: bafta template_variables: collection_mode: show_items #(1)! collection_order: alpha #(2)! diff --git a/docs/defaults/award/berlinale.md b/docs/defaults/award/berlinale.md index cf097d30..4cfcf1aa 100644 --- a/docs/defaults/award/berlinale.md +++ b/docs/defaults/award/berlinale.md @@ -23,7 +23,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: berlinale + - default: berlinale ``` ## Template Variables @@ -36,9 +36,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -74,7 +74,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: berlinale + - default: berlinale template_variables: collection_mode: show_items #(1)! collection_order: alpha #(2)! diff --git a/docs/defaults/award/cannes.md b/docs/defaults/award/cannes.md index 840ad361..afebaf2e 100644 --- a/docs/defaults/award/cannes.md +++ b/docs/defaults/award/cannes.md @@ -23,7 +23,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: cannes + - default: cannes ``` ## Template Variables @@ -36,9 +36,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -74,7 +74,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: cannes + - default: cannes template_variables: collection_mode: show_items #(1)! collection_order: alpha #(2)! diff --git a/docs/defaults/award/cesar.md b/docs/defaults/award/cesar.md index 51c31330..fa43095d 100644 --- a/docs/defaults/award/cesar.md +++ b/docs/defaults/award/cesar.md @@ -23,7 +23,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: cesar + - default: cesar ``` ## Template Variables @@ -36,9 +36,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -74,7 +74,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: cesar + - default: cesar template_variables: collection_mode: show_items #(1)! collection_order: alpha #(2)! diff --git a/docs/defaults/award/choice.md b/docs/defaults/award/choice.md index 570dc05f..565b4b96 100644 --- a/docs/defaults/award/choice.md +++ b/docs/defaults/award/choice.md @@ -23,10 +23,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: choice + - default: choice TV Shows: collection_files: - - pmm: choice + - default: choice ``` ## Template Variables @@ -37,9 +37,9 @@ Note that the `template_variables:` section only needs to be used if you do want ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -74,7 +74,7 @@ Note that the `template_variables:` section only needs to be used if you do want libraries: Movies: collection_files: - - pmm: choice + - default: choice template_variables: collection_mode: show_items #(1)! collection_order: alpha #(2)! diff --git a/docs/defaults/award/emmy.md b/docs/defaults/award/emmy.md index c27ee656..2352ee66 100644 --- a/docs/defaults/award/emmy.md +++ b/docs/defaults/award/emmy.md @@ -23,10 +23,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: emmy + - default: emmy TV Shows: collection_files: - - pmm: emmy + - default: emmy ``` ## Template Variables @@ -37,9 +37,9 @@ Note that the `template_variables:` section only needs to be used if you do want ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -74,7 +74,7 @@ Note that the `template_variables:` section only needs to be used if you do want libraries: Movies: collection_files: - - pmm: emmy + - default: emmy template_variables: collection_mode: show_items #(1)! collection_order: alpha #(2)! diff --git a/docs/defaults/award/golden.md b/docs/defaults/award/golden.md index f206b779..8faef596 100644 --- a/docs/defaults/award/golden.md +++ b/docs/defaults/award/golden.md @@ -27,10 +27,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: golden + - default: golden TV Shows: collection_files: - - pmm: golden + - default: golden ``` ## Template Variables @@ -43,9 +43,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -81,7 +81,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: golden + - default: golden template_variables: collection_mode: show_items #(1)! collection_order: alpha #(2)! diff --git a/docs/defaults/award/nfr.md b/docs/defaults/award/nfr.md index 3d84dbca..654dfcbf 100644 --- a/docs/defaults/award/nfr.md +++ b/docs/defaults/award/nfr.md @@ -23,7 +23,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: nfr + - default: nfr ``` ## Template Variables @@ -36,9 +36,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -74,7 +74,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: nfr + - default: nfr template_variables: collection_mode: show_items #(1)! collection_order: alpha #(2)! diff --git a/docs/defaults/award/oscars.md b/docs/defaults/award/oscars.md index e9c764ef..7ed38ba8 100644 --- a/docs/defaults/award/oscars.md +++ b/docs/defaults/award/oscars.md @@ -24,7 +24,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: oscars + - default: oscars ``` ## Template Variables @@ -37,9 +37,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -75,7 +75,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: oscars + - default: oscars template_variables: collection_mode: show_items #(1)! collection_order: alpha #(2)! diff --git a/docs/defaults/award/pca.md b/docs/defaults/award/pca.md index c23fa9ed..3b755957 100644 --- a/docs/defaults/award/pca.md +++ b/docs/defaults/award/pca.md @@ -23,7 +23,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: pca + - default: pca ``` ## Template Variables @@ -36,9 +36,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -74,7 +74,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: pca + - default: pca template_variables: collection_mode: show_items #(1)! collection_order: alpha #(2)! diff --git a/docs/defaults/award/razzie.md b/docs/defaults/award/razzie.md index 17474533..a2773de9 100644 --- a/docs/defaults/award/razzie.md +++ b/docs/defaults/award/razzie.md @@ -23,7 +23,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: razzie + - default: razzie ``` ## Template Variables @@ -36,9 +36,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -74,7 +74,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: razzie + - default: razzie template_variables: collection_mode: show_items #(1)! collection_order: alpha #(2)! diff --git a/docs/defaults/award/sag.md b/docs/defaults/award/sag.md index e1ada01e..e58e309d 100644 --- a/docs/defaults/award/sag.md +++ b/docs/defaults/award/sag.md @@ -23,7 +23,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: sag + - default: sag ``` ## Template Variables @@ -36,9 +36,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -74,7 +74,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: sag + - default: sag template_variables: collection_mode: show_items #(1)! collection_order: alpha #(2)! diff --git a/docs/defaults/award/separator.md b/docs/defaults/award/separator.md index 308d455b..978b02a3 100644 --- a/docs/defaults/award/separator.md +++ b/docs/defaults/award/separator.md @@ -22,10 +22,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: separator_award + - default: separator_award TV Shows: collection_files: - - pmm: separator_award + - default: separator_award ``` ## Template Variables @@ -57,7 +57,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: separator_award + - default: separator_award template_variables: sep_style: purple #(1)! ``` diff --git a/docs/defaults/award/spirit.md b/docs/defaults/award/spirit.md index 0b889b09..6cd01b09 100644 --- a/docs/defaults/award/spirit.md +++ b/docs/defaults/award/spirit.md @@ -23,7 +23,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: spirit + - default: spirit ``` ## Template Variables @@ -36,9 +36,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -74,7 +74,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: spirit + - default: spirit template_variables: collection_mode: show_items #(1)! collection_order: alpha #(2)! diff --git a/docs/defaults/award/sundance.md b/docs/defaults/award/sundance.md index 7b60bded..7351c106 100644 --- a/docs/defaults/award/sundance.md +++ b/docs/defaults/award/sundance.md @@ -23,7 +23,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: sundance + - default: sundance ``` ## Template Variables @@ -36,9 +36,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -74,7 +74,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: sundance + - default: sundance template_variables: collection_mode: show_items #(1)! collection_order: alpha #(2)! diff --git a/docs/defaults/award/tiff.md b/docs/defaults/award/tiff.md index 10999c8d..b80cbefd 100644 --- a/docs/defaults/award/tiff.md +++ b/docs/defaults/award/tiff.md @@ -24,7 +24,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: tiff + - default: tiff ``` ## Template Variables @@ -37,9 +37,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -75,7 +75,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: tiff + - default: tiff template_variables: collection_mode: show_items #(1)! collection_order: alpha #(2)! diff --git a/docs/defaults/award/venice.md b/docs/defaults/award/venice.md index e06274b4..048e94cb 100644 --- a/docs/defaults/award/venice.md +++ b/docs/defaults/award/venice.md @@ -23,7 +23,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: venice + - default: venice ``` ## Template Variables @@ -36,9 +36,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -74,7 +74,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: venice + - default: venice template_variables: collection_mode: show_items #(1)! collection_order: alpha #(2)! diff --git a/docs/defaults/both/actor.md b/docs/defaults/both/actor.md index e73c04b2..e83dafb9 100644 --- a/docs/defaults/both/actor.md +++ b/docs/defaults/both/actor.md @@ -26,10 +26,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: actor + - default: actor TV Shows: collection_files: - - pmm: actor + - default: actor ``` ## Template Variables @@ -42,9 +42,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -85,7 +85,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: actor + - default: actor template_variables: data: depth: 10 #(1)! diff --git a/docs/defaults/both/aspect.md b/docs/defaults/both/aspect.md index e8c695ca..9f889379 100644 --- a/docs/defaults/both/aspect.md +++ b/docs/defaults/both/aspect.md @@ -30,10 +30,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: aspect + - default: aspect TV Shows: collection_files: - - pmm: aspect + - default: aspect ``` ## Template Variables @@ -46,9 +46,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -92,7 +92,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: aspect + - default: aspect template_variables: use_1.65: false #(1)! sep_style: plum #(2)! diff --git a/docs/defaults/both/audio_language.md b/docs/defaults/both/audio_language.md index c11d7c1c..b444a523 100644 --- a/docs/defaults/both/audio_language.md +++ b/docs/defaults/both/audio_language.md @@ -25,10 +25,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: audio_language + - default: audio_language TV Shows: collection_files: - - pmm: audio_language + - default: audio_language ``` ## Template Variables @@ -41,9 +41,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -89,7 +89,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: audio_language + - default: audio_language template_variables: use_other: false #(1)! use_separator: false #(2)! diff --git a/docs/defaults/both/based.md b/docs/defaults/both/based.md index f7507119..ce8c1816 100644 --- a/docs/defaults/both/based.md +++ b/docs/defaults/both/based.md @@ -27,10 +27,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: based + - default: based TV Shows: collection_files: - - pmm: based + - default: based ``` ## Template Variables @@ -43,9 +43,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -89,7 +89,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: based + - default: based template_variables: sep_style: navy #(1)! use_comics: false #(2)! diff --git a/docs/defaults/both/collectionless.md b/docs/defaults/both/collectionless.md index 9b932cbe..effb02e6 100644 --- a/docs/defaults/both/collectionless.md +++ b/docs/defaults/both/collectionless.md @@ -35,12 +35,12 @@ libraries: template_variables: collection_mode: hide_items collection_files: - - pmm: collectionless + - default: collectionless TV Shows: template_variables: collection_mode: hide_items collection_files: - - pmm: collectionless + - default: collectionless ``` ## Template Variables @@ -53,7 +53,7 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. ???+ warning @@ -83,7 +83,7 @@ work. Any value not specified will use its default value if it has one if not it template_variables: collection_mode: hide_items collection_files: - - pmm: collectionless + - default: collectionless template_variables: exclude: - Marvel Cinematic Universe diff --git a/docs/defaults/both/content_rating_au.md b/docs/defaults/both/content_rating_au.md index 1b649877..84a75e80 100644 --- a/docs/defaults/both/content_rating_au.md +++ b/docs/defaults/both/content_rating_au.md @@ -30,10 +30,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: content_rating_au + - default: content_rating_au TV Shows: collection_files: - - pmm: content_rating_au + - default: content_rating_au ``` ## Template Variables @@ -46,9 +46,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -96,7 +96,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: content_rating_cs + - default: content_rating_cs template_variables: sep_style: stb #(1)! use_other: false #(2)! diff --git a/docs/defaults/both/content_rating_cs.md b/docs/defaults/both/content_rating_cs.md index 3fc288ac..2d57b662 100644 --- a/docs/defaults/both/content_rating_cs.md +++ b/docs/defaults/both/content_rating_cs.md @@ -32,10 +32,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: content_rating_cs + - default: content_rating_cs TV Shows: collection_files: - - pmm: content_rating_cs + - default: content_rating_cs ``` ## Template Variables @@ -48,9 +48,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -98,7 +98,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: content_rating_cs + - default: content_rating_cs template_variables: sep_style: blue #(1)! use_other: false #(2)! diff --git a/docs/defaults/both/content_rating_de.md b/docs/defaults/both/content_rating_de.md index 89b54211..bae7edb5 100644 --- a/docs/defaults/both/content_rating_de.md +++ b/docs/defaults/both/content_rating_de.md @@ -30,10 +30,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: content_rating_de + - default: content_rating_de TV Shows: collection_files: - - pmm: content_rating_de + - default: content_rating_de ``` ## Template Variables @@ -46,9 +46,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -96,7 +96,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: content_rating_cs + - default: content_rating_cs template_variables: sep_style: stb #(1)! use_other: false #(2)! diff --git a/docs/defaults/both/content_rating_mal.md b/docs/defaults/both/content_rating_mal.md index b5e8fe75..c3ac2253 100644 --- a/docs/defaults/both/content_rating_mal.md +++ b/docs/defaults/both/content_rating_mal.md @@ -32,10 +32,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: content_rating_mal + - default: content_rating_mal TV Shows: collection_files: - - pmm: content_rating_mal + - default: content_rating_mal ``` ## Template Variables @@ -54,9 +54,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -104,7 +104,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: content_rating_mal + - default: content_rating_mal template_variables: sep_style: tan #(1)! use_other: false #(2)! diff --git a/docs/defaults/both/content_rating_nz.md b/docs/defaults/both/content_rating_nz.md index 90ecddba..a0780ea3 100644 --- a/docs/defaults/both/content_rating_nz.md +++ b/docs/defaults/both/content_rating_nz.md @@ -30,10 +30,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: content_rating_nz + - default: content_rating_nz TV Shows: collection_files: - - pmm: content_rating_nz + - default: content_rating_nz ``` ## Template Variables @@ -46,9 +46,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -96,7 +96,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: content_rating_cs + - default: content_rating_cs template_variables: sep_style: stb #(1)! use_other: false #(2)! diff --git a/docs/defaults/both/content_rating_uk.md b/docs/defaults/both/content_rating_uk.md index b122dc34..d8bfdc1b 100644 --- a/docs/defaults/both/content_rating_uk.md +++ b/docs/defaults/both/content_rating_uk.md @@ -30,10 +30,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: content_rating_uk + - default: content_rating_uk TV Shows: collection_files: - - pmm: content_rating_uk + - default: content_rating_uk ``` ## Template Variables @@ -46,9 +46,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -96,7 +96,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: content_rating_cs + - default: content_rating_cs template_variables: sep_style: stb #(1)! use_other: false #(2)! diff --git a/docs/defaults/both/genre.md b/docs/defaults/both/genre.md index 3f74b3b3..2e14eb54 100644 --- a/docs/defaults/both/genre.md +++ b/docs/defaults/both/genre.md @@ -25,10 +25,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: genre + - default: genre TV Shows: collection_files: - - pmm: genre + - default: genre ``` ## Template Variables @@ -41,9 +41,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -88,7 +88,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: genre + - default: genre template_variables: sep_style: red #(1)! exclude: diff --git a/docs/defaults/both/resolution.md b/docs/defaults/both/resolution.md index 8f70262e..6c07f6e0 100644 --- a/docs/defaults/both/resolution.md +++ b/docs/defaults/both/resolution.md @@ -34,10 +34,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: resolution + - default: resolution TV Shows: collection_files: - - pmm: resolution + - default: resolution ``` ## Template Variables @@ -50,9 +50,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -101,7 +101,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: resolution + - default: resolution template_variables: sep_style: green #(1)! exclude: diff --git a/docs/defaults/both/streaming.md b/docs/defaults/both/streaming.md index 2d97da15..ad432118 100644 --- a/docs/defaults/both/streaming.md +++ b/docs/defaults/both/streaming.md @@ -13,7 +13,7 @@ Supported Library Types: Movie, Show !!! important - As of Plex Meta Manager release 1.21, the keys associated with this Defaults file has changed. + As of Kometa release 1.21, the keys associated with this Defaults file has changed. If you are setting custom images, you will need to use `<<originals_key>>` @@ -57,10 +57,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: streaming + - default: streaming TV Shows: collection_files: - - pmm: streaming + - default: streaming ``` ## Template Variables @@ -73,9 +73,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -121,7 +121,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: streaming + - default: streaming template_variables: region: FR #(1)! sep_style: amethyst #(2)! diff --git a/docs/defaults/both/studio.md b/docs/defaults/both/studio.md index 2eaed74c..0a74785d 100644 --- a/docs/defaults/both/studio.md +++ b/docs/defaults/both/studio.md @@ -27,10 +27,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: studio + - default: studio TV Shows: collection_files: - - pmm: studio + - default: studio ``` ## Template Variables @@ -43,9 +43,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -93,7 +93,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: studio + - default: studio template_variables: append_include: - Big Bull Productions #(1)! diff --git a/docs/defaults/both/subtitle_language.md b/docs/defaults/both/subtitle_language.md index b38bdac6..9d679183 100644 --- a/docs/defaults/both/subtitle_language.md +++ b/docs/defaults/both/subtitle_language.md @@ -25,10 +25,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: subtitle_language + - default: subtitle_language TV Shows: collection_files: - - pmm: subtitle_language + - default: subtitle_language ``` ## Template Variables @@ -41,9 +41,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -89,7 +89,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: subtitle_language + - default: subtitle_language template_variables: use_other: false #(1)! use_separator: false #(2)! diff --git a/docs/defaults/both/universe.md b/docs/defaults/both/universe.md index f6795afd..48ca3c66 100644 --- a/docs/defaults/both/universe.md +++ b/docs/defaults/both/universe.md @@ -38,10 +38,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: universe + - default: universe TV Shows: collection_files: - - pmm: universe + - default: universe ``` ## Template Variables @@ -54,9 +54,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -104,7 +104,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: universe + - default: universe template_variables: sep_style: salmon #(1)! collection_order: release #(2)! diff --git a/docs/defaults/both/year.md b/docs/defaults/both/year.md index 01117bc0..941cdc99 100644 --- a/docs/defaults/both/year.md +++ b/docs/defaults/both/year.md @@ -24,10 +24,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: year + - default: year TV Shows: collection_files: - - pmm: year + - default: year ``` ## Template Variables @@ -40,9 +40,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -83,7 +83,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: year + - default: year template_variables: sep_style: purple #(1)! sort_by: title.asc diff --git a/docs/defaults/chart/anilist.md b/docs/defaults/chart/anilist.md index e2dbb209..461a61e6 100644 --- a/docs/defaults/chart/anilist.md +++ b/docs/defaults/chart/anilist.md @@ -25,10 +25,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: anilist + - default: anilist TV Shows: collection_files: - - pmm: anilist + - default: anilist ``` ## Template Variables @@ -41,9 +41,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -75,7 +75,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: anilist + - default: anilist template_variables: use_season: false #(1)! order_top: 01 #(2)! diff --git a/docs/defaults/chart/basic.md b/docs/defaults/chart/basic.md index 6db91348..9ca89c8f 100644 --- a/docs/defaults/chart/basic.md +++ b/docs/defaults/chart/basic.md @@ -23,10 +23,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: basic + - default: basic TV Shows: collection_files: - - pmm: basic + - default: basic ``` ## Template Variables @@ -39,9 +39,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -72,7 +72,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: basic + - default: basic template_variables: in_the_last_episodes: 14 #(1)! visible_library_released: true #(2)! diff --git a/docs/defaults/chart/imdb.md b/docs/defaults/chart/imdb.md index f398515e..c9f82288 100644 --- a/docs/defaults/chart/imdb.md +++ b/docs/defaults/chart/imdb.md @@ -26,10 +26,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: imdb + - default: imdb TV Shows: collection_files: - - pmm: imdb + - default: imdb ``` ## Template Variables @@ -42,9 +42,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -74,7 +74,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: imdb + - default: imdb template_variables: use_lowest: false #(1)! visible_library_top: true #(2)! diff --git a/docs/defaults/chart/myanimelist.md b/docs/defaults/chart/myanimelist.md index 289a603f..ff416a30 100644 --- a/docs/defaults/chart/myanimelist.md +++ b/docs/defaults/chart/myanimelist.md @@ -26,10 +26,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: myanimelist + - default: myanimelist TV Shows: collection_files: - - pmm: myanimelist + - default: myanimelist ``` ## Template Variables @@ -42,9 +42,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -76,7 +76,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: myanimelist + - default: myanimelist template_variables: use_season: false #(1)! order_popular: 01 #(2)! diff --git a/docs/defaults/chart/other.md b/docs/defaults/chart/other.md index 49882802..c5c9b123 100644 --- a/docs/defaults/chart/other.md +++ b/docs/defaults/chart/other.md @@ -27,10 +27,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: other_chart + - default: other_chart TV Shows: collection_files: - - pmm: other_chart + - default: other_chart ``` ## Template Variables @@ -43,9 +43,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -76,7 +76,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: other_chart + - default: other_chart template_variables: use_anidb: false #(1)! visible_library_commonsense: true #(2)! diff --git a/docs/defaults/chart/separator.md b/docs/defaults/chart/separator.md index 3e4a2687..e6a5717c 100644 --- a/docs/defaults/chart/separator.md +++ b/docs/defaults/chart/separator.md @@ -22,10 +22,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: separator_chart + - default: separator_chart TV Shows: collection_files: - - pmm: separator_chart + - default: separator_chart ``` ## Template Variables @@ -57,7 +57,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: separator_chart + - default: separator_chart template_variables: sep_style: purple #(1)! ``` diff --git a/docs/defaults/chart/tautulli.md b/docs/defaults/chart/tautulli.md index 82faf3b7..27ef12bc 100644 --- a/docs/defaults/chart/tautulli.md +++ b/docs/defaults/chart/tautulli.md @@ -25,10 +25,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: tautulli + - default: tautulli TV Shows: collection_files: - - pmm: tautulli + - default: tautulli ``` ## Template Variables @@ -41,9 +41,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -76,7 +76,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: tautulli + - default: tautulli template_variables: use_watched: false #(1)! list_days_popular: 7 #(2)! diff --git a/docs/defaults/chart/tmdb.md b/docs/defaults/chart/tmdb.md index 4a263e53..6baba3b5 100644 --- a/docs/defaults/chart/tmdb.md +++ b/docs/defaults/chart/tmdb.md @@ -28,10 +28,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: tmdb + - default: tmdb TV Shows: collection_files: - - pmm: tmdb + - default: tmdb ``` ## Template Variables @@ -44,9 +44,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -78,7 +78,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: tmdb + - default: tmdb template_variables: use_trending: false #(1)! limit_popular: 20 #(2)! diff --git a/docs/defaults/chart/trakt.md b/docs/defaults/chart/trakt.md index b2bfb2ad..f2a4dc23 100644 --- a/docs/defaults/chart/trakt.md +++ b/docs/defaults/chart/trakt.md @@ -29,10 +29,10 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: trakt + - default: trakt TV Shows: collection_files: - - pmm: trakt + - default: trakt ``` ## Template Variables @@ -45,9 +45,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. === "File-Specific Template Variables" @@ -78,7 +78,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: trakt + - default: trakt template_variables: use_collected: false #(1)! use_recommended: false #(2)! diff --git a/docs/defaults/collections.md b/docs/defaults/collections.md index 135d3630..0347457b 100644 --- a/docs/defaults/collections.md +++ b/docs/defaults/collections.md @@ -1,8 +1,10 @@ # Collection Defaults -There are many Default Collection Files built into PMM itself which offer an easy-to-use and customizable set of Collections that the user can achieve without having to worry about creating the files that makes the collections possible. +There are many Default Collection Files built into Kometa itself which offer an easy-to-use and customizable set of +Collections that the user can achieve without having to worry about creating the files that makes the collections +possible. -This is the simplest way to create Collections using Plex Meta Manager. +This is the simplest way to create Collections using Kometa. {% include-markdown "./collection_list.md" @@ -11,21 +13,23 @@ This is the simplest way to create Collections using Plex Meta Manager. ## Configurations -To run a default pmm Metadata file you can simply add it to your `collection_files` using `pmm` like so: +To run a default Kometa Collection file you can simply add it to your `collection_files` using `default` like so: ```yaml libraries: Movies: collection_files: - - pmm: actor - - pmm: genre + - default: actor + - default: genre ``` ## Separators -Most Metadata files use separators to denote different sections of collection like actor collections vs studio collections. +Most Metadata files use separators to denote different sections of collection like actor collections vs studio +collections. -**Chart Separator and Award Separator each have their own file, while the other Separators are part of their respective files.** +**Chart Separator and Award Separator each have their own file, while the other Separators are part of their respective +files.** <details> <summary>Click to expand to see an example of Separators.</summary> @@ -44,17 +48,19 @@ libraries: template_variables: use_separator: false collection_files: - - pmm: actor - - pmm: genre + - default: actor + - default: genre ``` ## Collection Section Order -All Default Collection Files have a `collection_section` attribute. These attributes determine the order of the various sections and can be set by [customizing your config](#customizing-configs). +All Default Collection Files have a `collection_section` attribute. These attributes determine the order of the various +sections and can be set by [customizing your config](#customizing-configs). -For example: `collection_section: 01` translates to `sort_title: "!<<collection_section>><<pre>><<order_<<key>>>><<sort>>"` and so for `genre` if you have a `Fantasy` collection, plex is going to show `!06_Fantasy` +For example: `collection_section: 01` translates to `sort_title: "!<<collection_section>><<pre>><<order_<<key>>>><<sort>>"` +and so for `genre` if you have a `Fantasy` collection, plex is going to show `!06_Fantasy` -This is the default PMM collection ordering: +This is the default Kometa collection ordering: | Collection | Collection Section | |:---------------------|:-------------------| @@ -109,15 +115,18 @@ This is the default PMM collection ordering: ## Customizing Configs -Configs can be customized using the `template_variables` attribute when calling the file. These `template_variables` will be given to every template call in the file which allows them to affect how that file runs. +Configs can be customized using the `template_variables` attribute when calling the file. These `template_variables` +will be given to every template call in the file which allows them to affect how that file runs. -This example disables two keys, which will prevent those collections from being created. It also sets the visibility of one of the keys so that it is visible on the library tab, the server owner's homescreen and shared user's homescreens (assuming they server owner and/or the shared users have the library pinned to their homescreen) +This example disables two keys, which will prevent those collections from being created. It also sets the visibility of +one of the keys so that it is visible on the library tab, the server owner's homescreen and shared user's homescreens +(assuming they server owner and/or the shared users have the library pinned to their homescreen) ```yaml libraries: TV Shows: collection_files: - - pmm: imdb + - default: imdb template_variables: use_popular: false use_lowest: false @@ -126,19 +135,22 @@ libraries: visible_shared_top: true ``` -Each file has a page on the wiki showing the available `template_variables` for each file. For example the default `pmm: genre` has a page [here](both/genre.md). +Each file has a page on the wiki showing the available `template_variables` for each file. For example the default +`default: genre` has a page [here](both/genre.md). -**In addition to the defined `template_variables` almost all default Metadata files have access to the [Shared Variables](collection_variables.md).** +**In addition to the defined `template_variables` almost all default Metadata files have access to the +[Shared Variables](collection_variables.md).** ### Examples -For example if you want yearly oscar collections that go back 10 years instead of 5 all of which gets sent to radarr use the `data` and `radarr_add_missing` template variables. +For example if you want yearly oscar collections that go back 10 years instead of 5 all of which gets sent to radarr +use the `data` and `radarr_add_missing` template variables. ```yaml libraries: Movies: collection_files: - - pmm: oscars + - default: oscars template_variables: radarr_add_missing: true data: @@ -146,13 +158,13 @@ libraries: ending: latest ``` -Or maybe you want to change the number of actor collections made using pmm: actor. +Or maybe you want to change the number of actor collections made using default: actor. ```yaml libraries: Movies: overlay_files: - - pmm: actor + - default: actor template_variables: collection_mode: hide data: @@ -160,13 +172,13 @@ libraries: limit: 50 ``` -Or maybe you want to change the collection sort order of the genre collections using pmm: genre. +Or maybe you want to change the collection sort order of the genre collections using default: genre. ```yaml libraries: Movies: collection_files: - - pmm: genre + - default: genre template_variables: collection_section: 11 ``` @@ -188,11 +200,11 @@ Alternatively it can be turned off individually per git file: libraries: LIBRARYNAME: collection_files: - - pmm: <file1> # separator is disabled + - default: <file1> # separator is disabled template_variables: use_separator: false - - pmm: <file2> # separator is enabled by default - - pmm: <file3> # separator is disabled + - default: <file2> # separator is enabled by default + - default: <file3> # separator is disabled template_variables: use_separator: false ``` diff --git a/docs/defaults/example.md b/docs/defaults/example.md index 0902321d..0864c4fe 100644 --- a/docs/defaults/example.md +++ b/docs/defaults/example.md @@ -11,51 +11,51 @@ collection_mode: hide # hide the collections within the "library" tab in Plex. placeholder_imdb_id: tt8579674 # 1917 (2019) placeholder id for the separators, avoids a plex bug. collection_files: - - pmm: separator_award # An "index card" - - pmm: bafta # BAFTA Awards + - default: separator_award # An "index card" + - default: bafta # BAFTA Awards template_variables: # Show collections from latest-10 onwards. data: starting: latest-10 ending: latest - - pmm: golden # Golden Globes Awards + - default: golden # Golden Globes Awards template_variables: # Show collections from latest-10 onwards. data: starting: latest-10 ending: latest - - pmm: oscars # The Oscars + - default: oscars # The Oscars template_variables: # Show collections from latest-10 onwards. data: starting: latest-10 ending: latest - - pmm: separator_chart # An "index card" - - pmm: basic # Some basic chart collections - - pmm: tmdb # TMDb Charts (Popular, Trending, etc.) - - pmm: audio_language # English, French, Arabic, German, etc. audio language - - pmm: resolution # 4K HDR, 1080P FHD, etc. with the standards style + - default: separator_chart # An "index card" + - default: basic # Some basic chart collections + - default: tmdb # TMDb Charts (Popular, Trending, etc.) + - default: audio_language # English, French, Arabic, German, etc. audio language + - default: resolution # 4K HDR, 1080P FHD, etc. with the standards style template_variables: style: standards - - pmm: studio # DreamWorks Studios, Lucasfilm Ltd, etc. - - pmm: seasonal # Christmas, Halloween, etc. + - default: studio # DreamWorks Studios, Lucasfilm Ltd, etc. + - default: seasonal # Christmas, Halloween, etc. template_variables: # Disable any US-specific seasonal collections schedule_independence: never schedule_thanksgiving: never schedule_memorial: never schedule_labor: never - - pmm: streaming # Streaming on Disney+, Netflix, etc. + - default: streaming # Streaming on Disney+, Netflix, etc. template_variables: originals_only: true # Only create collections for Original Content (i.e. Netflix Originals) - - pmm: universe # Marvel Cinematic Universe, Wizarding World, etc. + - default: universe # Marvel Cinematic Universe, Wizarding World, etc. remove_overlays: false # Set to true if you want to remove overlays reapply_overlays: false # If you are doing a lot of testing and changes like me, keep this to true to always reapply overlays - can cause image bloat #reset_overlays: tmdb # if you want to reset the poster to default poster from tmdb - can cause image bloat overlay_files: - - pmm: audio_codec # FLAC, DTS-X, TrueHD, etc. style: standard/compact. compact is default - - pmm: resolution # 4K HDR, 1080P FHD, etc. - - pmm: ribbon # Used for ribbon in bottom right - - pmm: streaming # Streaming on Disney+, Netflix, etc. - - pmm: video_format # Remux, DVD, Blu-Ray, etc. in bottom left + - default: audio_codec # FLAC, DTS-X, TrueHD, etc. style: standard/compact. compact is default + - default: resolution # 4K HDR, 1080P FHD, etc. + - default: ribbon # Used for ribbon in bottom right + - default: streaming # Streaming on Disney+, Netflix, etc. + - default: video_format # Remux, DVD, Blu-Ray, etc. in bottom left settings: asset_directory: - config/assets @@ -71,59 +71,59 @@ collection_mode: hide # hide the collections within the "library" tab in Plex. placeholder_imdb_id: tt1190634 # The Boys (2019) placeholder id for the separators, avoids a plex bug. collection_files: - - pmm: separator_award # An "index card" - - pmm: bafta # BAFTA Awards + - default: separator_award # An "index card" + - default: bafta # BAFTA Awards template_variables: # Show collections from latest-10 onwards. data: starting: latest-10 ending: latest - - pmm: golden # Golden Globes Awards + - default: golden # Golden Globes Awards template_variables: # Show collections from latest-10 onwards. data: starting: latest-10 ending: latest - - pmm: oscars # The Oscars + - default: oscars # The Oscars template_variables: # Show collections from latest-10 onwards. data: starting: latest-10 ending: latest - - pmm: separator_chart # An "index card" - - pmm: basic # Some basic chart collections - - pmm: tmdb # TMDb Charts (Popular, Trending, etc.) - - pmm: audio_language # English, French, Arabic, German, etc. audio language - - pmm: resolution # 4K HDR, 1080P FHD, etc. with the standards style + - default: separator_chart # An "index card" + - default: basic # Some basic chart collections + - default: tmdb # TMDb Charts (Popular, Trending, etc.) + - default: audio_language # English, French, Arabic, German, etc. audio language + - default: resolution # 4K HDR, 1080P FHD, etc. with the standards style template_variables: style: standards - - pmm: network # ABC, CBC, NBC, FOX, etc. - - pmm: streaming # Streaming on Disney+, Netflix, etc. + - default: network # ABC, CBC, NBC, FOX, etc. + - default: streaming # Streaming on Disney+, Netflix, etc. template_variables: originals_only: true # Only create collections for Original Content (i.e. Netflix Originals) remove_overlays: false # Set to true if you want to remove overlays reapply_overlays: false # If you are doing a lot of testing and changes like me, keep this to true to always reapply overlays - can cause image bloat #reset_overlays: tmdb # if you want to reset the poster to default poster from tmdb - can cause image bloat overlay_files: - - pmm: audio_codec # FLAC, DTS-X, TrueHD, etc. on show and episode - - pmm: audio_codec + - default: audio_codec # FLAC, DTS-X, TrueHD, etc. on show and episode + - default: audio_codec template_variables: builder_level: episode - - pmm: episode_info # S##E## information in bottom right on episode + - default: episode_info # S##E## information in bottom right on episode template_variables: builder_level: episode - - pmm: resolution # 4K HDR, 1080P FHD, etc. on show, episode, and season - - pmm: resolution + - default: resolution # 4K HDR, 1080P FHD, etc. on show, episode, and season + - default: resolution template_variables: builder_level: episode - - pmm: resolution + - default: resolution template_variables: builder_level: season - - pmm: ribbon # Used for ribbon in bottom right on show - - pmm: status # Airing, Returning, Ended, Canceled on show - - pmm: versions # Will show duplicates for that media item on show and episode - - pmm: versions + - default: ribbon # Used for ribbon in bottom right on show + - default: status # Airing, Returning, Ended, Canceled on show + - default: versions # Will show duplicates for that media item on show and episode + - default: versions template_variables: builder_level: episode - - pmm: video_format # Remux, DVD, Blu-Ray, etc. in bottom left on show, episode, and season - - pmm: video_format + - default: video_format # Remux, DVD, Blu-Ray, etc. in bottom left on show, episode, and season + - default: video_format template_variables: builder_level: episode settings: @@ -134,7 +134,7 @@ split_duplicates: false assets_for_all: false playlist_files: - - pmm: playlist + - default: playlist template_variables: libraries: Movies, TV Shows # Must match the names of your libraries in Plex. ``` diff --git a/docs/defaults/guide.md b/docs/defaults/guide.md index a49642fc..28329108 100644 --- a/docs/defaults/guide.md +++ b/docs/defaults/guide.md @@ -1,12 +1,17 @@ # Defaults Usage Guide -Plex Meta Manager includes a pre-created set of Collection Files and Overlay Files which can be found in the "defaults" folder in the root of your Plex Meta Manager installation directory. +Kometa includes a pre-created set of Collection Files and Overlay Files which can be found in the "defaults" folder in +the root of your Kometa installation directory. -These files offer an easy-to-use and customizable set of Collections and Overlays that the user can achieve without having to worry about creating the files that make the collections and overlays possible. +These files offer an easy-to-use and customizable set of Collections and Overlays that the user can achieve without +having to worry about creating the files that make the collections and overlays possible. -All Collections come with a matching poster to make a clean, consistent set of collections in your library. These files are stored in the [Plex Meta Manager Images](https://github.com/meisnate12/Plex-Meta-Manager-Images) Repository and each poster is downloaded straight to your Plex Collection when you run Plex Meta Manager. +All Collections come with a matching poster to make a clean, consistent set of collections in your library. These files +are stored in the [Kometa Images](https://github.com/Kometa-Team/Default-Images) Repository and each poster is downloaded straight to your Plex Collection when +you run Kometa. -Credits to Sohjiro, Bullmoose20, Yozora, Cpt Kuesel, and anon_fawkes for helping drive this entire Default Set of Configs through the concept, design and implementation. +Credits to Sohjiro, Bullmoose20, Yozora, Cpt Kuesel, and anon_fawkes for helping drive this entire Default Set of +Configs through the concept, design and implementation. Special thanks to Magic815 for the overlay image inspiration and base template. @@ -22,24 +27,28 @@ See the [Overlay Defaults](overlays.md) Page for more information on the specifi ## Configurations -To run a default pmm Collection or Overlay file you can simply add it to your `collection_files` (For Collection Files) or `overlay_files` (For Overlay Files) using `pmm` like so: +To run a default KometCollection or Overlay file you can simply add it to your `collection_files` (For Collection Files) +or `overlay_files` (For Overlay Files) using `default` like so: ```yaml libraries: Movies: collection_files: - - pmm: actor - - pmm: genre + - default: actor + - default: genre overlay_files: - - pmm: ribbon - - pmm: ratings + - default: ribbon + - default: ratings ``` ## Customizing Configs -Configs can be customized using the `template_variables` attribute when calling the file. These `template_variables` will be given to every template call in the file which allows them to affect how that file runs. +Configs can be customized using the `template_variables` attribute when calling the file. These `template_variables` +will be given to every template call in the file which allows them to affect how that file runs. -For collections, this example disables two keys, which will prevent those collections from being created. It also sets the visibility of one of the keys so that it is visible on the library tab, the server owner's homescreen and shared user's homescreens (assuming they server owner and/or the shared users have the library pinned to their homescreen) +For collections, this example disables two keys, which will prevent those collections from being created. It also sets +the visibility of one of the keys so that it is visible on the library tab, the server owner's homescreen and shared +user's homescreens (assuming they server owner and/or the shared users have the library pinned to their homescreen) For overlays, this example changes the ratings overlay to apply to episodes rather than shows. @@ -47,7 +56,7 @@ For overlays, this example changes the ratings overlay to apply to episodes rath libraries: TV Shows: collection_files: - - pmm: imdb + - default: imdb template_variables: use_popular: false use_lowest: false @@ -55,14 +64,16 @@ libraries: visible_home_top: true visible_shared_top: true overlay_files: - - pmm: ratings + - default: ratings template_variables: builder_level: episode ``` -Each file has a page on the wiki showing the available `template_variables` for each file. For example the default `pmm: ratings` has a page [here](overlays/ratings.md). +Each file has a page on the wiki showing the available `template_variables` for each file. For example the default +`default: ratings` has a page [here](overlays/ratings.md). -**In addition to the defined `template_variables` almost all default Collection and Overlay files have access to their respective [Collection](collection_variables.md)/[Overlay](overlay_variables.md) Shared Variables.** +**In addition to the defined `template_variables` almost all default Collection and Overlay files have access to their +respective [Collection](collection_variables.md)/[Overlay](overlay_variables.md) Shared Variables.** {% include-markdown "./example.md" diff --git a/docs/defaults/movie/content_rating_us.md b/docs/defaults/movie/content_rating_us.md index d82fc9b8..8d81206b 100644 --- a/docs/defaults/movie/content_rating_us.md +++ b/docs/defaults/movie/content_rating_us.md @@ -32,7 +32,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: content_rating_us + - default: content_rating_us ``` ## Template Variables @@ -45,9 +45,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -95,7 +95,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: content_rating_us + - default: content_rating_us template_variables: sep_style: blue #(1)! use_other: false #(2)! diff --git a/docs/defaults/movie/continent.md b/docs/defaults/movie/continent.md index 4a07ef40..7822c367 100644 --- a/docs/defaults/movie/continent.md +++ b/docs/defaults/movie/continent.md @@ -27,7 +27,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: continent + - default: continent ``` ## Color Style @@ -46,9 +46,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -98,7 +98,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: continent + - default: continent template_variables: use_other: false #(1)! use_separator: false #(2)! diff --git a/docs/defaults/movie/country.md b/docs/defaults/movie/country.md index 96410279..498678c7 100644 --- a/docs/defaults/movie/country.md +++ b/docs/defaults/movie/country.md @@ -27,7 +27,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: country + - default: country ``` ## Color Style @@ -46,9 +46,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -98,7 +98,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: country + - default: country template_variables: use_other: false #(1)! use_separator: false #(2)! diff --git a/docs/defaults/movie/decade.md b/docs/defaults/movie/decade.md index 6c2cd8e8..1040b823 100644 --- a/docs/defaults/movie/decade.md +++ b/docs/defaults/movie/decade.md @@ -26,7 +26,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: decade + - default: decade ``` ## Template Variables @@ -39,9 +39,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -83,7 +83,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: year + - default: year template_variables: sep_style: purple #(1)! sort_by: title.asc diff --git a/docs/defaults/movie/director.md b/docs/defaults/movie/director.md index b7f967bc..1e8e6dae 100644 --- a/docs/defaults/movie/director.md +++ b/docs/defaults/movie/director.md @@ -26,7 +26,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: director + - default: director ``` ## Template Variables @@ -39,9 +39,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -88,7 +88,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: director + - default: director template_variables: data: depth: 10 #(1)! diff --git a/docs/defaults/movie/franchise.md b/docs/defaults/movie/franchise.md index 716957d2..8a22e828 100644 --- a/docs/defaults/movie/franchise.md +++ b/docs/defaults/movie/franchise.md @@ -29,7 +29,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: franchise + - default: franchise ``` ## Template Variables @@ -42,7 +42,7 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. ???+ warning @@ -93,7 +93,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: franchise + - default: franchise template_variables: build_collection: false #(1)! movie_105995: 336560 #(2)! diff --git a/docs/defaults/movie/producer.md b/docs/defaults/movie/producer.md index e02b6bea..5770abf0 100644 --- a/docs/defaults/movie/producer.md +++ b/docs/defaults/movie/producer.md @@ -26,7 +26,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: producer + - default: producer ``` ## Template Variables @@ -39,9 +39,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -88,7 +88,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: producer + - default: producer template_variables: data: depth: 15 #(1)! diff --git a/docs/defaults/movie/region.md b/docs/defaults/movie/region.md index e63b7077..dac5e63b 100644 --- a/docs/defaults/movie/region.md +++ b/docs/defaults/movie/region.md @@ -31,7 +31,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: region + - default: region ``` ## Color Style @@ -50,9 +50,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -102,7 +102,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: region + - default: region template_variables: use_other: false #(1)! use_separator: false #(2)! diff --git a/docs/defaults/movie/seasonal.md b/docs/defaults/movie/seasonal.md index f44ae3c4..5ec70669 100644 --- a/docs/defaults/movie/seasonal.md +++ b/docs/defaults/movie/seasonal.md @@ -41,7 +41,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: seasonal + - default: seasonal ``` ## Template Variables @@ -54,9 +54,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -113,7 +113,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: seasonal + - default: seasonal template_variables: use_independence: false #(1)! schedule_thanksgiving: range(10/01-10/30) #(2)! diff --git a/docs/defaults/movie/writer.md b/docs/defaults/movie/writer.md index fa24f453..31a1fafd 100644 --- a/docs/defaults/movie/writer.md +++ b/docs/defaults/movie/writer.md @@ -26,7 +26,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: collection_files: - - pmm: writer + - default: writer ``` ## Template Variables @@ -39,9 +39,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -88,7 +88,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: writer + - default: writer template_variables: data: depth: 10 #(1)! diff --git a/docs/defaults/overlays.md b/docs/defaults/overlays.md index 1f29d466..7fe9e6d8 100644 --- a/docs/defaults/overlays.md +++ b/docs/defaults/overlays.md @@ -1,8 +1,9 @@ # Overlay Defaults -There are many Default Overlay Files built into PMM itself which offer an easy-to-use and customizable set of Overlays that the user can achieve without having to worry about creating the files that makes the overlays possible. +There are many Default Overlay Files built into Kometa itself which offer an easy-to-use and customizable set of +Overlays that the user can achieve without having to worry about creating the files that makes the overlays possible. -This is the simplest way to create Overlays using Plex Meta Manager. +This is the simplest way to create Overlays using Kometa. {% include-markdown "./overlay_list.md" @@ -10,14 +11,14 @@ This is the simplest way to create Overlays using Plex Meta Manager. ## Configurations -To run a default pmm Overlay file you can simply add it to your `overlay_files` using `pmm` like so: +To run a default Kometa Overlay file you can simply add it to your `overlay_files` using `default` like so: ```yaml libraries: Movies: overlay_files: - - pmm: ribbon - - pmm: ratings + - default: ribbon + - default: ratings ``` ### Example Poster Overlays @@ -28,38 +29,38 @@ libraries: <details> <summary>Click to expand sample config.yml Movies overlays section:</summary> -**Note: This uses fonts not packaged with PMM. See [bullmoose20's Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/bullmoose20)** +**Note: This uses fonts not packaged with Kometa. See [bullmoose20's Configs](https://github.com/Kometa-Team/Community-Configs/tree/master/bullmoose20)** ```yaml libraries: Movies: remove_overlays: false overlay_files: - - pmm: resolution # 1, 4 - - pmm: audio_codec # 2 - - pmm: mediastinger # 3 - - pmm: ratings # 5, 6, 7 + - default: resolution # 1, 4 + - default: audio_codec # 2 + - default: mediastinger # 3 + - default: ratings # 5, 6, 7 template_variables: rating1: user # 5 as this is user and mass_user_rating_update: mdb_tomatoes rating1_image: rt_tomato # 5 as this is user and mass_user_rating_update: mdb_tomatoes - rating1_font: config/custom_fonts/Adlib.ttf # 5 local font accessible to PMM + rating1_font: config/custom_fonts/Adlib.ttf # 5 local font accessible to Kometa rating1_font_size: 63 # 5 adjusted font size to fit rating rating2: critic # 6 as this is critic and mass_critic_rating_update: imdb rating2_image: imdb # 6 as this is critic and mass_critic_rating_update: imdb - rating2_font: config/custom_fonts/Impact.ttf # 6 local font accessible to PMM + rating2_font: config/custom_fonts/Impact.ttf # 6 local font accessible to Kometa rating2_font_size: 70 # 6 adjusted font size to fit rating rating3: audience # 7 as this is audience and mass_audience_rating_update: tmdb rating3_image: tmdb # 7 as this is audience and mass_audience_rating_update: tmdb - rating3_font: config/custom_fonts/Avenir_95_Black.ttf # 7 local font accessible to PMM + rating3_font: config/custom_fonts/Avenir_95_Black.ttf # 7 local font accessible to Kometa rating3_font_size: 70 # 7 adjusted font size to fit rating horizontal_position: right # the set of ratings is on the right of the poster - - pmm: streaming # 8 - - pmm: video_format # 9 - - pmm: language_count # 10 - - pmm: ribbon # 11, 12 Bottom right sash is used by more than one overlay so a weight for priority can be applied + - default: streaming # 8 + - default: video_format # 9 + - default: language_count # 10 + - default: ribbon # 11, 12 Bottom right sash is used by more than one overlay so a weight for priority can be applied operations: mass_user_rating_update: mdb_tomatoes # 5 This operation will update the user rating in plex with Rotten Tomatoes ratings information gathered through mdblist.com (mdblist config required) mass_critic_rating_update: imdb # 6 This operation will update the critic rating in plex with IMDb ratings information @@ -73,37 +74,37 @@ libraries: <details> <summary>Click to expand sample config.yml TV Shows overlays section for the Show Poster:</summary> -**Note: This uses fonts not packaged with PMM. See [bullmoose20's Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/bullmoose20)** +**Note: This uses fonts not packaged with Kometa. See [bullmoose20's Configs](https://github.com/Kometa-Team/Community-Configs/tree/master/bullmoose20)** ```yaml libraries: TV Shows: remove_overlays: false overlay_files: - - pmm: resolution # 1 - - pmm: audio_codec # 2 - - pmm: mediastinger # 3 - - pmm: ratings # 4, 5, 6 + - default: resolution # 1 + - default: audio_codec # 2 + - default: mediastinger # 3 + - default: ratings # 4, 5, 6 template_variables: rating1: user # 4 as this is user and mass_user_rating_update: mdb_tomatoes rating1_image: rt_tomato # 4 as this is user and mass_user_rating_update: mdb_tomatoes - rating1_font: config/custom_fonts/Adlib.ttf # 4 local font accessible to PMM + rating1_font: config/custom_fonts/Adlib.ttf # 4 local font accessible to Kometa rating1_font_size: 63 # 4 adjusted font size to fit rating rating2: critic # 5 as this is critic and mass_critic_rating_update: imdb rating2_image: imdb # 5 as this is critic and mass_critic_rating_update: imdb - rating2_font: config/custom_fonts/Impact.ttf # 5 local font accessible to PMM + rating2_font: config/custom_fonts/Impact.ttf # 5 local font accessible to Kometa rating2_font_size: 70 # 5 adjusted font size to fit rating rating3: audience # 6 as this is audience and mass_audience_rating_update: tmdb rating3_image: tmdb # 6 as this is audience and mass_audience_rating_update: tmdb - rating3_font: config/custom_fonts/Avenir_95_Black.ttf # 6 local font accessible to PMM + rating3_font: config/custom_fonts/Avenir_95_Black.ttf # 6 local font accessible to Kometa rating3_font_size: 70 # 6 adjusted font size to fit rating horizontal_position: right # the set of ratings is on the right of the poster - - pmm: streaming # 7 - - pmm: video_format # 8 - - pmm: ribbon # 10, 11 Bottom right sash is used by more than one overlay so a weight for priority can be applied + - default: streaming # 7 + - default: video_format # 8 + - default: ribbon # 10, 11 Bottom right sash is used by more than one overlay so a weight for priority can be applied operations: mass_user_rating_update: mdb_tomatoes # 4 This operation will update the user rating in plex with Rotten Tomatoes ratings information gathered through mdblist.com (mdblist config required) mass_critic_rating_update: imdb # 5 This operation will update the critic rating in plex with IMDb ratings information @@ -122,13 +123,13 @@ libraries: TV Shows: remove_overlays: false overlay_files: - - pmm: resolution # 1 + - default: resolution # 1 template_variables: builder_level: season - - pmm: audio_codec # 2 + - default: audio_codec # 2 template_variables: builder_level: season - - pmm: video_format # 3 + - default: video_format # 3 template_variables: builder_level: season ``` @@ -140,41 +141,41 @@ libraries: <details> <summary>Click to expand sample config.yml TV Shows overlays section for the Episode Poster:</summary> -**Note: This uses fonts not packaged with PMM. See [bullmoose20's Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/bullmoose20)** +**Note: This uses fonts not packaged with Kometa. See [bullmoose20's Configs](https://github.com/Kometa-Team/Community-Configs/tree/master/bullmoose20)** ```yaml libraries: TV Shows: remove_overlays: false overlay_files: - - pmm: resolution # 1 + - default: resolution # 1 template_variables: builder_level: episode - - pmm: audio_codec # 2 + - default: audio_codec # 2 template_variables: builder_level: episode - - pmm: ratings # 3, 4 + - default: ratings # 3, 4 template_variables: rating1: critic # 3 as this is critic and mass_critic_rating_update: imdb rating1_image: imdb # 3 as this is critic and mass_critic_rating_update: imdb - rating1_font: config/custom_fonts/Impact.ttf # 3 local font accessible to PMM + rating1_font: config/custom_fonts/Impact.ttf # 3 local font accessible to Kometa rating1_font_size: 70 # 3 adjusted font size to fit rating rating2: audience # 4 as this is audience and mass_audience_rating_update: tmdb rating2_image: tmdb # 4 as this is audience and mass_audience_rating_update: tmdb - rating2_font: config/custom_fonts/Avenir_95_Black.ttf # 4 local font accessible to PMM + rating2_font: config/custom_fonts/Avenir_95_Black.ttf # 4 local font accessible to Kometa rating2_font_size: 70 # 4 adjusted font size to fit rating horizontal_position: right # the set of ratings is on the right of the poster builder_level: episode - - pmm: video_format # 5 + - default: video_format # 5 template_variables: builder_level: episode - - pmm: episode_info # 6 + - default: episode_info # 6 template_variables: builder_level: episode - - pmm: runtimes # 7 + - default: runtimes # 7 template_variables: builder_level: episode @@ -186,31 +187,40 @@ libraries: ## Rating Overlays -By default, for Movies in Plex, the `Ratings Source` dropdown (`#3`) below, can come from Rotten Tomatoes (and includes Critic Ratings and Audience Ratings) or IMDb (Audience Ratings). This only changes the tiny icons displayed and where Plex will retrieve the ratings from upon initial scan and import of the media metadata. +By default, for Movies in Plex, the `Ratings Source` dropdown (`#3`) below, can come from Rotten Tomatoes (and includes +Critic Ratings and Audience Ratings) or IMDb (Audience Ratings). This only changes the tiny icons displayed and where +Plex will retrieve the ratings from upon initial scan and import of the media metadata. -**Plex Meta Manager can insert up to three ratings of your choice into the three spots regardless of what you choose in the `Advanced` tab of that Plex library** +**Kometa can insert up to three ratings of your choice into the three spots regardless of what you choose in the +`Advanced` tab of that Plex library** ![](images/ratings_source.png) -Plex has three available spots in the Plex DB to store ratings and thus Plex Meta Manager can be used to insert ratings sources of your choice into those spots. They are known as the User Rating (`#1`), Critic Rating (`#2`), and Audience Rating (`#3`). +Plex has three available spots in the Plex DB to store ratings and thus Kometa can be used to insert ratings sources of +your choice into those spots. They are known as the User Rating (`#1`), Critic Rating (`#2`), and Audience Rating (`#3`). -**Note that the little icons cannot be changed and that the numbers next to the little icons are reflected in the poster ratings overlay** +**Note that the little icons cannot be changed and that the numbers next to the little icons are reflected in the poster +ratings overlay** ![](images/ratings_spot.png) -To be able to insert the ratings you want, Plex Meta Manager operations need to be defined. In this example below, User ratings (`#1`) are being filled with Rotten Tomatoes Critics Ratings. Critic ratings (`#2`) are filled with IMDb, and Audience ratings (`#3`) are filled with TMDb. +To be able to insert the ratings you want, Kometa operations need to be defined. In this example below, User ratings +(`#1`) are being filled with Rotten Tomatoes Critics Ratings. Critic ratings (`#2`) are filled with IMDb, and Audience +ratings (`#3`) are filled with TMDb. **mass_*_rating_update** sources can be found here: [operations](../config/operations.md) ![](images/ratings_operations.png) -Finally, to show the ratings on the poster, the following was added to the `overlay_files` section in the `config.yml` file to post Rotten Tomatoes Critics Ratings in (`#1`), IMDb ratings in (`#2`), and TMDb ratings in (`#3`) +Finally, to show the ratings on the poster, the following was added to the `overlay_files` section in the `config.yml` +file to post Rotten Tomatoes Critics Ratings in (`#1`), IMDb ratings in (`#2`), and TMDb ratings in (`#3`) ![](images/ratings_overlay_path.png) ## Customizing Configs -Configs can be customized using the `template_variables` attribute when calling the file. These `template_variables` will be given to every template call in the file which allows them to affect how that file runs. +Configs can be customized using the `template_variables` attribute when calling the file. These `template_variables` +will be given to every template call in the file which allows them to affect how that file runs. This example changes the ratings overlay to work on episodes. @@ -218,14 +228,16 @@ This example changes the ratings overlay to work on episodes. libraries: TV Shows: overlay_files: - - pmm: ratings + - default: ratings template_variables: builder_level: episode ``` -Each file has a page on the wiki showing the available `template_variables` for each file. For example the default `pmm: ratings` has a page [here](overlays/ratings.md). +Each file has a page on the wiki showing the available `template_variables` for each file. For example the default +`default: ratings` has a page [here](overlays/ratings.md). -**In addition to the defined `template_variables` almost all default Overlay files have access to the [Shared Variables](collection_variables.md).** +**In addition to the defined `template_variables` almost all default Overlay files have access to the +[Shared Variables](collection_variables.md).** ### Examples diff --git a/docs/defaults/overlays/aspect.md b/docs/defaults/overlays/aspect.md index 42a4b23b..2c2adc40 100644 --- a/docs/defaults/overlays/aspect.md +++ b/docs/defaults/overlays/aspect.md @@ -29,14 +29,14 @@ The below YAML in your config.yml will create the overlays: libraries: Movies: overlay_files: - - pmm: aspect + - default: aspect TV Shows: overlay_files: - - pmm: aspect - - pmm: aspect + - default: aspect + - default: aspect template_variables: builder_level: episode - - pmm: aspect + - default: aspect template_variables: builder_level: season ``` @@ -51,11 +51,11 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. - * **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults. + * **Overlay Text Template Variables** are additional variables shared across the Kometa Text Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -100,22 +100,22 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: overlay_files: - - pmm: aspect + - default: aspect template_variables: text_1.33: "4:9" text_1.77: "16:9" TV Shows: overlay_files: - - pmm: aspect + - default: aspect template_variables: text_1.33: "4:9" text_1.77: "16:9" - - pmm: aspect + - default: aspect template_variables: overlay_level: episode text_1.33: "4:9" text_1.77: "16:9" - - pmm: aspect + - default: aspect template_variables: overlay_level: season text_1.33: "4:9" diff --git a/docs/defaults/overlays/audio_codec.md b/docs/defaults/overlays/audio_codec.md index 6695568b..a4843e8f 100644 --- a/docs/defaults/overlays/audio_codec.md +++ b/docs/defaults/overlays/audio_codec.md @@ -46,14 +46,14 @@ The below YAML in your config.yml will create the overlays: libraries: Movies: overlay_files: - - pmm: audio_codec + - default: audio_codec TV Shows: overlay_files: - - pmm: audio_codec - - pmm: audio_codec + - default: audio_codec + - default: audio_codec template_variables: builder_level: season - - pmm: audio_codec + - default: audio_codec template_variables: builder_level: episode ``` @@ -68,9 +68,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -111,7 +111,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: overlay_files: - - pmm: audio_codec + - default: audio_codec template_variables: use_opus: false use_mp3: false diff --git a/docs/defaults/overlays/commonsense.md b/docs/defaults/overlays/commonsense.md index 22bf5506..e8af05f3 100644 --- a/docs/defaults/overlays/commonsense.md +++ b/docs/defaults/overlays/commonsense.md @@ -45,14 +45,14 @@ The below YAML in your config.yml will create the overlays: libraries: Movies: overlay_files: - - pmm: commonsense + - default: commonsense TV Shows: overlay_files: - - pmm: commonsense - - pmm: commonsense + - default: commonsense + - default: commonsense template_variables: builder_level: season - - pmm: commonsense + - default: commonsense template_variables: builder_level: episode ``` @@ -67,9 +67,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -110,7 +110,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: overlay_files: - - pmm: commonsense + - default: commonsense template_variables: pre_text: "CS" ``` diff --git a/docs/defaults/overlays/content_rating_au.md b/docs/defaults/overlays/content_rating_au.md index 8f429bde..48da79c2 100644 --- a/docs/defaults/overlays/content_rating_au.md +++ b/docs/defaults/overlays/content_rating_au.md @@ -33,14 +33,14 @@ The below YAML in your config.yml will create the overlays: libraries: Movies: overlay_files: - - pmm: content_rating_au + - default: content_rating_au TV Shows: overlay_files: - - pmm: content_rating_au - - pmm: content_rating_au + - default: content_rating_au + - default: content_rating_au template_variables: builder_level: season - - pmm: content_rating_au + - default: content_rating_au template_variables: builder_level: episode ``` @@ -55,9 +55,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -96,7 +96,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: overlay_files: - - pmm: content_rating_au + - default: content_rating_au template_variables: color: false ``` diff --git a/docs/defaults/overlays/content_rating_de.md b/docs/defaults/overlays/content_rating_de.md index c5c026c4..9f0a2c9c 100644 --- a/docs/defaults/overlays/content_rating_de.md +++ b/docs/defaults/overlays/content_rating_de.md @@ -33,14 +33,14 @@ The below YAML in your config.yml will create the overlays: libraries: Movies: overlay_files: - - pmm: content_rating_de + - default: content_rating_de TV Shows: overlay_files: - - pmm: content_rating_de - - pmm: content_rating_de + - default: content_rating_de + - default: content_rating_de template_variables: builder_level: season - - pmm: content_rating_de + - default: content_rating_de template_variables: builder_level: episode ``` @@ -55,9 +55,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -96,7 +96,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: overlay_files: - - pmm: content_rating_de + - default: content_rating_de template_variables: color: false ``` diff --git a/docs/defaults/overlays/content_rating_nz.md b/docs/defaults/overlays/content_rating_nz.md index 6c0e7f04..3d54f498 100644 --- a/docs/defaults/overlays/content_rating_nz.md +++ b/docs/defaults/overlays/content_rating_nz.md @@ -38,14 +38,14 @@ The below YAML in your config.yml will create the overlays: libraries: Movies: overlay_files: - - pmm: content_rating_nz + - default: content_rating_nz TV Shows: overlay_files: - - pmm: content_rating_nz - - pmm: content_rating_nz + - default: content_rating_nz + - default: content_rating_nz template_variables: builder_level: season - - pmm: content_rating_nz + - default: content_rating_nz template_variables: builder_level: episode ``` @@ -60,9 +60,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -101,7 +101,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: overlay_files: - - pmm: content_rating_nz + - default: content_rating_nz template_variables: color: false ``` diff --git a/docs/defaults/overlays/content_rating_uk.md b/docs/defaults/overlays/content_rating_uk.md index 2f871574..fbee7593 100644 --- a/docs/defaults/overlays/content_rating_uk.md +++ b/docs/defaults/overlays/content_rating_uk.md @@ -34,14 +34,14 @@ The below YAML in your config.yml will create the overlays: libraries: Movies: overlay_files: - - pmm: content_rating_uk + - default: content_rating_uk TV Shows: overlay_files: - - pmm: content_rating_uk - - pmm: content_rating_uk + - default: content_rating_uk + - default: content_rating_uk template_variables: builder_level: season - - pmm: content_rating_uk + - default: content_rating_uk template_variables: builder_level: episode ``` @@ -56,9 +56,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -97,7 +97,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: overlay_files: - - pmm: content_rating_uk + - default: content_rating_uk template_variables: color: false ``` diff --git a/docs/defaults/overlays/content_rating_us_movie.md b/docs/defaults/overlays/content_rating_us_movie.md index de9b61a1..01cb3418 100644 --- a/docs/defaults/overlays/content_rating_us_movie.md +++ b/docs/defaults/overlays/content_rating_us_movie.md @@ -32,7 +32,7 @@ The below YAML in your config.yml will create the overlays: libraries: Movies: overlay_files: - - pmm: content_rating_us_movie + - default: content_rating_us_movie ``` ## Template Variables @@ -45,9 +45,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -85,7 +85,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: overlay_files: - - pmm: content_rating_us_movie + - default: content_rating_us_movie template_variables: color: false ``` diff --git a/docs/defaults/overlays/content_rating_us_show.md b/docs/defaults/overlays/content_rating_us_show.md index 16e65abd..eed4d640 100644 --- a/docs/defaults/overlays/content_rating_us_show.md +++ b/docs/defaults/overlays/content_rating_us_show.md @@ -32,11 +32,11 @@ The below YAML in your config.yml will create the overlays: libraries: TV Shows: overlay_files: - - pmm: content_rating_us_show - - pmm: content_rating_us_show + - default: content_rating_us_show + - default: content_rating_us_show template_variables: builder_level: season - - pmm: content_rating_us_show + - default: content_rating_us_show template_variables: builder_level: episode ``` @@ -51,9 +51,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -91,14 +91,14 @@ work. Any value not specified will use its default value if it has one if not it libraries: TV Shows: overlay_files: - - pmm: content_rating_us_show + - default: content_rating_us_show template_variables: color: false - - pmm: content_rating_us_show + - default: content_rating_us_show template_variables: color: false builder_level: season - - pmm: content_rating_us_show + - default: content_rating_us_show template_variables: color: false builder_level: episode diff --git a/docs/defaults/overlays/direct_play.md b/docs/defaults/overlays/direct_play.md index 7350438e..85072921 100644 --- a/docs/defaults/overlays/direct_play.md +++ b/docs/defaults/overlays/direct_play.md @@ -17,10 +17,10 @@ The below YAML in your config.yml will create the overlays: libraries: Movies: overlay_files: - - pmm: direct_play + - default: direct_play TV Shows: overlay_files: - - pmm: direct_play + - default: direct_play ``` ## Template Variables @@ -33,11 +33,11 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. - * **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults. + * **Overlay Text Template Variables** are additional variables shared across the Kometa Text Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -78,7 +78,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: overlay_files: - - pmm: direct_play + - default: direct_play template_variables: builder_level: episode ``` diff --git a/docs/defaults/overlays/episode_info.md b/docs/defaults/overlays/episode_info.md index a6cd761e..9f0a612e 100644 --- a/docs/defaults/overlays/episode_info.md +++ b/docs/defaults/overlays/episode_info.md @@ -17,7 +17,7 @@ The below YAML in your config.yml will create the overlays: libraries: TV Shows: overlay_files: - - pmm: episode_info + - default: episode_info ``` ## Template Variables @@ -30,9 +30,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. - * **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults. + * **Overlay Text Template Variables** are additional variables shared across the Kometa Text Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -67,7 +67,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: TV Shows: overlay_files: - - pmm: episode_info + - default: episode_info template_variables: font_color: "#FFFFFF99" ``` diff --git a/docs/defaults/overlays/language_count.md b/docs/defaults/overlays/language_count.md index 252f9e22..7516fc5b 100644 --- a/docs/defaults/overlays/language_count.md +++ b/docs/defaults/overlays/language_count.md @@ -24,14 +24,14 @@ The below YAML in your config.yml will create the overlays: libraries: Movies: overlay_files: - - pmm: language_count + - default: language_count TV Shows: overlay_files: - - pmm: language_count - - pmm: language_count + - default: language_count + - default: language_count template_variables: builder_level: season - - pmm: language_count + - default: language_count template_variables: builder_level: episode ``` @@ -46,9 +46,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -89,7 +89,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: overlay_files: - - pmm: language_count + - default: language_count template_variables: use_subtitles: true ``` diff --git a/docs/defaults/overlays/languages.md b/docs/defaults/overlays/languages.md index 9f0125d8..183681dd 100644 --- a/docs/defaults/overlays/languages.md +++ b/docs/defaults/overlays/languages.md @@ -108,14 +108,14 @@ The below YAML in your config.yml will create the overlays: libraries: Movies: overlay_files: - - pmm: languages + - default: languages TV Shows: overlay_files: - - pmm: languages - - pmm: languages + - default: languages + - default: languages template_variables: builder_level: season - - pmm: languages + - default: languages template_variables: builder_level: episode ``` @@ -130,11 +130,11 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. - * **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults. + * **Overlay Text Template Variables** are additional variables shared across the Kometa Text Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -194,7 +194,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: overlay_files: - - pmm: languages + - default: languages template_variables: languages: - en diff --git a/docs/defaults/overlays/mediastinger.md b/docs/defaults/overlays/mediastinger.md index 9ee1db0c..5222ea81 100644 --- a/docs/defaults/overlays/mediastinger.md +++ b/docs/defaults/overlays/mediastinger.md @@ -17,7 +17,7 @@ The below YAML in your config.yml will create the overlays: libraries: Movies: overlay_files: - - pmm: mediastinger + - default: mediastinger ``` ## Template Variables @@ -30,7 +30,7 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -59,7 +59,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: overlay_files: - - pmm: mediastinger + - default: mediastinger template_variables: font_color: "#FFFFFF99" ``` diff --git a/docs/defaults/overlays/network.md b/docs/defaults/overlays/network.md index 4ed662ab..ffcf91c8 100644 --- a/docs/defaults/overlays/network.md +++ b/docs/defaults/overlays/network.md @@ -23,11 +23,11 @@ The below YAML in your config.yml will create the overlays: libraries: TV Shows: overlay_files: - - pmm: network - - pmm: network + - default: network + - default: network template_variables: builder_level: season - - pmm: network + - default: network template_variables: builder_level: episode ``` @@ -42,9 +42,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -79,15 +79,15 @@ work. Any value not specified will use its default value if it has one if not it libraries: TV Shows: overlay_files: - - pmm: network + - default: network template_variables: style: white vertical_offset: 390 - - pmm: network + - default: network template_variables: vertical_offset: 390 builder_level: season - - pmm: network + - default: network template_variables: vertical_offset: 390 builder_level: episode diff --git a/docs/defaults/overlays/ratings.md b/docs/defaults/overlays/ratings.md index 1e64f18d..b80643df 100644 --- a/docs/defaults/overlays/ratings.md +++ b/docs/defaults/overlays/ratings.md @@ -6,7 +6,7 @@ Rating in Plex for each item within your library. This file only updates the overlays based on the data in Plex, it will not pull the ratings directly from any third-party website, see recommendations below for more info. -**Please read [PMM Ratings Explained](../../pmm/guides/ratings.md) for more understanding on how PMM interacts with +**Please read [Kometa Ratings Explained](../../kometa/guides/ratings.md) for more understanding on how Kometa interacts with ratings.** ![](images/ratings_overlay.png) @@ -17,8 +17,9 @@ Supported Overlay Level: Movie, Show, Episode Requirements: Template Variables must be configured, otherwise this file will not apply any overlays. -Recommendations: Use the [Mass * Rating Update Library Operation](../../config/operations.md) and the [Mass Episode * -Rating Update Library Operation](../../config/operations.md) to update Plex to the Ratings you want on the Overlay. +Recommendations: Use the [Mass * Rating Update Library Operation](../../config/operations.md#mass-rating-update) and the +[Mass Episode * Rating Update Library Operation](../../config/operations.md#mass-episode-rating-update) to update Plex +to the Ratings you want on the Overlay. ## Config @@ -27,7 +28,7 @@ The below YAML in your config.yml will create the overlays: ```yaml Movies: overlay_files: - - pmm: ratings + - default: ratings template_variables: rating1: critic rating2: audience @@ -41,7 +42,7 @@ The below YAML in your config.yml will create the overlays: mass_user_rating_update: tmdb TV Shows: overlay_files: - - pmm: ratings + - default: ratings template_variables: rating1: critic rating2: audience @@ -49,7 +50,7 @@ The below YAML in your config.yml will create the overlays: rating1_image: imdb rating2_image: rt_popcorn rating3_image: tmdb - - pmm: ratings + - default: ratings template_variables: builder_level: episode rating1: critic @@ -74,11 +75,11 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. - * **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults. + * **Overlay Text Template Variables** are additional variables shared across the Kometa Text Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -159,13 +160,13 @@ work. Any value not specified will use its default value if it has one if not it ???+ warning - This example uses fonts not packaged with PMM. See [bullmoose20's - Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/bullmoose20) + This example uses fonts not packaged with Kometa. See [bullmoose20's + Configs](https://github.com/Kometa-Team/Community-Configs/tree/master/bullmoose20) ```yaml Movies: overlay_files: - - pmm: ratings + - default: ratings template_variables: rating1: critic rating1_image: imdb @@ -189,7 +190,7 @@ work. Any value not specified will use its default value if it has one if not it mass_user_rating_update: tmdb TV Shows: overlay_files: - - pmm: ratings + - default: ratings template_variables: rating1: critic rating1_image: imdb @@ -207,7 +208,7 @@ work. Any value not specified will use its default value if it has one if not it rating3_font_size: 70 horizontal_position: right - - pmm: ratings + - default: ratings template_variables: builder_level: episode diff --git a/docs/defaults/overlays/resolution.md b/docs/defaults/overlays/resolution.md index ea54e9d4..ba9c7027 100644 --- a/docs/defaults/overlays/resolution.md +++ b/docs/defaults/overlays/resolution.md @@ -82,7 +82,7 @@ the [TRaSH Guides](https://trash-guides.info/) filename naming scheme ## "Dovetail" versions -In the PMM log, you may see references to versions of these overlays with `-Dovetail` appended: +In the Kometa log, you may see references to versions of these overlays with `-Dovetail` appended: ``` | 4K-Plus-Dovetail Overlay in Movies | @@ -107,14 +107,14 @@ The below YAML in your config.yml will create the overlays: libraries: Movies: overlay_files: - - pmm: resolution + - default: resolution TV Shows: overlay_files: - - pmm: resolution - - pmm: resolution + - default: resolution + - default: resolution template_variables: builder_level: season - - pmm: resolution + - default: resolution template_variables: builder_level: episode ``` @@ -129,9 +129,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -172,7 +172,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: overlay_files: - - pmm: resolution + - default: resolution template_variables: use_dvhdrplus: false use_dv: false diff --git a/docs/defaults/overlays/ribbon.md b/docs/defaults/overlays/ribbon.md index 7555825f..38338bd7 100644 --- a/docs/defaults/overlays/ribbon.md +++ b/docs/defaults/overlays/ribbon.md @@ -40,10 +40,10 @@ The below YAML in your config.yml will create the overlays: libraries: Movies: overlay_files: - - pmm: ribbon + - default: ribbon TV Shows: overlay_files: - - pmm: ribbon + - default: ribbon ``` ## Template Variables @@ -56,9 +56,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -94,7 +94,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: overlay_files: - - pmm: ribbon + - default: ribbon template_variables: style: black weight_metacritic: 35 diff --git a/docs/defaults/overlays/runtimes.md b/docs/defaults/overlays/runtimes.md index fc1a7ae6..dcd6386a 100644 --- a/docs/defaults/overlays/runtimes.md +++ b/docs/defaults/overlays/runtimes.md @@ -17,11 +17,11 @@ The below YAML in your config.yml will create the overlays: libraries: Movies: overlay_files: - - pmm: runtimes + - default: runtimes TV Shows: overlay_files: - - pmm: runtimes - - pmm: runtimes + - default: runtimes + - default: runtimes template_variables: builder_level: episode ``` @@ -36,11 +36,11 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. - * **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults. + * **Overlay Text Template Variables** are additional variables shared across the Kometa Text Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -81,7 +81,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: TV Shows: overlay_files: - - pmm: runtimes + - default: runtimes template_variables: builder_level: episode font: fonts/Inter-Bold.ttf diff --git a/docs/defaults/overlays/status.md b/docs/defaults/overlays/status.md index fb634a3b..234835fb 100644 --- a/docs/defaults/overlays/status.md +++ b/docs/defaults/overlays/status.md @@ -26,7 +26,7 @@ The below YAML in your config.yml will create the overlays: libraries: TV Shows: overlay_files: - - pmm: status + - default: status ``` ## Template Variables @@ -39,11 +39,11 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. - * **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults. + * **Overlay Text Template Variables** are additional variables shared across the Kometa Text Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -89,7 +89,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: TV Shows: overlay_files: - - pmm: status + - default: status template_variables: text_canceled: "C A N C E L L E D" ``` diff --git a/docs/defaults/overlays/streaming.md b/docs/defaults/overlays/streaming.md index f20f2aa6..0d4c6076 100644 --- a/docs/defaults/overlays/streaming.md +++ b/docs/defaults/overlays/streaming.md @@ -14,7 +14,7 @@ Supported Overlay Level: Movie, Show !!! important - As of Plex Meta Manager release 1.21, the keys associated with this Defaults file has changed. + As of Kometa release 1.21, the keys associated with this Defaults file has changed. If you are setting custom images, you will need to use `<<originals_key>>` @@ -60,10 +60,10 @@ The below YAML in your config.yml will create the overlays: libraries: Movies: overlay_files: - - pmm: streaming + - default: streaming TV Shows: overlay_files: - - pmm: streaming + - default: streaming ``` ## Template Variables @@ -76,9 +76,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -118,7 +118,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: overlay_files: - - pmm: streaming + - default: streaming template_variables: originals_only: true use_peacock: false diff --git a/docs/defaults/overlays/studio.md b/docs/defaults/overlays/studio.md index 607e442a..069db649 100644 --- a/docs/defaults/overlays/studio.md +++ b/docs/defaults/overlays/studio.md @@ -23,10 +23,10 @@ The below YAML in your config.yml will create the overlays: libraries: Movies: overlay_files: - - pmm: studio + - default: studio TV Shows: overlay_files: - - pmm: studio + - default: studio ``` ## Template Variables @@ -39,9 +39,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -77,13 +77,13 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: overlay_files: - - pmm: studio + - default: studio template_variables: vertical_offset: 390 TV Shows: overlay_files: - - pmm: studio - - pmm: studio + - default: studio + - default: studio template_variables: builder_level: season vertical_align: bottom @@ -91,7 +91,7 @@ work. Any value not specified will use its default value if it has one if not it horizontal_align: left horizontal_offset: 15 style: bigger - - pmm: studio + - default: studio template_variables: builder_level: episode vertical_align: top diff --git a/docs/defaults/overlays/versions.md b/docs/defaults/overlays/versions.md index e248faa2..02e66e12 100644 --- a/docs/defaults/overlays/versions.md +++ b/docs/defaults/overlays/versions.md @@ -17,14 +17,14 @@ The below YAML in your config.yml will create the overlays: libraries: Movies: overlay_files: - - pmm: versions + - default: versions TV Shows: overlay_files: - - pmm: versions - - pmm: versions + - default: versions + - default: versions template_variables: builder_level: season - - pmm: versions + - default: versions template_variables: builder_level: episode ``` @@ -39,9 +39,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -76,7 +76,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: overlay_files: - - pmm: versions + - default: versions template_variables: back_color: "#FFFFFF99" ``` diff --git a/docs/defaults/overlays/video_format.md b/docs/defaults/overlays/video_format.md index 17bb3530..abc39a19 100644 --- a/docs/defaults/overlays/video_format.md +++ b/docs/defaults/overlays/video_format.md @@ -32,14 +32,14 @@ The below YAML in your config.yml will create the overlays: libraries: Movies: overlay_files: - - pmm: video_format + - default: video_format TV Shows: overlay_files: - - pmm: video_format - - pmm: video_format + - default: video_format + - default: video_format template_variables: builder_level: season - - pmm: video_format + - default: video_format template_variables: builder_level: episode ``` @@ -54,11 +54,11 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + * **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults. - * **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults. + * **Overlay Text Template Variables** are additional variables shared across the Kometa Text Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -105,7 +105,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: overlay_files: - - pmm: video_format + - default: video_format template_variables: text_bluray: BLURAY use_sdtv: false diff --git a/docs/defaults/playlist.md b/docs/defaults/playlist.md index 2693441d..417daf8d 100644 --- a/docs/defaults/playlist.md +++ b/docs/defaults/playlist.md @@ -31,7 +31,7 @@ The below YAML in your config.yml will create the collections: ```yaml playlist_files: - - pmm: playlist + - default: playlist ``` ## Template Variables @@ -44,7 +44,7 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. ???+ warning @@ -95,7 +95,7 @@ work. Any value not specified will use its default value if it has one if not it ```yaml playlist_files: - - pmm: playlist + - default: playlist template_variables: radarr_add_missing: true #(1)! ``` diff --git a/docs/defaults/separators.md b/docs/defaults/separators.md index 484b9cc3..3f6795bc 100644 --- a/docs/defaults/separators.md +++ b/docs/defaults/separators.md @@ -70,7 +70,7 @@ And at the file-level libraries: Movies: collection_files: - - pmm: studio + - default: studio template_variables: use_separator: false ``` @@ -125,7 +125,7 @@ And at the file-level libraries: Movies: collection_files: - - pmm: studio + - default: studio template_variables: sep_style: stb ``` diff --git a/docs/defaults/show/content_rating_us.md b/docs/defaults/show/content_rating_us.md index b385bd07..5fa1e9fa 100644 --- a/docs/defaults/show/content_rating_us.md +++ b/docs/defaults/show/content_rating_us.md @@ -30,7 +30,7 @@ The below YAML in your config.yml will create the collections: libraries: TV Shows: collection_files: - - pmm: content_rating_us + - default: content_rating_us ``` ## Template Variables @@ -43,9 +43,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -92,7 +92,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: content_rating_us + - default: content_rating_us template_variables: sep_style: blue #(1)! use_other: false #(2)! diff --git a/docs/defaults/show/continent.md b/docs/defaults/show/continent.md index f65b2eb3..b74ccb63 100644 --- a/docs/defaults/show/continent.md +++ b/docs/defaults/show/continent.md @@ -26,7 +26,7 @@ The below YAML in your config.yml will create the collections: libraries: TV Shows: collection_files: - - pmm: continent + - default: continent ``` ## Color Style @@ -45,7 +45,7 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. + The below template variables are available specifically for this Kometa Defaults file. Be sure to also check out the "Shared Template Variables" tab for additional variables. @@ -89,7 +89,7 @@ Note that the `template_variables:` section only needs to be used if you do want libraries: Movies: collection_files: - - pmm: continent + - default: continent template_variables: use_other: false #(1)! use_separator: false #(2)! diff --git a/docs/defaults/show/country.md b/docs/defaults/show/country.md index fef51ef5..eb68726a 100644 --- a/docs/defaults/show/country.md +++ b/docs/defaults/show/country.md @@ -26,7 +26,7 @@ The below YAML in your config.yml will create the collections: libraries: TV Shows: collection_files: - - pmm: country + - default: country ``` ## Color Style @@ -45,7 +45,7 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. + The below template variables are available specifically for this Kometa Defaults file. Be sure to also check out the "Shared Template Variables" tab for additional variables. @@ -89,7 +89,7 @@ Note that the `template_variables:` section only needs to be used if you do want libraries: Movies: collection_files: - - pmm: country + - default: country template_variables: use_other: false #(1)! use_separator: false #(2)! diff --git a/docs/defaults/show/decade.md b/docs/defaults/show/decade.md index 68b014f6..ed50b7c0 100644 --- a/docs/defaults/show/decade.md +++ b/docs/defaults/show/decade.md @@ -26,7 +26,7 @@ The below YAML in your config.yml will create the collections: libraries: TV Shows: collection_files: - - pmm: decade + - default: decade ``` ## Template Variables @@ -39,9 +39,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -83,7 +83,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: year + - default: year template_variables: sep_style: purple #(1)! sort_by: title.asc diff --git a/docs/defaults/show/franchise.md b/docs/defaults/show/franchise.md index bbc2f252..55cbcd36 100644 --- a/docs/defaults/show/franchise.md +++ b/docs/defaults/show/franchise.md @@ -29,7 +29,7 @@ The below YAML in your config.yml will create the collections: libraries: TV Shows: collection_files: - - pmm: franchise + - default: franchise ``` ## Template Variables @@ -42,7 +42,7 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. ???+ warning @@ -94,7 +94,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: TV Shows: collection_files: - - pmm: franchise + - default: franchise template_variables: append_data: "31917": Pretty Little Liars #(1)! diff --git a/docs/defaults/show/network.md b/docs/defaults/show/network.md index 38e61bd6..5033f012 100644 --- a/docs/defaults/show/network.md +++ b/docs/defaults/show/network.md @@ -35,7 +35,7 @@ The below YAML in your config.yml will create the collections: libraries: TV Shows: collection_files: - - pmm: network + - default: network ``` ## Template Variables @@ -48,9 +48,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -98,7 +98,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: network + - default: network template_variables: style: white append_exclude: diff --git a/docs/defaults/show/region.md b/docs/defaults/show/region.md index 58413868..6a462526 100644 --- a/docs/defaults/show/region.md +++ b/docs/defaults/show/region.md @@ -31,7 +31,7 @@ The below YAML in your config.yml will create the collections: libraries: TV Shows: collection_files: - - pmm: region + - default: region ``` ## Color Style @@ -50,9 +50,9 @@ work. Any value not specified will use its default value if it has one if not it ??? abstract "Variable Lists (click to expand)" - * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file. - * **Shared Template Variables** are additional variables shared across the PMM Defaults. + * **Shared Template Variables** are additional variables shared across the Kometa Defaults. * **Shared Separator Variables** are additional variables available since this Default contains a [Separator](../separators.md). @@ -103,7 +103,7 @@ work. Any value not specified will use its default value if it has one if not it libraries: Movies: collection_files: - - pmm: region + - default: region template_variables: use_other: false #(1)! use_separator: false #(2)! diff --git a/docs/files/arr.md b/docs/files/arr.md index 394ede87..61843132 100644 --- a/docs/files/arr.md +++ b/docs/files/arr.md @@ -49,8 +49,8 @@ default unless otherwise specified. ## Adding to Arr You can add items to Radarr/Sonarr in two different ways. - 1. Items found by PMM that are missing from your collections/playlists. - 2. Items found by PMM that already exist in Plex but are not in Radarr/Sonarr. + 1. Items found by Kometa that are missing from your collections/playlists. + 2. Items found by Kometa that already exist in Plex but are not in Radarr/Sonarr. ### Arr Add Missing diff --git a/docs/files/builders/imdb.md b/docs/files/builders/imdb.md index a715bcdd..06fb5445 100644 --- a/docs/files/builders/imdb.md +++ b/docs/files/builders/imdb.md @@ -148,7 +148,7 @@ Finds every item in an [IMDb Event](https://www.imdb.com/event/). ```yaml {% - include-markdown "https://raw.githubusercontent.com/meisnate12/PMM-IMDb-Awards/master/event_ids.yml" + include-markdown "https://raw.githubusercontent.com/Kometa-Team/IMDb-Awards/master/event_ids.yml" comments=false %} ``` diff --git a/docs/files/builders/mojo.md b/docs/files/builders/mojo.md index cdc9bf4f..1a077580 100644 --- a/docs/files/builders/mojo.md +++ b/docs/files/builders/mojo.md @@ -14,7 +14,7 @@ No configuration is required for these builders. **Builder Attribute:** `mojo_domestic` - **Builder Value:** [Dictionary](../../pmm/yaml.md#dictionaries) of Attributes + **Builder Value:** [Dictionary](../../kometa/yaml.md#dictionaries) of Attributes ??? blank "`range` - Determines the type of time range of the Box Office" @@ -106,7 +106,7 @@ No configuration is required for these builders. **Builder Attribute:** `mojo_international` - **Builder Value:** [Dictionary](../../pmm/yaml.md#dictionaries) of Attributes + **Builder Value:** [Dictionary](../../kometa/yaml.md#dictionaries) of Attributes ??? blank "`range` - Determines the type of time range of the Box Office" @@ -193,7 +193,7 @@ No configuration is required for these builders. **Builder Attribute:** `mojo_world` - **Builder Value:** [Dictionary](../../pmm/yaml.md#dictionaries) of Attributes + **Builder Value:** [Dictionary](../../kometa/yaml.md#dictionaries) of Attributes ??? blank "`year` - The year of the Worldwide Box Office" @@ -240,7 +240,7 @@ No configuration is required for these builders. **Builder Attribute:** `mojo_all_time` - **Builder Value:** [Dictionary](../../pmm/yaml.md#dictionaries) of Attributes + **Builder Value:** [Dictionary](../../kometa/yaml.md#dictionaries) of Attributes ??? blank "`chart` - Determines the chart you want to use" @@ -296,7 +296,7 @@ No configuration is required for these builders. **Builder Attribute:** `mojo_never` - **Builder Value:** [Dictionary](../../pmm/yaml.md#dictionaries) of Attributes + **Builder Value:** [Dictionary](../../kometa/yaml.md#dictionaries) of Attributes ??? blank "`chart` - Determines the chart you want to use" @@ -355,7 +355,7 @@ No configuration is required for these builders. **Builder Attribute:** `mojo_record` - **Builder Value:** [Dictionary](../../pmm/yaml.md#dictionaries) of Attributes + **Builder Value:** [Dictionary](../../kometa/yaml.md#dictionaries) of Attributes ??? blank "`chart` - Determines the record you want to use" diff --git a/docs/files/builders/overview.md b/docs/files/builders/overview.md index 3037c2b1..2c4148ad 100644 --- a/docs/files/builders/overview.md +++ b/docs/files/builders/overview.md @@ -6,21 +6,21 @@ Builders use third-party services to source items to be added to the collection. ![Smart Plex logo](../../../assets/icons/plex.png){ align=right } - **[Plex (Smart)](../smart)** builders create Smart Collections based on the metadata inside your Plex Server. Results are dynamic and will update as your library updates without the need to re-run PMM. + **[Plex (Smart)](../smart)** builders create Smart Collections based on the metadata inside your Plex Server. Results are dynamic and will update as your library updates without the need to re-run Kometa. [:octicons-home-16: View Builder](../smart){ .md-button .md-button--primary } [:octicons-alert-24:](""){ .card-link title="Cannot be used for Overlays unless utilizing Smart Labels" } ??? quicklink "Popular Builders" - - [:simple-plex: Smart Label](../smart/#smart-label) - Create a Smart Collection based on a specific label. The label can be generated by PMM based on criteria. + - [:simple-plex: Smart Label](../smart/#smart-label) - Create a Smart Collection based on a specific label. The label can be generated by Kometa based on criteria. - [:simple-plex: Smart Filter](../smart/#smart-filter) - Create a Smart Collection based on the filter parameters provided. !!! builder ![Dumb Plex logo](../../../assets/icons/plex_dumb.png){ align=right } - **[Plex (Dumb)](../smart)** builders grab items based on the metadata inside your Plex Server. Results are static and require PMM to re-run to update. + **[Plex (Dumb)](../smart)** builders grab items based on the metadata inside your Plex Server. Results are static and require Kometa to re-run to update. [:octicons-home-16: View Builder](../plex){ .md-button .md-button--primary } diff --git a/docs/files/builders/plex.md b/docs/files/builders/plex.md index e592ffa2..c74c7fd3 100644 --- a/docs/files/builders/plex.md +++ b/docs/files/builders/plex.md @@ -4,7 +4,7 @@ This builder finds its items by using the features of Plex. No configuration is required for these builders. -The results of these builders are static and require PMM to re-run in order to update. +The results of these builders are static and require Kometa to re-run in order to update. | Attribute | Description | Works with Movies | Works with Shows | Works with Playlists and Custom Sort | |:----------------------------------------------|:----------------------------------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:| @@ -68,20 +68,29 @@ collections: **This is not needed if you're using [Smart Label Collections](smart.md#smart-label).** -Finds every item that is not in a collection unless the collection is in the exclusion list. This is a special collection type to help keep your library looking correct. When items in your library are in multiple collections it can mess up how they're displayed in your library. +Finds every item that is not in a collection unless the collection is in the exclusion list. This is a special +collection type to help keep your library looking correct. When items in your library are in multiple collections it +can mess up how they're displayed in your library. -For Example, if you have a `Marvel Cinematic Universe` Collection set to `Show this collection and its items` and an `Iron Man` Collection set to `Hide items in this collection` what happens is the show overrides the hide, and you end up with both the collections and the 3 Iron Man movies all displaying. +For Example, if you have a `Marvel Cinematic Universe` Collection set to `Show this collection and its items` and an +`Iron Man` Collection set to `Hide items in this collection` what happens is the show overrides the hide, and you end +up with both the collections and the 3 Iron Man movies all displaying. -Alternatively, if you set the `Marvel Cinematic Universe` Collection to `Hide items in this collection` then movies without a collection like `The Incredible Hulk` will be hidden from the library view. +Alternatively, if you set the `Marvel Cinematic Universe` Collection to `Hide items in this collection` then movies +without a collection like `The Incredible Hulk` will be hidden from the library view. -To combat the problem above you set all collections to `Hide items in this collection` then create a collection set to `Hide collection` and put every movie that you still want to display in that collection. +To combat the problem above you set all collections to `Hide items in this collection` then create a collection set to +`Hide collection` and put every movie that you still want to display in that collection. -With the variability of collections generated by the Plex Meta Manager maintaining a collection like this becomes very difficult, so in order to automate it, you can use `plex_collectionless`. You just have to tell it what collections to exclude or what collection prefixes to exclude. +With the variability of collections generated by the Kometa maintaining a collection like this becomes very difficult, +so in order to automate it, you can use `plex_collectionless`. You just have to tell it what collections to exclude or +what collection prefixes to exclude. There are two attributes for `plex_collectionless`: * `exclude`: Exclude these Collections from being considered for collectionless. -* `exclude_prefix` Exclude Collections whose title or sort title starts with a prefix from being considered for collectionless. +* `exclude_prefix` Exclude Collections whose title or sort title starts with a prefix from being considered for +collectionless. **At least one exclusion is required.** @@ -101,19 +110,27 @@ collections: ``` * Both `exclude` and `exclude_prefix` can take multiple values as a List. -* This is a known issue with Plex Collection and there is a [Feature Suggestion](https://forums.plex.tv/t/collection-display-issue/305406) detailing the issue more on their forms. +* This is a known issue with Plex Collection and there is a [Feature Suggestion](https://forums.plex.tv/t/collection-display-issue/305406) detailing the issue more on their +forms. ## Plex Search Uses Plex's [Advanced Filters](https://support.plex.tv/articles/201273953-collections/) to find all items based on the search parameters provided. -Any Advanced Filter made using the Plex UI should be able to be recreated using `plex_search`. If you're having trouble getting `plex_search` to work correctly, build the collection you want inside of Plex's Advanced Filters and take a screenshot of the parameters in the Plex UI and post it in either the [Discussions](https://github.com/meisnate12/Plex-Meta-Manager/discussions) or on [Discord](https://metamanager.wiki/en/latest/discord/), and I'll do my best to help you. +Any Advanced Filter made using the Plex UI should be able to be recreated using `plex_search`. If you're having trouble +getting `plex_search` to work correctly, build the collection you want inside of Plex's Advanced Filters and take a +screenshot of the parameters in the Plex UI and post it in either the +[Discussions](https://github.com/Kometa-Team/Kometa/discussions) or on [Discord](https://kometa.wiki/en/latest/discord/), +and I'll do my best to help you. -like Plex's [Advanced Filters](https://support.plex.tv/articles/201273953-collections/) you have to start each search with either `any` or `all` as a base. You can only have one base attribute and all search attributes must be under the base. +like Plex's [Advanced Filters](https://support.plex.tv/articles/201273953-collections/) you have to start each search with either `any` or `all` as a base. You can only +have one base attribute and all search attributes must be under the base. -Inside the base attribute you can use any search below or nest more `any` or `all`. You can have as many nested `any` or `all` next to each other as you want. If using multiple `any` or `all` you will have to do so in the form of a list. +Inside the base attribute you can use any search below or nest more `any` or `all`. You can have as many nested `any` +or `all` next to each other as you want. If using multiple `any` or `all` you will have to do so in the form of a list. -**Note: To search by `season`, `episode`, `album`, or `track` you must use the `builder_level` [Setting](../settings.md) to change the type of items the collection holds.** +**Note: To search by `season`, `episode`, `album`, or `track` you must use the `builder_level` [Setting](../settings.md) to change +the type of items the collection holds.** There are a couple other attributes you can have at the top level only along with the base attribute are: @@ -199,7 +216,8 @@ String search can take multiple values **only as a list**. ## Tag Searches -Tag searches can be used with either no modifier or with `.not` except for `decade` and `resolution` which can only be used with no modifier. +Tag searches can be used with either no modifier or with `.not` except for `decade` and `resolution` which can only be +used with no modifier. Tag search can take multiple values as a **list or a comma-separated string**. @@ -254,7 +272,8 @@ Tag search can take multiple values as a **list or a comma-separated string**. | `track_source` | Uses the Track's Source attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | | `track_label` | Uses the Track's Label attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -<sup>1</sup> You can use `current_year` to have PMM use the current years value. This can be combined with a `-#` at the end to subtract that number of years. i.e. `current_year-2` +<sup>1</sup> You can use `current_year` to have Kometa use the current years value. This can be combined with a +`-#` at the end to subtract that number of years. i.e. `current_year-2` ## Date Searches @@ -334,7 +353,8 @@ No number search can take multiple values. | `album_critic_rating` | Uses the Album's critic rating attribute to match<br>**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | | `track_user_rating` | Uses the Track's user rating attribute to match<br>**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -<sup>1</sup> You can use `current_year` to have PMM use the current years value. This can be combined with a `-#` at the end to subtract that number of years. i.e. `current_year-2` +<sup>1</sup> You can use `current_year` to have Kometa use the current years value. This can be combined with a +`-#` at the end to subtract that number of years. i.e. `current_year-2` ## Boolean Searches @@ -440,7 +460,8 @@ Here's an example of an episode collection using `plex_search`. summary: A collection of the highest rated simpsons episodes. ``` -If you specify TMDb Person ID's using the Setting `tmdb_person` and then tell either `actor`, `director`, `producer`, or `writer` to add `tmdb`, the script will translate the TMDb Person IDs into their names and run the search on those names. +If you specify TMDb Person ID's using the Setting `tmdb_person` and then tell either `actor`, `director`, `producer`, or +`writer` to add `tmdb`, the script will translate the TMDb Person IDs into their names and run the search on those names. ```yaml collections: diff --git a/docs/files/builders/smart.md b/docs/files/builders/smart.md index 1ff912e6..dab6efd4 100644 --- a/docs/files/builders/smart.md +++ b/docs/files/builders/smart.md @@ -1,8 +1,9 @@ # Smart Builders -Smart Builders allow Plex Meta Manager to create Smart Collections in two different ways. +Smart Builders allow Kometa to create Smart Collections in two different ways. -The results of these builders are dynamic and do not require PMM to re-run in order to update, instead they will update automatically as the data within your Plex Library updates (i.e. if new media is added) +The results of these builders are dynamic and do not require Kometa to re-run in order to update, instead they will +update automatically as the data within your Plex Library updates (i.e. if new media is added) ???+ note @@ -10,11 +11,14 @@ The results of these builders are dynamic and do not require PMM to re-run in or ## Smart Label -A Smart Label Collection is a smart collection that grabs every item with a specific label generated by the program. That label is added to all the items the Collection Builders find instead of being added to a normal collection. +A Smart Label Collection is a smart collection that grabs every item with a specific label generated by the program. +That label is added to all the items the Collection Builders find instead of being added to a normal collection. -To make a collection a Smart Label Collection, the `smart_label` attribute must be added to the collection definition. It functions in two different ways: +To make a collection a Smart Label Collection, the `smart_label` attribute must be added to the collection definition. +It functions in two different ways: -1. Define the sort using the Movies/Shows column of the [Sorts Table](#sort-options) below along with any other builder to make that collection a Smart Label Collection. +1. Define the sort using the Movies/Shows column of the [Sorts Table](#sort-options) below along with any other builder +to make that collection a Smart Label Collection. ```yaml collections: Marvel Cinematic Universe: @@ -22,7 +26,8 @@ To make a collection a Smart Label Collection, the `smart_label` attribute must smart_label: release.desc ``` -2. Provide a whole `smart_filter` to determine exactly how the smart collection should be built, ensuring to include `label: <<smart_label>>`, which will link it to the collection labels. +2. Provide a whole `smart_filter` to determine exactly how the smart collection should be built, ensuring to include +`label: <<smart_label>>`, which will link it to the collection labels. ```yaml collections: Unplayed Marvel Cinematic Universe: @@ -34,23 +39,35 @@ To make a collection a Smart Label Collection, the `smart_label` attribute must unplayed: true ``` -This is extremely useful because smart collections don't follow normal show/hide rules and can eliminate the need to have [Plex Collectionless](plex.md#plex-collectionless) when used correctly. To fix the issue described in [Plex Collectionless](plex.md#plex-collectionless) you would make `Marvel Cinematic Universe` a Smart Label Collection and all other Marvel collection just normal collections, and they will show/hide all the movie properly. +This is extremely useful because smart collections don't follow normal show/hide rules and can eliminate the need to +have [Plex Collectionless](plex.md#plex-collectionless) when used correctly. To fix the issue described in +[Plex Collectionless](plex.md#plex-collectionless) you would make `Marvel Cinematic Universe` a Smart Label Collection +and all other Marvel collection just normal collections, and they will show/hide all the movie properly. -To have the Smart Label Collections to eliminate Plex Collectionless you have to go all in on using them. A good rule of thumb to make sure this works correctly is that every item in your library should have a max of one non-smart collection. +To have the Smart Label Collections to eliminate Plex Collectionless you have to go all in on using them. A good rule of +thumb to make sure this works correctly is that every item in your library should have a max of one non-smart collection. -Reach out on the [Plex Meta Manager Discord](https://metamanager.wiki/en/latest/discord/) or in the [GitHub Discussions](https://github.com/meisnate12/Plex-Meta-Manager/discussions) for help if you're having any issues getting this to work properly. +Reach out on the [Kometa Discord](https://kometa.wiki/en/latest/discord/) or in the [GitHub Discussions](https://github.com/Kometa-Team/Kometa/discussions) for help if you're having any issues getting +this to work properly. ## Smart Filter Uses Plex's [Advanced Filters](https://support.plex.tv/articles/201273953-collections/) to create a smart collection based on the filter parameters provided. -Any Advanced Filter made using the Plex UI should be able to be recreated using `smart_filter`. If you're having trouble getting `smart_filter` to work correctly, build the collection you want inside of Plex's Advanced Filters and take a screenshot of the parameters in the Plex UI and post it in either the [Discussions](https://github.com/meisnate12/Plex-Meta-Manager/discussions) or on [Discord](https://metamanager.wiki/en/latest/discord/), and I'll do my best to help you. +Any Advanced Filter made using the Plex UI should be able to be recreated using `smart_filter`. If you're having trouble +getting `smart_filter` to work correctly, build the collection you want inside of Plex's Advanced Filters and take a +screenshot of the parameters in the Plex UI and post it in either the +[Discussions](https://github.com/Kometa-Team/Kometa/discussions) or on [Discord](https://kometa.wiki/en/latest/discord/), +and I'll do my best to help you. -like Plex's [Advanced Filters](https://support.plex.tv/articles/201273953-collections/) you have to start each filter with either `any` or `all` as a base. You can only have one base attribute and all filter attributes must be under the base. +like Plex's [Advanced Filters](https://support.plex.tv/articles/201273953-collections/) you have to start each filter with either `any` or `all` as a base. You can only +have one base attribute and all filter attributes must be under the base. -Inside the base attribute you can use any filter below or nest more `any` or `all`. You can have as many nested `any` or `all` next to each other as you want. If using multiple `any` or `all` you will have to do so in the form of a list. +Inside the base attribute you can use any filter below or nest more `any` or `all`. You can have as many nested `any` +or `all` next to each other as you want. If using multiple `any` or `all` you will have to do so in the form of a list. -**Note: To search by `season`, `episode`, `album`, or `track` you must use the `builder_level` [Setting](../settings.md) to change the type of items the collection holds.** +**Note: To search by `season`, `episode`, `album`, or `track` you must use the `builder_level` [Setting](../settings.md) +to change the type of items the collection holds.** There are a couple other attributes you can have at the top level only along with the base attribute are: @@ -135,7 +152,8 @@ String filter can take multiple values **only as a list**. ## Tag Filters -Tag filters can be used with either no modifier or with `.not` except for `decade` and `resolution` which can only be used with no modifier. +Tag filters can be used with either no modifier or with `.not` except for `decade` and `resolution` which can only be +used with no modifier. Tag filter can take multiple values as a **list or a comma-separated string**. @@ -189,7 +207,8 @@ Tag filter can take multiple values as a **list or a comma-separated string**. | `track_source` | Uses the Track's Source attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | | `track_label` | Uses the Track's Label attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -<sup>1</sup> You can use `current_year` to have PMM use the current years value. This can be combined with a `-#` at the end to subtract that number of years. i.e. `current_year-2` +<sup>1</sup> You can use `current_year` to have Kometa use the current years value. This can be combined with a +`-#` at the end to subtract that number of years. i.e. `current_year-2` ## Date Filters @@ -267,7 +286,8 @@ No number filter can take multiple values. | `album_critic_rating` | Uses the Album's critic rating attribute to match<br>**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | | `track_user_rating` | Uses the Track's user rating attribute to match<br>**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -<sup>1</sup> You can use `current_year` to have PMM use the current years value. This can be combined with a `-#` at the end to subtract that number of years. i.e. `current_year-2` +<sup>1</sup> You can use `current_year` to have Kometa use the current years value. This can be combined with a +`-#` at the end to subtract that number of years. i.e. `current_year-2` ## Boolean Filters @@ -355,7 +375,8 @@ collections: limit: 20 ``` -If you specify TMDb Person ID's using the Setting `tmdb_person` and then tell either `actor`, `director`, `producer`, or `writer` to add `tmdb`, the script will translate the TMDb Person IDs into their names and run the filter on those names. +If you specify TMDb Person ID's using the Setting `tmdb_person` and then tell either `actor`, `director`, `producer`, or +`writer` to add `tmdb`, the script will translate the TMDb Person IDs into their names and run the filter on those names. ```yaml collections: diff --git a/docs/files/builders/sonarr.md b/docs/files/builders/sonarr.md index a181b52b..1e0deff3 100644 --- a/docs/files/builders/sonarr.md +++ b/docs/files/builders/sonarr.md @@ -23,7 +23,8 @@ collections: Gets Series from Sonarr based on their tags. -Set the attribute to the tag you want to search for. Multiple values are supported as either a list or a comma-separated string. +Set the attribute to the tag you want to search for. Multiple values are supported as either a list or a comma-separated +string. ```yaml collections: diff --git a/docs/files/builders/stevenlu.md b/docs/files/builders/stevenlu.md index a9805b96..c228b56d 100644 --- a/docs/files/builders/stevenlu.md +++ b/docs/files/builders/stevenlu.md @@ -14,7 +14,8 @@ Finds every movie on [StevenLu's Popular Movies List](https://movies.stevenlu.co The expected input is `true`. -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated and in a specific order. +The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated +and in a specific order. ```yaml collections: diff --git a/docs/files/builders/tautulli.md b/docs/files/builders/tautulli.md index d1474921..44e0f539 100644 --- a/docs/files/builders/tautulli.md +++ b/docs/files/builders/tautulli.md @@ -21,7 +21,8 @@ Both Tautulli Popular and Tautulli Watched have the same sub-attributes detailed | `list_minimum` | Minimum Number of Users Watching/Plays to add to the list. | :fontawesome-solid-circle-xmark:{ .red } | `0` | | `list_size` | Number of Movies/Shows to add to this list. | :fontawesome-solid-circle-xmark:{ .red } | `10` | -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated and in a specific order. +The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated +and in a specific order. ```yaml collections: diff --git a/docs/files/builders/tmdb.md b/docs/files/builders/tmdb.md index a2c29da1..8010352c 100644 --- a/docs/files/builders/tmdb.md +++ b/docs/files/builders/tmdb.md @@ -48,7 +48,8 @@ You can find items using the features of [TheMovieDb.org](https://www.themoviedb ## Expected Input -The builders below are expected to have the full URL to the item or the TMDb ID of the item. Multiple values are supported as either a list or a comma-separated string. +The builders below are expected to have the full URL to the item or the TMDb ID of the item. Multiple values are +supported as either a list or a comma-separated string. * [TMDb Collection](#tmdb-collection) and [TMDb Collection Details](#tmdb-collection) * [TMDb List](#tmdb-list) and [TMDb List Details](#tmdb-list) @@ -88,9 +89,12 @@ collections: - https://www.themoviedb.org/collection/121938 ``` -* You can update the collection details with the TMDb collection's summary, poster, and background by using `tmdb_collection_details`. -* You can specify multiple collections in `tmdb_collection_details` but it will only use the first one to update the collection details. -* Posters and background in the library's asset directory will be used over the collection details unless `tmdb_poster`/`tmdb_background` is also specified. +* You can update the collection details with the TMDb collection's summary, poster, and background by using +`tmdb_collection_details`. +* You can specify multiple collections in `tmdb_collection_details` but it will only use the first one to update the +collection details. +* Posters and background in the library's asset directory will be used over the collection details unless +`tmdb_poster`/`tmdb_background` is also specified. ```yaml collections: @@ -108,7 +112,8 @@ collections: Finds every item in the TMDb List. -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated and in a specific order. +The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated +and in a specific order. ```yaml collections: @@ -119,7 +124,8 @@ collections: ``` * You can update the collection details with the TMDb list's description and poster by using `tmdb_list_details`. -* You can specify multiple lists in `tmdb_list_details` but it will only use the first one to update the collection details. +* You can specify multiple lists in `tmdb_list_details` but it will only use the first one to update the collection +details. ```yaml collections: @@ -138,7 +144,8 @@ collections: ``` * You can update the collection details with the TMDb Person's biography and profile by using `tmdb_actor_details`. -* You can specify multiple people in `tmdb_actor_details` but it will only use the first one to update the collection details. +* You can specify multiple people in `tmdb_actor_details` but it will only use the first one to update the collection +details. ```yaml collections: @@ -157,7 +164,8 @@ collections: ``` * You can update the collection details with the TMDb Person's biography and profile by using `tmdb_crew_details`. -* You can specify multiple people in `tmdb_crew_details` but it will only use the first one to update the collection details. +* You can specify multiple people in `tmdb_crew_details` but it will only use the first one to update the collection +details. ```yaml collections: @@ -176,7 +184,8 @@ collections: ``` * You can update the collection details with the TMDb Person's biography and profile by using `tmdb_director_details`. -* You can specify multiple people in `tmdb_director_details` but it will only use the first one to update the collection details. +* You can specify multiple people in `tmdb_director_details` but it will only use the first one to update the collection +details. ```yaml collections: @@ -195,7 +204,8 @@ collections: ``` * You can update the collection details with the TMDb Person's biography and profile by using `tmdb_producer_details`. -* You can specify multiple people in `tmdb_producer_details` but it will only use the first one to update the collection details. +* You can specify multiple people in `tmdb_producer_details` but it will only use the first one to update the collection +details. ```yaml collections: @@ -214,7 +224,8 @@ collections: ``` * You can update the collection details with the TMDb Person's biography and profile by using `tmdb_writer_details`. -* You can specify multiple people in `tmdb_writer_details` but it will only use the first one to update the collection details. +* You can specify multiple people in `tmdb_writer_details` but it will only use the first one to update the collection +details. ```yaml collections: @@ -233,9 +244,12 @@ collections: tmdb_movie: 336560 #https://www.themoviedb.org/movie/336560 also accepted ``` -* You can update the collection details with the TMDb movie's summary, poster, and background by using `tmdb_movie_details`. -* You can specify multiple movies in `tmdb_movie_details` but it will only use the first one to update the collection details. -* Posters and background in the library's asset directory will be used over the collection details unless `tmdb_poster`/`tmdb_background` is also specified. +* You can update the collection details with the TMDb movie's summary, poster, and background by using +`tmdb_movie_details`. +* You can specify multiple movies in `tmdb_movie_details` but it will only use the first one to update the collection +details. +* Posters and background in the library's asset directory will be used over the collection details unless +`tmdb_poster`/`tmdb_background` is also specified. ```yaml collections: @@ -256,9 +270,12 @@ collections: - 60554 #https://www.themoviedb.org/tv/60554-star-wars-rebels also accepted ``` -* You can update the collection details with the TMDb show's summary, poster, and background by using `tmdb_show_details`. -* You can specify multiple shows in `tmdb_show_details` but it will only use the first one to update the collection details. -* Posters and background in the library's asset directory will be used over the collection details unless `tmdb_poster`/`tmdb_background` is also specified. +* You can update the collection details with the TMDb show's summary, poster, and background by using +`tmdb_show_details`. +* You can specify multiple shows in `tmdb_show_details` but it will only use the first one to update the collection +details. +* Posters and background in the library's asset directory will be used over the collection details unless +`tmdb_poster`/`tmdb_background` is also specified. ```yaml collections: @@ -302,7 +319,8 @@ Finds the movies/shows in TMDb's [Popular Movies](https://www.themoviedb.org/mov Use `tmdb_region` with this builder to set the region. -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated and in a specific order. +The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated +and in a specific order. ```yaml collections: @@ -318,7 +336,8 @@ Finds the movies in TMDb's [Now Playing](https://www.themoviedb.org/movie/now-pl Use `tmdb_region` with this builder to set the region. -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated and in a specific order. +The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated +and in a specific order. ```yaml collections: @@ -334,7 +353,8 @@ Finds the movies/shows in TMDb's [Top Rated Movies](https://www.themoviedb.org/m Use `tmdb_region` with this builder to set the region. -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated and in a specific order. +The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated +and in a specific order. ```yaml collections: @@ -350,7 +370,8 @@ Finds the movies in TMDb's [Upcoming Movies](https://www.themoviedb.org/movie/up Use `tmdb_region` with this builder to set the region. -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated and in a specific order. +The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated +and in a specific order. ```yaml collections: @@ -364,7 +385,8 @@ collections: Finds the shows in TMDb's [Airing Today Shows](https://www.themoviedb.org/tv/airing-today) list. -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated and in a specific order. +The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated +and in a specific order. ```yaml collections: @@ -378,7 +400,8 @@ collections: Finds the shows in TMDb's [On TV Shows](https://www.themoviedb.org/tv/on-the-air) list. -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated and in a specific order. +The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated +and in a specific order. ```yaml collections: @@ -392,7 +415,8 @@ collections: Finds the movies/shows in TMDb's Trending Daily list. -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated and in a specific order. +The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated +and in a specific order. ```yaml collections: @@ -406,7 +430,8 @@ collections: Finds the movies/shows in TMDb's Trending Weekly list. -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated and in a specific order. +The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated +and in a specific order. ```yaml collections: @@ -418,9 +443,12 @@ collections: ## TMDb Discover -Uses [TMDb's Discover Search](https://developer.themoviedb.org/docs/search-and-query-for-details) to find every movie/show based on the [movie search parameters](https://developers.themoviedb.org/3/discover/movie-discover) or [show search parameters](https://developers.themoviedb.org/3/discover/tv-discover) provided. +Uses [TMDb's Discover Search](https://developer.themoviedb.org/docs/search-and-query-for-details) to find every +movie/show based on the [movie search parameters](https://developers.themoviedb.org/3/discover/movie-discover) or +[show search parameters](https://developers.themoviedb.org/3/discover/tv-discover) provided. -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated and in a specific order. +The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated +and in a specific order. | Type | Description | |:-------------------|:--------------------------------------------------| @@ -435,52 +463,54 @@ The `sync_mode: sync` and `collection_order: custom` Setting are recommended sin !!!important - Note that a number of filters support being comma (,) or pipe (|) separated. Comma's are treated like an AND query while pipe's are treated like an OR. This allows for quite complex filtering depending on your desired results. - -| Movie Parameters | Description | -|:--------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `limit` | Specify how many movies you want returned by the query.<br>**Type:** Integer<br>**Default:** 100 | -| `region` | Specify a [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) to filter release dates. Must be uppercase. Will use the `region` specified in the [TMDb Config](../../config/tmdb.md) by default.<br>**Type:** `^[A-Z]{2}$` | -| `sort_by` | Choose from one of the many available sort options.<br>**Type:** Any [sort options](#sort-options) below<br>**Default:** `popularity.desc` | -| `certification_country` | Used in conjunction with the certification parameter, use this to specify a country with a valid certification.<br>**Type:** String | -| `certification` | Filter results with a valid certification from the `certification_country` parameter.<br>**Type:** String | -| `certification.lte` | Filter and only include movies that have a certification that is less than or equal to the specified value.<br>**Type:** String | -| `certification.gte` | Filter and only include movies that have a certification that is greater than or equal to the specified value.<br>**Type:** String | -| `include_adult` | A filter and include or exclude adult movies.<br>**Type:** Boolean | -| `include_video` | A filter and include or exclude videos.<br>**Type:** Boolean | -| `primary_release_year` | A filter to limit the results to a specific primary release year.<br>**Type:** Year: YYYY | -| `primary_release_date.gte` | Filter and only include movies that have a primary release date that is greater or equal to the specified value.<br>**Type:** Date: `MM/DD/YYYY` | -| `primary_release_date.lte` | Filter and only include movies that have a primary release date that is less than or equal to the specified value.<br>**Type:** Date: `MM/DD/YYYY` | -| `release_date.gte` | Filter and only include movies that have a release date (looking at all release dates) that is greater or equal to the specified value.<br>**Type:** Date: `MM/DD/YYYY` | -| `release_date.lte` | Filter and only include movies that have a release date (looking at all release dates) that is less than or equal to the specified value.<br>**Type:** Date: `MM/DD/YYYY` | -| `with_release_type` | Specify a comma (AND) or pipe (OR) separated value to filter release types by.<br>**Type:** String<br>**Values:** `1`: Premiere, `2`: Theatrical (limited), `3`: Theatrical, `4`: Digital, `5`: Physical, `6`: TV | -| `year` | A filter to limit the results to a specific year (looking at all release dates).<br>**Type:** Year: `YYYY` | -| `vote_count.gte` | Filter and only include movies that have a vote count that is greater or equal to the specified value.<br>**Type:** Integer | -| `vote_count.lte` | Filter and only include movies that have a vote count that is less than or equal to the specified value.<br>**Type:** Integer | -| `vote_average.gte` | Filter and only include movies that have a rating that is greater or equal to the specified value.<br>**Type:** Number | -| `vote_average.lte` | Filter and only include movies that have a rating that is less than or equal to the specified value.<br>**Type:** Number | -| `with_cast` | A comma-separated list of person ID's. Only include movies that have one of the ID's added as an actor.<br>Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query<br>**Type:** String | -| `with_crew` | A comma-separated list of person ID's. Only include movies that have one of the ID's added as a crew member.<br>Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query<br>**Type:** String | -| `with_people` | A comma-separated list of person ID's. Only include movies that have one of the ID's added as either an actor or a crew member.<br>Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query<br>**Type:** String | -| `with_companies` | A comma-separated list of production company ID's. Only include movies that have one of the ID's added as a production company.<br>Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query<br>**Type:** String | -| `without_companies` | Filter the results to exclude the specific production companies you specify here. AND / OR filters are supported.<br>**Type:** String | -| `with_genres` | Comma-separated value of genre ids that you want to include in the results.<br>Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query<br>**Type:** String | -| `without_genres` | Comma-separated value of genre ids that you want to exclude from the results.<br>**Type:** String | -| `with_keywords` | A comma-separated list of keyword ID's. Only includes movies that have one of the ID's added as a keyword.<br>Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query<br>**Type:** String | -| `without_keywords` | Exclude items with certain keywords. You can comma and pipe separate these values to create an 'AND' or 'OR' logic.<br>**Type:** String | -| `with_runtime.gte` | Filter and only include movies that have a runtime that is greater or equal to a value.<br>**Type:** Integer | -| `with_runtime.lte` | Filter and only include movies that have a runtime that is less than or equal to a value.<br>**Type:** Integer | -| `with_original_language` | Specify an ISO 639-1 string to filter results by their original language value.<br>**Type:** String | -| `with_watch_providers` | A comma or pipe separated list of watch provider ID's.<br>use in conjunction with watch_region, can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query<br>**Type:** String | -| `watch_region` | An [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes). Combine this filter with `with_watch_providers` in order to filter your results by a specific watch provider in a specific region.<br>**Type:** String<br>**Values:** [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | -| `with_watch_monetization_types` | In combination with `watch_region`, you can filter by monetization type.<br>Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query<br>**Type:** String<br>**Values:** `flatrate`, `free`, `ads`, `rent`, `buy` | + Note that a number of filters support being comma (,) or pipe (|) separated. Comma's are treated like an AND query + while pipe's are treated like an OR. This allows for quite complex filtering depending on your desired results. + +| Movie Parameters | Description | +|:--------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `limit` | Specify how many movies you want returned by the query.<br>**Type:** Integer<br>**Default:** 100 | +| `region` | Specify a [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) to filter release dates. Must be uppercase. Will use the `region` specified in the [TMDb Config](../../config/tmdb.md) by default.<br>**Type:** `^[A-Z]{2}$` | +| `sort_by` | Choose from one of the many available sort options.<br>**Type:** Any [sort options](#sort-options) below<br>**Default:** `popularity.desc` | +| `certification_country` | Used in conjunction with the certification parameter, use this to specify a country with a valid certification.<br>**Type:** String | +| `certification` | Filter results with a valid certification from the `certification_country` parameter.<br>**Type:** String | +| `certification.lte` | Filter and only include movies that have a certification that is less than or equal to the specified value.<br>**Type:** String | +| `certification.gte` | Filter and only include movies that have a certification that is greater than or equal to the specified value.<br>**Type:** String | +| `include_adult` | A filter and include or exclude adult movies.<br>**Type:** Boolean | +| `include_video` | A filter and include or exclude videos.<br>**Type:** Boolean | +| `primary_release_year` | A filter to limit the results to a specific primary release year.<br>**Type:** Year: YYYY | +| `primary_release_date.gte` | Filter and only include movies that have a primary release date that is greater or equal to the specified value.<br>**Type:** Date: `MM/DD/YYYY` | +| `primary_release_date.lte` | Filter and only include movies that have a primary release date that is less than or equal to the specified value.<br>**Type:** Date: `MM/DD/YYYY` | +| `release_date.gte` | Filter and only include movies that have a release date (looking at all release dates) that is greater or equal to the specified value.<br>**Type:** Date: `MM/DD/YYYY` | +| `release_date.lte` | Filter and only include movies that have a release date (looking at all release dates) that is less than or equal to the specified value.<br>**Type:** Date: `MM/DD/YYYY` | +| `with_release_type` | Specify a comma (AND) or pipe (OR) separated value to filter release types by.<br>**Type:** String<br>**Values:** `1`: Premiere, `2`: Theatrical (limited), `3`: Theatrical, `4`: Digital, `5`: Physical, `6`: TV | +| `year` | A filter to limit the results to a specific year (looking at all release dates).<br>**Type:** Year: `YYYY` | +| `vote_count.gte` | Filter and only include movies that have a vote count that is greater or equal to the specified value.<br>**Type:** Integer | +| `vote_count.lte` | Filter and only include movies that have a vote count that is less than or equal to the specified value.<br>**Type:** Integer | +| `vote_average.gte` | Filter and only include movies that have a rating that is greater or equal to the specified value.<br>**Type:** Number | +| `vote_average.lte` | Filter and only include movies that have a rating that is less than or equal to the specified value.<br>**Type:** Number | +| `with_cast` | A comma-separated list of person ID's. Only include movies that have one of the ID's added as an actor.<br>Can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query<br>**Type:** String | +| `with_crew` | A comma-separated list of person ID's. Only include movies that have one of the ID's added as a crew member.<br>Can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query<br>**Type:** String | +| `with_people` | A comma-separated list of person ID's. Only include movies that have one of the ID's added as either an actor or a crew member.<br>Can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query<br>**Type:** String | +| `with_companies` | A comma-separated list of production company ID's. Only include movies that have one of the ID's added as a production company.<br>Can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query<br>**Type:** String | +| `without_companies` | Filter the results to exclude the specific production companies you specify here. AND / OR filters are supported.<br>**Type:** String | +| `with_genres` | Comma-separated value of genre ids that you want to include in the results.<br>Can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query<br>**Type:** String | +| `without_genres` | Comma-separated value of genre ids that you want to exclude from the results.<br>**Type:** String | +| `with_keywords` | A comma-separated list of keyword ID's. Only includes movies that have one of the ID's added as a keyword.<br>Can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query<br>**Type:** String | +| `without_keywords` | Exclude items with certain keywords. You can comma and pipe separate these values to create an 'AND' or 'OR' logic.<br>**Type:** String | +| `with_runtime.gte` | Filter and only include movies that have a runtime that is greater or equal to a value.<br>**Type:** Integer | +| `with_runtime.lte` | Filter and only include movies that have a runtime that is less than or equal to a value.<br>**Type:** Integer | +| `with_original_language` | Specify an ISO 639-1 string to filter results by their original language value.<br>**Type:** String | +| `with_watch_providers` | A comma or pipe separated list of watch provider ID's.<br>use in conjunction with watch_region, can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query<br>**Type:** String | +| `watch_region` | An [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes). Combine this filter with `with_watch_providers` in order to filter your results by a specific watch provider in a specific region.<br>**Type:** String<br>**Values:** [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | +| `with_watch_monetization_types` | In combination with `watch_region`, you can filter by monetization type.<br>Can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query<br>**Type:** String<br>**Values:** `flatrate`, `free`, `ads`, `rent`, `buy` | ### Discover Shows Parameters !!!important - Note that a number of filters support being comma (,) or pipe (|) separated. Comma's are treated like an AND query while pipe's are treated like an OR. This allows for quite complex filtering depending on your desired results. + Note that a number of filters support being comma (,) or pipe (|) separated. Comma's are treated like an AND query + while pipe's are treated like an OR. This allows for quite complex filtering depending on your desired results. | Show Parameters | Description | |:--------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -498,43 +528,43 @@ The `sync_mode: sync` and `collection_order: custom` Setting are recommended sin | `vote_average.gte` | Filter and only include TV that have a rating that is greater or equal to the specified value.<br>**Type:** Number | | `vote_average.lte` | Filter and only include TV that have a rating that is less than or equal to the specified value.<br>**Type:** Number | | `with_networks` | Comma-separated value of network ids that you want to include in the results.<br>**Type:** String | -| `with_companies` | A comma-separated list of production company ID's. Only include movies that have one of the ID's added as a production company.<br>Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query<br>**Type:** String | +| `with_companies` | A comma-separated list of production company ID's. Only include movies that have one of the ID's added as a production company.<br>Can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query<br>**Type:** String | | `without_companies` | Filter the results to exclude the specific production companies you specify here. AND / OR filters are supported.<br>**Type:** String | -| `with_genres` | Comma-separated value of genre ids that you want to include in the results.<br>Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query<br>**Type:** String | +| `with_genres` | Comma-separated value of genre ids that you want to include in the results.<br>Can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query<br>**Type:** String | | `without_genres` | Comma-separated value of genre ids that you want to exclude from the results.<br>**Type:** String | -| `with_keywords` | A comma-separated list of keyword ID's. Only includes TV shows that have one of the ID's added as a keyword.<br>Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query<br>**Type:** String | +| `with_keywords` | A comma-separated list of keyword ID's. Only includes TV shows that have one of the ID's added as a keyword.<br>Can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query<br>**Type:** String | | `without_keywords` | Exclude items with certain keywords. You can comma and pipe separate these values to create an 'AND' or 'OR' logic.<br>**Type:** String | | `with_runtime.gte` | Filter and only include TV shows with an episode runtime that is greater than or equal to a value.<br>**Type:** Integer | | `with_runtime.lte` | Filter and only include TV shows with an episode runtime that is less than or equal to a value.<br>**Type:** Integer | | `with_original_language` | Specify an ISO 639-1 string to filter results by their original language value.<br>**Type:** String | | `with_name_translation` | Specify a language/country string to filter the results by if the item has a type of name translation.<br>**Type:** String<br>**Values:** `ar-AE`, `ar-SA`, `bg-BG`, `bn-BD`, `ca-ES`, `ch-GU`, `cs-CZ`, `da-DK`, `de-DE`, `el-GR`, `en-US`, `eo-EO`, `es-ES`, `es-MX`, `eu-ES`, `fa-IR`, `fi-FI`, `fr-CA`, `fr-FR`, `he-IL`, `hi-IN`, `hu-HU`, `id-ID`, `it-IT`, `ja-JP`, `ka-GE`, `kn-IN`, `ko-KR`, `lt-LT`, `ml-IN`, `nb-NO`, `nl-NL`, `no-NO`, `pl-PL`, `pt-BR`, `pt-PT`, `ro-RO`, `ru-RU`, `sk-SK`, `sl-SI`, `sr-RS`, `sv-SE`, `ta-IN`, `te-IN`, `th-TH`, `tr-TR`, `uk-UA`, `vi-VN`, `zh-CN`, `zh-TW` | | `screened_theatrically` | Filter results to include items that have been screened theatrically.<br>**Type:** Boolean | -| `with_watch_providers` | A comma or pipe separated list of watch provider ID's.<br>use in conjunction with watch_region, can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query<br>**Type:** String | +| `with_watch_providers` | A comma or pipe separated list of watch provider ID's.<br>use in conjunction with watch_region, can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query<br>**Type:** String | | `watch_region` | An [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes). Combine this filter with `with_watch_providers` in order to filter your results by a specific watch provider in a specific region.<br>**Type:** String | -| `with_watch_monetization_types` | In combination with `watch_region`, you can filter by monetization type.<br>Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query<br>**Type:** String<br>**Values:** `flatrate`, `free`, `ads`, `rent`, `buy` | -| `with_status` | Filter TV shows by their status.<br>**Type:** String<br>Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query<br>**Values:** `0`: Returning Series, `1`: Planned, `2`: In Production, `3`: Ended, `4`: Cancelled, `5`: Pilot | -| `with_type` | Filter TV shows by their type.<br>Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query<br>**Type:** String<br>**Values:** `0`: Documentary, `1`: News, `2`: Miniseries, `3`: Reality, `4`: Scripted, `5`: Show, `6`: Video | +| `with_watch_monetization_types` | In combination with `watch_region`, you can filter by monetization type.<br>Can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query<br>**Type:** String<br>**Values:** `flatrate`, `free`, `ads`, `rent`, `buy` | +| `with_status` | Filter TV shows by their status.<br>**Type:** String<br>Can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query<br>**Values:** `0`: Returning Series, `1`: Planned, `2`: In Production, `3`: Ended, `4`: Cancelled, `5`: Pilot | +| `with_type` | Filter TV shows by their type.<br>Can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query<br>**Type:** String<br>**Values:** `0`: Documentary, `1`: News, `2`: Miniseries, `3`: Reality, `4`: Scripted, `5`: Show, `6`: Video | ### Sort Options -| Sort Option | Movie Sort | Show Sort | -|:----------------------------|:---------------------------------------------:|:--------------------------------------------:| -| `popularity.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| `popularity.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| `original_title.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `original_title.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `revenue.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `revenue.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `release_date.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `release_date.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `primary_release_date.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `primary_release_date.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `first_air_date.asc` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `first_air_date.desc` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `vote_average.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| `vote_average.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| `vote_count.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `vote_count.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| Sort Option | Movie Sort | Show Sort | +|:----------------------------|:------------------------------------------:|:------------------------------------------:| +| `popularity.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| `popularity.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| `original_title.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| `original_title.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| `revenue.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| `revenue.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| `release_date.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| `release_date.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| `primary_release_date.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| `primary_release_date.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| `first_air_date.asc` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | +| `first_air_date.desc` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | +| `vote_average.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| `vote_average.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| `vote_count.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| `vote_count.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | ```yaml collections: diff --git a/docs/files/builders/trakt.md b/docs/files/builders/trakt.md index 2c621d18..537c0cf1 100644 --- a/docs/files/builders/trakt.md +++ b/docs/files/builders/trakt.md @@ -19,17 +19,21 @@ Finds every item in the Trakt List. The expected input is a Trakt List URL. Multiple values are supported only as a list. -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated and in a specific order. +The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated +and in a specific order. -**Trakt Lists cannot be sorted through the API, but the list is always returned to the default list order if you own the list.** +**Trakt Lists cannot be sorted through the API, but the list is always returned to the default list order if you own +the list.** ???+ tip - If you have [authorized Trakt](../../config/trakt.md) then you can use private Trakt Lists, this is not possible if you have not authorized Trakt. + If you have [authorized Trakt](../../config/trakt.md) then you can use private Trakt Lists, this is not possible if + you have not authorized Trakt. ???+ warning - Trakt lists and users come and go, and PMM has no control over this. The list URLs found in this documentation are used here as examples and are available and working at time of writing, but they may disappear at any time. Do not take their use here as a guarantee that they exist or are working when you read this. + Trakt lists and users come and go, and Kometa has no control over this. The list URLs found in this documentation + are used here as examples and are available and working at time of writing, but they may disappear at any time. Do not take their use here as a guarantee that they exist or are working when you read this. ```yaml collections: @@ -48,7 +52,8 @@ collections: ``` * You can update the collection details with the Trakt List's description by using `trakt_list_details`. -* You can specify multiple collections in `trakt_list_details` but it will only use the first one to update the collection summary. +* You can specify multiple collections in `trakt_list_details` but it will only use the first one to update the +collection summary. ```yaml collections: @@ -62,7 +67,8 @@ collections: Finds the movies/shows in the Trakt Chart. The options are detailed below. -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated and in a specific order. +The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated +and in a specific order. | Attribute | Description & Values | |:-----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -126,7 +132,8 @@ collections: Finds every movie/show in the Trakt Userlist. -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated and in a specific order. +The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated +and in a specific order. | Attribute | Description & Values | |:-----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -165,7 +172,8 @@ Finds the movies/shows in Trakt's Recommendations for [Movies](https://trakt.doc The expected input is a single integer value of how many movies/shows to query. -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated and in a specific order. +The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated +and in a specific order. ```yaml collections: @@ -181,7 +189,8 @@ Finds the 10 movies in Trakt's Top Box Office [Movies](https://trakt.tv/movies/b The expected input is true. -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated and in a specific order. +The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated +and in a specific order. ```yaml collections: @@ -193,7 +202,8 @@ collections: ## Syncing Plex Collections to Trakt Lists -A combination of PMM settings/attributes can be utilized to create a collection via PMM and then sync them to a blank or existing Trakt List. +A combination of Kometa settings/attributes can be utilized to create a collection via Kometa and then sync them to a +blank or existing Trakt List. NOTE: You must either create an empty Trakt list or specify an existing Trakt list which you have write access to. @@ -201,13 +211,15 @@ NOTE: You must either create an empty Trakt list or specify an existing Trakt li collections: My Favourite Movies: sync_to_trakt_list: myfilms - # trakt_list: https://trakt.tv/users/plexmetamanager/lists/myfilms OPTIONAL TWO-WAY SYNC + # trakt_list: https://trakt.tv/users/k0meta/lists/myfilms OPTIONAL TWO-WAY SYNC plex_search: any: rating.gte: 8 sort_by: user_rating.desc ``` -In this example, PMM will generate a Plex collection with any films that I have rated 8.0 or above (using the `plex_search`). The `sync_to_trakt_list` will take those films and then sync them to my `myfilms` Trakt list. +In this example, Kometa will generate a Plex collection with any films that I have rated 8.0 or above (using the +`plex_search`). The `sync_to_trakt_list` will take those films and then sync them to my `myfilms` Trakt list. -I can optionally also enable the `trakt_list` to create a two-way sync between Plex and Trakt. This allows me to add films to the Trakt list that I want in my Plex collection, and then sync them to Plex. +I can optionally also enable the `trakt_list` to create a two-way sync between Plex and Trakt. This allows me to add +films to the Trakt list that I want in my Plex collection, and then sync them to Plex. diff --git a/docs/files/builders/tvdb.md b/docs/files/builders/tvdb.md index 2c7cbae6..6a4ff57a 100644 --- a/docs/files/builders/tvdb.md +++ b/docs/files/builders/tvdb.md @@ -17,9 +17,11 @@ No configuration is required for these builders. Finds every item in a [TVDb List](https://www.thetvdb.com/lists) or [TVDb Userlist](https://www.thetvdb.com/lists/custom) -The expected input is a TVDb List URL or TVDb Userlist URL. Multiple values are supported as either a list or a comma-separated string. +The expected input is a TVDb List URL or TVDb Userlist URL. Multiple values are supported as either a list or a +comma-separated string. -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated and in a specific order. +The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated +and in a specific order. ```yaml collections: @@ -37,7 +39,8 @@ collections: ``` * You can update the collection details with the TVDb list's description and poster by using `tvdb_list_details`. -* You can specify multiple lists in `tvdb_list_details` but it will only use the first one to update the collection details. +* You can specify multiple lists in `tvdb_list_details` but it will only use the first one to update the collection +details. ```yaml collections: @@ -51,7 +54,8 @@ collections: Finds the show specified -The expected input is a TVDb Series ID or TVDb Series URL. Multiple values are supported as either a list or a comma-separated string. +The expected input is a TVDb Series ID or TVDb Series URL. Multiple values are supported as either a list or a +comma-separated string. ```yaml collections: @@ -66,9 +70,12 @@ collections: - https://www.thetvdb.com/series/star-wars-rebels ``` -* You can update the collection details with the TVDb show's summary, poster, and background by using `tvdb_show_details`. -* You can specify multiple shows in `tvdb_show_details` but it will only use the first one to update the collection details. -* Posters and background in the library's asset directory will be used over the collection details unless `tvdb_poster`/`tvdb_background` is also specified. +* You can update the collection details with the TVDb show's summary, poster, and background by using +`tvdb_show_details`. +* You can specify multiple shows in `tvdb_show_details` but it will only use the first one to update the collection +details. +* Posters and background in the library's asset directory will be used over the collection details unless +`tvdb_poster`/`tvdb_background` is also specified. ```yaml collections: @@ -80,7 +87,8 @@ collections: Finds the movie specified -The expected input is a TVDb Movie ID or TVDb Movie URL. Multiple values are supported as either a list or a comma-separated string. +The expected input is a TVDb Movie ID or TVDb Movie URL. Multiple values are supported as either a list or a +comma-separated string. ```yaml collections: @@ -96,9 +104,12 @@ collections: - https://www.thetvdb.com/movies/the-lord-of-the-rings-the-return-of-the-king ``` -* You can update the collection details with the TVDb movie's summary, poster, and background by using `tvdb_movie_details`. -* You can specify multiple movies in `tvdb_movie_details` but it will only use the first one to update the collection details. -* Posters and background in the library's asset directory will be used over the collection details unless `tvdb_poster`/`tvdb_background` is also specified. +* You can update the collection details with the TVDb movie's summary, poster, and background by using +`tvdb_movie_details`. +* You can specify multiple movies in `tvdb_movie_details` but it will only use the first one to update the collection +details. +* Posters and background in the library's asset directory will be used over the collection details unless +`tvdb_poster`/`tvdb_background` is also specified. ```yaml collections: diff --git a/docs/files/collections.md b/docs/files/collections.md index 2447a7ba..e97460f5 100644 --- a/docs/files/collections.md +++ b/docs/files/collections.md @@ -1,6 +1,6 @@ # Collection Files -Collection Files holds information on how Plex Meta Manager should create collections. There are a large number of +Collection Files holds information on how Kometa should create collections. There are a large number of builders available to build collections, ## Overview @@ -46,10 +46,10 @@ I then call "MyCollections.yml" in my [Configuration File](../config/overview.md ``` 1. This must match the name of a library in your Plex server - 2. `config` refers to the location that you mapped to `config` when following the PMM Installation Guides. + 2. `config` refers to the location that you mapped to `config` when following the Kometa Installation Guides. -Whenever I execute Plex Meta Manager and the Movies library is run, MyCollections.yml will run and my "Top 50 Grossing -Films of All Time (Worldwide)" will be created/updated. +Whenever I execute Kometa and the Movies library is run, MyCollections.yml will run and my "Top 50 Grossing Films of +All Time (Worldwide)" will be created/updated. ## File Attributes @@ -66,7 +66,7 @@ Collection Files can utilize the following top-level attributes an error when trying to run the file against your library. * Example Files can be found in the -[Plex Meta Manager Configs Repository](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM) +[Kometa Community Configs Repository](https://github.com/Kometa-Team/Community-Configs) ## Collection Operations & Attributes @@ -95,12 +95,12 @@ Examples of these can be seen here ```yaml collections: Christmas Extravaganza: - trakt_list: https://trakt.tv/users/plexmetamanager/lists/christmas-extravaganza-non-tv-movie #(1)! + trakt_list: https://trakt.tv/users/k0meta/lists/christmas-extravaganza-non-tv-movie #(1)! sync_mode: append #(2!) collection_order: custom #(3)! ``` - 1. This is a Trakt List builder, telling PMM to build a collection based on the items in this list + 1. This is a Trakt List builder, telling Kometa to build a collection based on the items in this list 2. If items are removed from the source list, having sync mode set to `append` means they will not be removed from the collection in Plex. Set this to `sync` if you want the items removed in the collection too 3. Sort the collection in the order that it is received from the Trakt list @@ -129,7 +129,7 @@ Examples of these can be seen here item_label: myplextag #(3)! ``` - 1. Tells PMM to not physically build a collection, but it will still perform the actions of the collection + 1. Tells Kometa to not physically build a collection, but it will still perform the actions of the collection 2. Find all items in Radarr that have the tag `mytag` 3. For each of the items with `mytag` in Radarr, apply the `myplextag` to the items in the Plex library @@ -138,12 +138,12 @@ Examples of these can be seen here ```yaml collections: Christmas Extravaganza: - trakt_list: https://trakt.tv/users/plexmetamanager/lists/christmas-extravaganza-non-tv-movie #(1)! + trakt_list: https://trakt.tv/users/k0meta/lists/christmas-extravaganza-non-tv-movie #(1)! schedule: range(12/01-12/31) #(2)! delete_not_scheduled: true #(3)! ``` - 1. Tells PMM to not physically build a collection, but it will still perform the actions of the collection + 1. Tells Kometa to not physically build a collection, but it will still perform the actions of the collection 2. Only run this collection from December 1st through December 31st 3. If today is not part of the above scheduled range, delete the Christmas Extravaganza collection if it exists in the Plex library @@ -186,7 +186,7 @@ collections: ## Dynamic Collections -In addition to manually defining each Collection that you want in your library, Plex Meta Manager can also dynamically +In addition to manually defining each Collection that you want in your library, Kometa can also dynamically create collections based on a variety of different criteria, such as * Collections for the top `X` popular people on TMDb (Bruce Willis, Tom Hanks etc.) diff --git a/docs/files/dynamic.md b/docs/files/dynamic.md index 948f4d16..0852bf39 100644 --- a/docs/files/dynamic.md +++ b/docs/files/dynamic.md @@ -1,6 +1,6 @@ # Dynamic Collections -Plex Meta Manager can dynamically create collections based on different criteria, such as +Kometa can dynamically create collections based on different criteria, such as * Collections based on the Collections from TMDb for every item in the library. ( [Star Wars](https://www.themoviedb.org/collection/10-star-wars-collection), @@ -163,7 +163,7 @@ by this dynamic collection. **Attribute:** `addons` - **Accepted Values:** [Dictionary](../pmm/yaml.md#dictionaries) where the key is the `dynamic key` and the value is a + **Accepted Values:** [Dictionary](../kometa/yaml.md#dictionaries) where the key is the `dynamic key` and the value is a list of `dynamic keys` to combine. ???+ example "Example" @@ -237,8 +237,8 @@ by this dynamic collection. **Attribute:** `template_variables` - **Accepted Values:** [Dictionary](../pmm/yaml.md#dictionaries) where the key is the template variable and the value - is another [Dictionary](../pmm/yaml.md#dictionaries) where the key is the `dynamic key` of the collection you want + **Accepted Values:** [Dictionary](../kometa/yaml.md#dictionaries) where the key is the template variable and the value + is another [Dictionary](../kometa/yaml.md#dictionaries) where the key is the `dynamic key` of the collection you want change the template variable for and the value is the new value for the template variable. ???+ example "Example" @@ -351,7 +351,7 @@ by this dynamic collection. **Attribute:** `key_name_override` - **Accepted Values:** [Dictionary](../pmm/yaml.md#dictionaries) where the key is the key name you want to change and + **Accepted Values:** [Dictionary](../kometa/yaml.md#dictionaries) where the key is the key name you want to change and the value is what to change that key name to. ???+ example "Example" @@ -379,7 +379,7 @@ by this dynamic collection. **Attribute:** `title_override` - **Accepted Values:** [Dictionary](../pmm/yaml.md#dictionaries) where the key is the `dynamic key` you want to change + **Accepted Values:** [Dictionary](../kometa/yaml.md#dictionaries) where the key is the `dynamic key` you want to change and the value is what to change the title to. ???+ example "Example" diff --git a/docs/files/dynamic_types.md b/docs/files/dynamic_types.md index 4e46c9d9..7e057c39 100644 --- a/docs/files/dynamic_types.md +++ b/docs/files/dynamic_types.md @@ -162,7 +162,7 @@ requirements of creating the collection. **`type` Value:** `imdb_awards` - **`data` Value:** [Dictionary](../pmm/yaml.md#dictionaries) of Attributes + **`data` Value:** [Dictionary](../kometa/yaml.md#dictionaries) of Attributes ??? blank "`event_id` - Determines the [IMDb Event](https://www.imdb.com/event/) used.<a class="headerlink" href="#imdb-awards-event-id" title="Permanent link">¶</a>" @@ -351,7 +351,7 @@ requirements of creating the collection. **`type` Value:** `actor` - **`data` Value:** [Dictionary](../pmm/yaml.md#dictionaries) of Attributes + **`data` Value:** [Dictionary](../kometa/yaml.md#dictionaries) of Attributes ??? blank "`depth` - Determines how many "top" acting credits per item.<a class="headerlink" href="#actor-depth" title="Permanent link">¶</a>" @@ -434,7 +434,7 @@ requirements of creating the collection. **`type` Value:** `director` - **`data` Value:** [Dictionary](../pmm/yaml.md#dictionaries) of Attributes + **`data` Value:** [Dictionary](../kometa/yaml.md#dictionaries) of Attributes ??? blank "`depth` - Determines how many "top" directing credits per item.<a class="headerlink" href="#director-depth" title="Permanent link">¶</a>" @@ -517,7 +517,7 @@ requirements of creating the collection. **`type` Value:** `writer` - **`data` Value:** [Dictionary](../pmm/yaml.md#dictionaries) of Attributes + **`data` Value:** [Dictionary](../kometa/yaml.md#dictionaries) of Attributes ??? blank "`depth` - Determines how many "top" writing credits per item.<a class="headerlink" href="#writer-depth" title="Permanent link">¶</a>" @@ -600,7 +600,7 @@ requirements of creating the collection. **`type` Value:** `producer` - **`data` Value:** [Dictionary](../pmm/yaml.md#dictionaries) of Attributes + **`data` Value:** [Dictionary](../kometa/yaml.md#dictionaries) of Attributes ??? blank "`depth` - Determines how many "top" producing credits per item.<a class="headerlink" href="#producer-depth" title="Permanent link">¶</a>" @@ -904,7 +904,7 @@ requirements of creating the collection. === "Show Default" - Shows don't inherently have a decade attribute so pmm just passes all years from the decade as a list. + Shows don't inherently have a decade attribute so Kometa just passes all years from the decade as a list. ```yaml default_template: @@ -1404,7 +1404,7 @@ requirements of creating the collection. **`type` Value:** `number` - **`data` Value:** [Dictionary](../pmm/yaml.md#dictionaries) of Attributes + **`data` Value:** [Dictionary](../kometa/yaml.md#dictionaries) of Attributes ??? blank "`starting` - Determines the starting number.<a class="headerlink" href="#number-starting" title="Permanent link">¶</a>" @@ -1480,7 +1480,7 @@ requirements of creating the collection. **`type` Value:** `custom` - **`data` Value:** [Dictionary](../pmm/yaml.md#dictionaries) with the keys being the `dynamic key` and the values + **`data` Value:** [Dictionary](../kometa/yaml.md#dictionaries) with the keys being the `dynamic key` and the values being the `key name` **Valid Library Types:** Movies, Shows, Music, and Video @@ -1505,8 +1505,8 @@ requirements of creating the collection. cache_builders: 1 smart_label: release.desc sync_mode: sync - mdblist_list: https://mdblist.com/lists/plexmetamanager/<<key>>-movies - url_poster: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager-Images/master/streaming/<<key_name_encoded>>.jpg + mdblist_list: https://mdblist.com/lists/k0meta/<<key>>-movies + url_poster: https://raw.githubusercontent.com/Kometa-Team/Default-Images/master/streaming/<<key_name_encoded>>.jpg dynamic_collections: Streaming: diff --git a/docs/files/filters.md b/docs/files/filters.md index b702f4d0..dd9f67de 100644 --- a/docs/files/filters.md +++ b/docs/files/filters.md @@ -218,9 +218,9 @@ Special Filters each have their own set of rules for how they're used. <sup>**2**</sup> Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the `count` modifiers. -<sup>**3**</sup> You can use `current_year` to have PMM use the current years value. This can be combined with a `-#` at the end to subtract that number of years. i.e. `current_year-2` +<sup>**3**</sup> You can use `current_year` to have Kometa use the current years value. This can be combined with a `-#` at the end to subtract that number of years. i.e. `current_year-2` -<sup>**4**</sup> The actual numbers are pulled from the [PMM-Mediastingers](https://github.com/meisnate12/PMM-Mediastingers) Repo. +<sup>**4**</sup> The actual numbers are pulled from the [Mediastingers](https://github.com/Kometa-Team/Mediastingers) Repo. <sup>**5**</sup> Also is a Tag Filter and can use all of those modifiers. diff --git a/docs/files/metadata.md b/docs/files/metadata.md index 763d3b0e..a727c566 100644 --- a/docs/files/metadata.md +++ b/docs/files/metadata.md @@ -202,7 +202,7 @@ mapping name as `title` for matching. 2. When `mapping_id` is not provided and the mapping name was specified as an ID, the default behaviour is to use the mapping name as `mapping_id` for matching. -3. When the server does not have a Plex Pass then the Edition Field is not accessible. In this scenario, PMM will check +3. When the server does not have a Plex Pass then the Edition Field is not accessible. In this scenario, Kometa will check the movie's filepath for `{edition-...}` to determine what the edition is. ??? example "Matching Examples (click to expand)" @@ -396,7 +396,7 @@ The available attributes for editing movies are as follows |:------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------| | `run_definition` | Used to specify if this definition runs.<br>Multiple can be used for one definition as a list or comma separated string. One `false` or unmatched library type will cause it to fail.<br>**Values:** `movie`, `show`, `artist`, `true`, `false` | `Movies`, `Shows`, `Artists` | | `tmdb_show` | TMDb Show ID to use for metadata. Used when the Movie in your library is actually a miniseries on TMDb. (Example: [Halo 4: Forward Unto Dawn](https://www.themoviedb.org/tv/56295) or [IT](https://www.themoviedb.org/tv/19614)) **This is not used to say this movie is the given ID.** | `Movies` | -| `f1_season` | F1 Season Year to make the Show represent a Season of F1 Races. See [Formula 1 Metadata Guide](../pmm/guides/formula.md) for more information. | `Shows` | +| `f1_season` | F1 Season Year to make the Show represent a Season of F1 Races. See [Formula 1 Metadata Guide](../kometa/guides/formula.md) for more information. | `Shows` | | `round_prefix` | Used only with `f1_season` to add the round as a prefix to the Season (Race) Titles i.e. `Australian Grand Prix` --> `01 - Australian Grand Prix`. | `Shows` | | `shorten_gp` | Used only with `f1_season` to shorten `Grand Prix` to `GP` in the Season (Race) Titles i.e. `Australian Grand Prix` --> `Australian GP`. | `Shows` | | `seasons` | Attribute used to edit season metadata. The mapping name is the season number (use 0 for specials) or the season name. | `Shows` | @@ -406,7 +406,7 @@ The available attributes for editing movies are as follows | `albums` | Attribute used to edit album metadata. The mapping name is the album name. | `Artists` | | `tracks` | Attribute used to edit track metadata. The mapping name is the track number on that Album, or the title of the Track. | `Albums` | -1. If the server does not have a Plex Pass then the Edition Field is not accessible. In this case PMM will check the +1. If the server does not have a Plex Pass then the Edition Field is not accessible. In this case Kometa will check the movies filepath for `{edition-MOVIES EDITION}` to determine what the edition is. ### General Attributes diff --git a/docs/files/overlays.md b/docs/files/overlays.md index 4fda5744..95c6a8c2 100644 --- a/docs/files/overlays.md +++ b/docs/files/overlays.md @@ -1,6 +1,6 @@ # Overlay Files -Overlay Files holds information on how Plex Meta Manager should create Overlays. There are a large number of builders available to build Overlays, +Overlay Files holds information on how Kometa should create Overlays. There are a large number of builders available to build Overlays, ## Overview @@ -32,8 +32,8 @@ This specific example will target items in my library with a 4K resolution and w ``` 1. This must appear once and **only once** in any Overlay file - 2. This tells PMM to use text as the overlay rather than an image - 3. This is the criteria that PMM will use to define what should receive the overlay + 2. This tells Kometa to use text as the overlay rather than an image + 3. This is the criteria that Kometa will use to define what should receive the overlay Here is an example of how the Overlay will look @@ -56,7 +56,7 @@ I then call "MyOverlays.yml" in my [Configuration File](../config/overview.md) w ``` 1. This must match the name of a library in your Plex server - 2. `config` refers to the location that you mapped to `config` when following the PMM Installation Guides. + 2. `config` refers to the location that you mapped to `config` when following the Kometa Installation Guides. ???+ example "config.yml Example Collection File Addition" @@ -70,9 +70,9 @@ I then call "MyOverlays.yml" in my [Configuration File](../config/overview.md) w ``` 1. This must match the name of a library in your Plex server - 2. `config` refers to the location that you mapped to `config` when following the PMM Installation Guides. + 2. `config` refers to the location that you mapped to `config` when following the Kometa Installation Guides. -Whenever I execute Plex Meta Manager and the Movies library is run, MyOverlays.yml will run and my "Direct Play" overlay will appear on all items with a 4K resolution. +Whenever I execute Kometa and the Movies library is run, MyOverlays.yml will run and my "Direct Play" overlay will appear on all items with a 4K resolution. ## File Attributes @@ -84,7 +84,7 @@ Overlay Files can utilize the following top-level attributes | [`external_templates`](templates.md#external-templates) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple overlays | | [`overlays`](#overlay-attributes) | contains definitions of Overlays you wish to add to one or more libraries | -* Example Files can be found in the [Plex Meta Manager Configs Repository](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM) +* Example Files can be found in the [Kometa Community Configs Repository](https://github.com/Kometa-Team/Community-Configs) ## Overlay Understandings @@ -100,28 +100,28 @@ All overlays should be in a format that is supports transparency should it be re If an overlay is not 1000 x 1500 or 1920 x 1080 in size, you will need to use positional attributes to specify where on the base poster the Overlay should be. This is exampled in [Overview](#overview) -Although Overlays are modular in that you can pick and choose what you would like to apply, each overlay you want to apply **must** be executed in the same Plex Meta Manager run and should not be scheduled, this will result in overlays that are not scheduled to run being deleted. +Although Overlays are modular in that you can pick and choose what you would like to apply, each overlay you want to apply **must** be executed in the same Kometa run and should not be scheduled, this will result in overlays that are not scheduled to run being deleted. * For example, you cannot schedule a "4K Resolution" overlay to only apply on a Monday and a "Direct Play" overlay to only apply on a Tuesday. This will not work, both overlays must be scheduled to run at the same time. -Plex Meta Manager and Plex **will not** remove old Overlaid images from the Plex file structure or database when new updates are available. On large libraries, this can often result in Image Bloat. +Kometa and Plex **will not** remove old Overlaid images from the Plex file structure or database when new updates are available. On large libraries, this can often result in Image Bloat. - * We recommend you read more about this and the solution on the [Plex Image Cleanup](../pmm/scripts/image-cleanup.md) page. + * We recommend you read more about this and the solution on the [ImageMaid](../kometa/scripts/imagemaid.md) page. -There is an attribute called `reapply_overlays` which, when set to true, will force overlays to reapply even when it is not necessary to do so [overlays only update when something has changed, this bypasses that behaviour]. This will increase how long Plex Meta Manager takes to run and will also result in Image Bloat. +There is an attribute called `reapply_overlays` which, when set to true, will force overlays to reapply even when it is not necessary to do so [overlays only update when something has changed, this bypasses that behaviour]. This will increase how long Kometa takes to run and will also result in Image Bloat. - * Ensure `reapply_overlays` is set to `false` if you see it in your Configuration File. If it has previously been set to true we recommend using [Plex Image Cleanup](../pmm/scripts/image-cleanup.md) to get rid of the bloat. + * Ensure `reapply_overlays` is set to `false` if you see it in your Configuration File. If it has previously been set to true we recommend using [ImageMaid](../kometa/scripts/imagemaid.md) to get rid of the bloat. To remove all overlays from your library, add the [`remove_overlays` library attribute](../config/libraries.md#remove-overlays) set to `true`.** - * See the above note on Plex Meta Manager not removing the overlaid images, this is still true here. + * See the above note on Kometa not removing the overlaid images, this is still true here. ???+ danger "Important Notice" - Once you have applied overlays to your posters in Plex, it is highly recommended that you never change artwork on a thing directly in Plex again. PMM uses labels on the items in Plex to decide if an overlay has been applied, so if you change artwork behind PMM's back things can become confused and items can end up with double-overlaid posters. It's recommended to set new artwork using the asset directory, which will ensure that this doesn't happen. + Once you have applied overlays to your posters in Plex, it is highly recommended that you never change artwork on a thing directly in Plex again. Kometa uses labels on the items in Plex to decide if an overlay has been applied, so if you change artwork behind Kometa's back things can become confused and items can end up with double-overlaid posters. It's recommended to set new artwork using the asset directory, which will ensure that this doesn't happen. - **To change a single overlay original image either remove the `Overlay` shared label and update the Image in Plex or replace the image in the assets folder and then PMM will overlay the new image** + **To change a single overlay original image either remove the `Overlay` shared label and update the Image in Plex or replace the image in the assets folder and then Kometa will overlay the new image** ## Overlay Attributes @@ -135,7 +135,7 @@ Overlay Files can utilize the following top-level attributes | [`overlays`](#overlay-attributes) | contains definitions of overlays you wish to add | * `overlays` is required in order to run the Overlay File. -* Example Overlay Files can be found in the [Plex Meta Manager Configs Repository](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM) +* Example Overlay Files can be found in the [Kometa Community Configs Repository](https://github.com/Kometa-Team/Community-Configs) There are multiple types of attributes that can be utilized within an overlay: @@ -147,7 +147,7 @@ There are multiple types of attributes that can be utilized within an overlay: Below is a common Overlay File which will create an Overlay for all items which have a 4K resolution. -To get you started, Plex Meta Manager includes three files for Overlays - 4K, Dolby and HDR. +To get you started, Kometa includes three files for Overlays - 4K, Dolby and HDR. ```yaml overlays: @@ -161,7 +161,7 @@ overlays: I can then layer another Overlay for items which have HDR. -Plex Meta Manager will apply Overlays in the order they are defined in the file, so my HDR overlay appears on top of my 4K overlay in this scenario. +Kometa will apply Overlays in the order they are defined in the file, so my HDR overlay appears on top of my 4K overlay in this scenario. ```yaml overlays: @@ -182,38 +182,38 @@ overlays: The below attributes are also available for Overlay files, to give more granular control over how they function. -| Attribute | Description | Required | -|:---------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------:| -| `name` | Name of the overlay. | :fontawesome-solid-circle-check:{ .green } | -| `file` | Local location of the Overlay Image. | :fontawesome-solid-circle-xmark:{ .red } | -| `url` | URL of Overlay Image Online. | :fontawesome-solid-circle-xmark:{ .red } | -| `git` | Location in the [Configs Repo](https://github.com/meisnate12/Plex-Meta-Manager-Configs) of the Overlay Image. | :fontawesome-solid-circle-xmark:{ .red } | -| `repo` | Location in the [Custom Repo](../config/settings.md) of the Overlay Image. | :fontawesome-solid-circle-xmark:{ .red } | -| [`group`](#overlay-groups) | Name of the Grouping for this overlay. Only one overlay with the highest weight per group will be applied.<br>**`weight` is required when using `group`**<br>**Values:** group name | :fontawesome-solid-circle-xmark:{ .red } | -| [`queue`](#overlay-queues) | Name of the Queue for this overlay. Define `queue` positions using the `queues` attribute at the top level of an Overlay File. Overlay with the highest weight is applied to the first position and so on.<br>**`weight` is required when using `queue`**<br>**Values:** queue name | :fontawesome-solid-circle-xmark:{ .red } | -| `weight` | Weight of this overlay in its group or queue.<br>**`group` or `queue` is required when using `weight`**<br>**Values:** Integer 0 or greater | :fontawesome-solid-circle-xmark:{ .red } | -| `horizontal_offset` | Horizontal Offset of this overlay. Can be a %.<br>**`vertical_offset` is required when using `horizontal_offset`**<br>**Value:** Integer 0 or greater or 0%-100% | :fontawesome-solid-circle-xmark:{ .red } | -| `horizontal_align` | Horizontal Alignment of the overlay.<br>**Values:** `left`, `center`, `right` | :fontawesome-solid-circle-xmark:{ .red } | -| `vertical_offset` | Vertical Offset of this overlay. Can be a %.<br>**`horizontal_offset` is required when using `vertical_offset`**<br>**Value:** Integer 0 or greater or 0%-100% | :fontawesome-solid-circle-xmark:{ .red } | -| `vertical_align` | Vertical Alignment of the overlay.<br>**Values:** `top`, `center`, `bottom` | :fontawesome-solid-circle-xmark:{ .red } | -| `font` | System Font Filename or path to font file for the Text Overlay.<br>**Value:** System Font Filename or path to font file | :fontawesome-solid-circle-xmark:{ .red } | -| `font_style` | Font style for Variable Fonts. Only needed when using a Variable Font.<br>**Value:** Variable Font Style | :fontawesome-solid-circle-xmark:{ .red } | -| `font_size` | Font Size for the Text Overlay.<br>**Value:** Integer greater than 0 | :fontawesome-solid-circle-xmark:{ .red } | -| `font_color` | Font Color for the Text Overlay.<br>**Value:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`. | :fontawesome-solid-circle-xmark:{ .red } | -| `stroke_width` | Font Stroke Width for the Text Overlay.<br>**Value:** Integer greater than 0 | :fontawesome-solid-circle-xmark:{ .red } | -| `stroke_color` | Font Stroke Color for the Text Overlay.<br>**Value:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`. | :fontawesome-solid-circle-xmark:{ .red } | -| `back_color` | Backdrop Color for the Text Overlay.<br>**Value:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`. | :fontawesome-solid-circle-xmark:{ .red } | -| `back_width` | Backdrop Width for the Text Overlay. If `back_width` is not specified the Backdrop Sizes to the text<br>**`back_height` is required when using `back_width`**<br>**Value:** Integer greater than 0 | :fontawesome-solid-circle-xmark:{ .red } | -| `back_height` | Backdrop Height for the Text Overlay. If `back_height` is not specified the Backdrop Sizes to the text<br>**`back_width` is required when using `back_height`**<br>**Value:** Integer greater than 0 | :fontawesome-solid-circle-xmark:{ .red } | -| `back_align` | Alignment for the Text Overlay inside the backdrop. If `back_align` is not specified the Backdrop Centers the text<br>**`back_width` and `back_height` are required when using `back_align`**<br>**Values:** `left`, `right`, `center`, `top`, `bottom` | :fontawesome-solid-circle-xmark:{ .red } | -| `back_padding` | Backdrop Padding for the Text Overlay.<br>**Value:** Integer greater than 0 | :fontawesome-solid-circle-xmark:{ .red } | -| `back_radius` | Backdrop Radius for the Text Overlay.<br>**Value:** Integer greater than 0 | :fontawesome-solid-circle-xmark:{ .red } | -| `back_line_color` | Backdrop Line Color for the Text Overlay.<br>**Value:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`. | :fontawesome-solid-circle-xmark:{ .red } | -| `back_line_width` | Backdrop Line Width for the Text Overlay.<br>**Value:** Integer greater than 0 | :fontawesome-solid-circle-xmark:{ .red } | -| `addon_offset` | Text Addon Image Offset from the text.<br>**`addon_offset` Only works with text overlays**<br>**Value:** Integer 0 or greater | :fontawesome-solid-circle-xmark:{ .red } | -| `addon_position` | Text Addon Image Alignment in relation to the text.<br>**`addon_position` Only works with text overlays**<br>**Values:** `left`, `right`, `top`, `bottom` | :fontawesome-solid-circle-xmark:{ .red } | - -* If `url`, `git`, and `repo` are all not defined then PMM will look in your `config/overlays` folder for a `.png` file named the same as the `name` attribute. +| Attribute | Description | Required | +|:---------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------:| +| `name` | Name of the overlay. | :fontawesome-solid-circle-check:{ .green } | +| `file` | Local location of the Overlay Image. | :fontawesome-solid-circle-xmark:{ .red } | +| `url` | URL of Overlay Image Online. | :fontawesome-solid-circle-xmark:{ .red } | +| `git` | Location in the [Configs Repo](https://github.com/Kometa-Team/Community-Configs) of the Overlay Image. | :fontawesome-solid-circle-xmark:{ .red } | +| `repo` | Location in the [Custom Repo](../config/settings.md) of the Overlay Image. | :fontawesome-solid-circle-xmark:{ .red } | +| [`group`](#overlay-groups) | Name of the Grouping for this overlay. Only one overlay with the highest weight per group will be applied.<br>**`weight` is required when using `group`**<br>**Values:** group name | :fontawesome-solid-circle-xmark:{ .red } | +| [`queue`](#overlay-queues) | Name of the Queue for this overlay. Define `queue` positions using the `queues` attribute at the top level of an Overlay File. Overlay with the highest weight is applied to the first position and so on.<br>**`weight` is required when using `queue`**<br>**Values:** queue name | :fontawesome-solid-circle-xmark:{ .red } | +| `weight` | Weight of this overlay in its group or queue.<br>**`group` or `queue` is required when using `weight`**<br>**Values:** Integer 0 or greater | :fontawesome-solid-circle-xmark:{ .red } | +| `horizontal_offset` | Horizontal Offset of this overlay. Can be a %.<br>**`vertical_offset` is required when using `horizontal_offset`**<br>**Value:** Integer 0 or greater or 0%-100% | :fontawesome-solid-circle-xmark:{ .red } | +| `horizontal_align` | Horizontal Alignment of the overlay.<br>**Values:** `left`, `center`, `right` | :fontawesome-solid-circle-xmark:{ .red } | +| `vertical_offset` | Vertical Offset of this overlay. Can be a %.<br>**`horizontal_offset` is required when using `vertical_offset`**<br>**Value:** Integer 0 or greater or 0%-100% | :fontawesome-solid-circle-xmark:{ .red } | +| `vertical_align` | Vertical Alignment of the overlay.<br>**Values:** `top`, `center`, `bottom` | :fontawesome-solid-circle-xmark:{ .red } | +| `font` | System Font Filename or path to font file for the Text Overlay.<br>**Value:** System Font Filename or path to font file | :fontawesome-solid-circle-xmark:{ .red } | +| `font_style` | Font style for Variable Fonts. Only needed when using a Variable Font.<br>**Value:** Variable Font Style | :fontawesome-solid-circle-xmark:{ .red } | +| `font_size` | Font Size for the Text Overlay.<br>**Value:** Integer greater than 0 | :fontawesome-solid-circle-xmark:{ .red } | +| `font_color` | Font Color for the Text Overlay.<br>**Value:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`. | :fontawesome-solid-circle-xmark:{ .red } | +| `stroke_width` | Font Stroke Width for the Text Overlay.<br>**Value:** Integer greater than 0 | :fontawesome-solid-circle-xmark:{ .red } | +| `stroke_color` | Font Stroke Color for the Text Overlay.<br>**Value:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`. | :fontawesome-solid-circle-xmark:{ .red } | +| `back_color` | Backdrop Color for the Text Overlay.<br>**Value:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`. | :fontawesome-solid-circle-xmark:{ .red } | +| `back_width` | Backdrop Width for the Text Overlay. If `back_width` is not specified the Backdrop Sizes to the text<br>**`back_height` is required when using `back_width`**<br>**Value:** Integer greater than 0 | :fontawesome-solid-circle-xmark:{ .red } | +| `back_height` | Backdrop Height for the Text Overlay. If `back_height` is not specified the Backdrop Sizes to the text<br>**`back_width` is required when using `back_height`**<br>**Value:** Integer greater than 0 | :fontawesome-solid-circle-xmark:{ .red } | +| `back_align` | Alignment for the Text Overlay inside the backdrop. If `back_align` is not specified the Backdrop Centers the text<br>**`back_width` and `back_height` are required when using `back_align`**<br>**Values:** `left`, `right`, `center`, `top`, `bottom` | :fontawesome-solid-circle-xmark:{ .red } | +| `back_padding` | Backdrop Padding for the Text Overlay.<br>**Value:** Integer greater than 0 | :fontawesome-solid-circle-xmark:{ .red } | +| `back_radius` | Backdrop Radius for the Text Overlay.<br>**Value:** Integer greater than 0 | :fontawesome-solid-circle-xmark:{ .red } | +| `back_line_color` | Backdrop Line Color for the Text Overlay.<br>**Value:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`. | :fontawesome-solid-circle-xmark:{ .red } | +| `back_line_width` | Backdrop Line Width for the Text Overlay.<br>**Value:** Integer greater than 0 | :fontawesome-solid-circle-xmark:{ .red } | +| `addon_offset` | Text Addon Image Offset from the text.<br>**`addon_offset` Only works with text overlays**<br>**Value:** Integer 0 or greater | :fontawesome-solid-circle-xmark:{ .red } | +| `addon_position` | Text Addon Image Alignment in relation to the text.<br>**`addon_position` Only works with text overlays**<br>**Values:** `left`, `right`, `top`, `bottom` | :fontawesome-solid-circle-xmark:{ .red } | + +* If `url`, `git`, and `repo` are all not defined then Kometa will look in your `config/overlays` folder for a `.png` file named the same as the `name` attribute. ### Positional Image Overlays @@ -222,7 +222,7 @@ Positional overlays can be of any size and use `horizontal_offset`, `horizontal_ ???+ tip - This overlay example uses one of the [PMM Default Overlay](../defaults/overlays.md) images, which isn't necessary but is used just for this example. + This overlay example uses one of the [Kometa Default Overlay](../defaults/overlays.md) images, which isn't necessary but is used just for this example. ```yaml overlays: @@ -230,7 +230,7 @@ overlays: imdb_chart: top_movies overlay: name: IMDB-Top-250 - pmm: ribbon/yellow/imdb.png + default: ribbon/yellow/imdb.png horizontal_offset: 0 horizontal_align: right vertical_offset: 0 @@ -289,7 +289,7 @@ You can control the backdrop of the text using the various `back_*` attributes. The `horizontal_offset` and `vertical_offset` overlay attributes are required when using Text Overlays. -PMM includes multiple fonts in the [`fonts` folder](https://github.com/meisnate12/Plex-Meta-Manager/tree/master/fonts) which can be called using `fonts/fontname.ttf` +Kometa includes multiple fonts in the [`fonts` folder](https://github.com/Kometa-Team/Kometa/tree/master/fonts) which can be called using `fonts/fontname.ttf` ```yaml overlays: @@ -509,14 +509,14 @@ Use `addon_position` to control which side of the text the image will be located ???+ tip - This overlay example uses one of the [PMM Default Overlay](../defaults/overlays.md) images, which isn't necessary but is used just for this example. + This overlay example uses one of the [Kometa Default Overlay](../defaults/overlays.md) images, which isn't necessary but is used just for this example. ```yaml overlays: rating_with_logo: overlay: name: text(audience_rating) - pmm: rating/IMDb.png + default: rating/IMDb.png horizontal_offset: 15 horizontal_align: left vertical_offset: 15 @@ -546,7 +546,7 @@ overlays: Dual-Audio: overlay: name: Dual-Audio - pmm: images/Dual-Audio + default: images/Dual-Audio group: audio_language weight: 10 horizontal_offset: 0 @@ -559,7 +559,7 @@ overlays: Multi-Audio: overlay: name: Multi-Audio - pmm: images/Multi-Audio + default: images/Multi-Audio group: audio_language weight: 20 horizontal_offset: 0 @@ -659,7 +659,7 @@ overlays: HDR: overlay: name: HDR - pmm: HDR + default: HDR plex_search: all: hdr: true diff --git a/docs/files/overview.md b/docs/files/overview.md index cc7541ed..4f901115 100644 --- a/docs/files/overview.md +++ b/docs/files/overview.md @@ -12,7 +12,7 @@ There are a few different types of attributes that can be used in any given Coll ### Builders -[Builders](builders/overview.md) are attributes placed at the top level of the definition that tell PMM what items +[Builders](builders/overview.md) are attributes placed at the top level of the definition that tell Kometa what items belong in a collection/overlay/playlist. Multiple builders can be used in one definition. These could come from a variety of sources including but not limited to: @@ -66,7 +66,7 @@ Running filters are often slower than builders so whenever possible use only bui ### Settings -[Settings](settings.md) are attributes placed at the top level of the definition that tells PMM how to run the +[Settings](settings.md) are attributes placed at the top level of the definition that tells Kometa how to run the definition. Each setting will affect how the definition is run or shown in the log. ???+ example "Setting Example" @@ -86,7 +86,7 @@ definition. Each setting will affect how the definition is run or shown in the l ### Radarr/Sonarr Settings -[Radarr/Sonarr Settings](arr.md) are attributes placed at the top level of the definition that tells PMM how +[Radarr/Sonarr Settings](arr.md) are attributes placed at the top level of the definition that tells Kometa how Radarr/Sonarr is handled in this specific definition. ???+ example "Setting Example" @@ -106,7 +106,7 @@ Radarr/Sonarr is handled in this specific definition. ### Collection/Playlist Metadata Updates -[Updates](updates.md) are attributes placed at the top level of the definition that tells PMM Metadata Changes for the +[Updates](updates.md) are attributes placed at the top level of the definition that tells Kometa Metadata Changes for the Collection/Playlist. ???+ example "Collection/Playlist Metadata Update Example" @@ -122,7 +122,7 @@ Collection/Playlist. ### Item Metadata Updates -[Item Updates](item_updates.md) are attributes placed at the top level of the definition that tells PMM Metadata Changes +[Item Updates](item_updates.md) are attributes placed at the top level of the definition that tells Kometa Metadata Changes for every item found in the Collection/Playlist. ???+ example "Item Metadata Update Example" diff --git a/docs/files/playlists.md b/docs/files/playlists.md index 44db7198..59cb3382 100644 --- a/docs/files/playlists.md +++ b/docs/files/playlists.md @@ -10,8 +10,8 @@ be used as a backup for these in the event of a restore requirement. Playlists are defined in one or more Playlist files that are mapped in the [Playlist Files Attribute](../config/playlists.md) within the Configuration File. -You can use the [`playlist_report` setting](../config/settings.md) to get a list of your playlists printed out in your -log. +You can use the [`playlist_report` setting](../config/settings.md#playlist-report) to get a list of your playlists +printed out in your log. ## Example @@ -78,11 +78,11 @@ This file would then be defined in my `config.yml` file as a `playlist_files` it 1. Note that Playlist files are not called within the `libraries` section, they are defined at the root identation as you can see here - 2. `config` refers to the location that you mapped to `config` when following the PMM Installation Guides. + 2. `config` refers to the location that you mapped to `config` when following the Kometa Installation Guides. ## Playlist Attributes -Plex Meta Manager can automatically build and update playlists defined within the `playlists` attribute. +Kometa can automatically build and update playlists defined within the `playlists` attribute. These are the attributes which can be utilized within the Playlist File: @@ -94,7 +94,7 @@ These are the attributes which can be utilized within the Playlist File: * `playlists` is required in order to run the Playlist File. * You can find example Playlist Files in the -[Plex Meta Manager Configs Repository](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM) +[Kometa Community Configs Repository](https://github.com/Kometa-Team/Community-Configs) * Plex does not support the "Continue Watching" feature for playlists, you can [vote for the feature here](https://forums.plex.tv/t/playlists-remember-position-for-subsequent-resume/84866/39) diff --git a/docs/files/settings.md b/docs/files/settings.md index 70fab992..0ec54db9 100644 --- a/docs/files/settings.md +++ b/docs/files/settings.md @@ -4,7 +4,7 @@ search: --- # Definition Settings -All the following attributes serve various functions as how the definition functions inside of Plex Meta Manager. +All the following attributes serve various functions as how the definition functions inside of Kometa. | Attribute | Description & Values | |:-----------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -31,8 +31,8 @@ All the following attributes serve various functions as how the definition funct | `save_report` | **Description:** definition level `save_report` toggle.<br>**Default:** `save_report` [settings value](../config/settings.md) in the Configuration File<br>**Values:** `true` or `false` | | `ignore_ids` | **Description:** definition level `ignore_ids` which is combined with the library and global `ignore_ids`.<br>**Default:** `ignore_ids` [settings value](../config/settings.md) in the Configuration File<br>**Values:** List or comma-separated String of TMDb/TVDb IDs | | `ignore_imdb_ids` | **Description:** definition level `ignore_imdb_ids` which is combined with the library and global `ignore_imdb_ids`.<br>**Default:** `ignore_imdb_ids` [settings value](../config/settings.md) in the Configuration File<br>**Values:** List or comma-separated String of IMDb IDs | -| `name_mapping` | **Description:** Used to specify the folder name in the [Image Assets Directory](../pmm/guides/assets.md) i.e. if your definition name contains characters that are not allowed in file paths (i.e. for windows `<`, `>`, `:`, `"`, `/`, `\`, `?`, `*` cannot be in the file path), but you want them in your name you can this to specify the name in the file system.<br>**Values:** Any String | -| `test` | **Description:** When running in Test Mode (`--run-tests` [option](../pmm/environmental.md)) only definitions with `test: true` will be run.<br>**Default:** `false`<br>**Values:** `true` or `false` | +| `name_mapping` | **Description:** Used to specify the folder name in the [Image Assets Directory](../kometa/guides/assets.md) i.e. if your definition name contains characters that are not allowed in file paths (i.e. for windows `<`, `>`, `:`, `"`, `/`, `\`, `?`, `*` cannot be in the file path), but you want them in your name you can this to specify the name in the file system.<br>**Values:** Any String | +| `test` | **Description:** When running in Test Mode (`--run-tests` [option](../kometa/environmental.md)) only definitions with `test: true` will be run.<br>**Default:** `false`<br>**Values:** `true` or `false` | | `tmdb_birthday` | **Description:** Controls if the Definition is run based on `tmdb_person`'s Birthday. Has 3 possible attributes `this_month`, `before` and `after`.<br>**Values:**<table class="clearTable"><tr><td>`this_month`</td><td>Run's if Birthday is in current Month</td><td>`true`/`false`</td></tr><tr><td>`before`</td><td>Run if X Number of Days before the Birthday</td><td>Number 0 or greater</td></tr><tr><td>`after`</td><td>Run if X Number of Days after the Birthday</td><td>Number 0 or greater</td></tr></table> | | `changes_webhooks` | **Description:** Used to specify a definition changes webhook for just this definition.<br>**Values:** List of webhooks | | `sync_to_trakt_list` | **Description:** Used to specify a trakt list you want the definition synced to.<br>**Values:** Trakt List Slug you want to sync to | diff --git a/docs/files/templates.md b/docs/files/templates.md index a4392e18..ea2214aa 100644 --- a/docs/files/templates.md +++ b/docs/files/templates.md @@ -383,10 +383,10 @@ collections: ``` 1. This is wrapped in quotes because it contains a character [`!`] which has -[syntactic meaning in YAML files](../pmm/yaml.md#string-literals). This "quoting special characters" is a general YAML +[syntactic meaning in YAML files](../kometa/yaml.md#string-literals). This "quoting special characters" is a general YAML requirement, not something specific to `sort_title`. 2. This is wrapped in quotes because it contains a character [`!`] which has -[syntactic meaning in YAML files](../pmm/yaml.md#string-literals). This "quoting special characters" is a general YAML requirement, not something +[syntactic meaning in YAML files](../kometa/yaml.md#string-literals). This "quoting special characters" is a general YAML requirement, not something specific to `sort_title`. You can continue adding definitions this way, but there's a lot of repetition there. Both of these collections have the @@ -495,5 +495,5 @@ collections: ``` Check out the example files in the -[Plex Meta Manager Configs Repository](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/meisnate12) +[Kometa Community Configs Repository](https://github.com/Kometa-Team/Community-Configs/tree/master/meisnate12) for more uses and examples. diff --git a/docs/files/updates.md b/docs/files/updates.md index 0858c2f5..bc0a2784 100644 --- a/docs/files/updates.md +++ b/docs/files/updates.md @@ -47,7 +47,7 @@ All the following attributes update the poster of the collection/playlist from v **All of these details work with Playlists.** -If no poster is specified the script will look in the library's [Image Asset Directories](../pmm/guides/assets.md) for a +If no poster is specified the script will look in the library's [Image Asset Directories](../kometa/guides/assets.md) for a folder named either the collection/playlist name or the `name_mapping` if specified and look for a `poster.ext` file in that folder (replacing .ext with the image extension). @@ -67,7 +67,7 @@ All the following attributes update the background of the collection/playlist fr **All of these details work with Playlists.** -If no background is specified the script will look in the library's [Image Asset Directories](../pmm/guides/assets.md) +If no background is specified the script will look in the library's [Image Asset Directories](../kometa/guides/assets.md) for a folder named either the collection/playlist name or the `name_mapping` if specified and look for a `background.ext` file in that folder (replacing .ext with the image extension). diff --git a/docs/index.md b/docs/index.md index c9d2e2cd..0805aa42 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,103 +1,142 @@ +--- +title: Home +--- +# + +<style> + .md-typeset h1, + .md-content__button { + display: none; + } +</style> + <center> -# ![Logo](assets/logo-full.webp) - -[![GitHub release (latest by date)](https://img.shields.io/github/v/release/meisnate12/Plex-Meta-Manager?style=plastic)](https://github.com/meisnate12/Plex-Meta-Manager/releases) -[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/meisnate12/plex-meta-manager?label=docker&sort=semver&style=plastic)](https://hub.docker.com/r/meisnate12/plex-meta-manager) -[![Docker Pulls](https://img.shields.io/docker/pulls/meisnate12/plex-meta-manager?style=plastic)](https://hub.docker.com/r/meisnate12/plex-meta-manager) -[![Develop GitHub commits since latest stable release (by SemVer)](https://img.shields.io/github/commits-since/meisnate12/plex-meta-manager/latest/develop?label=Commits%20in%20Develop&style=plastic)](https://github.com/meisnate12/Plex-Meta-Manager/tree/develop) -[![Nightly GitHub commits since latest stable release (by SemVer)](https://img.shields.io/github/commits-since/meisnate12/plex-meta-manager/latest/nightly?label=Commits%20in%20Nightly&style=plastic)](https://github.com/meisnate12/Plex-Meta-Manager/tree/nightly) - -[![Discord](https://img.shields.io/discord/822460010649878528?color=%2300bc8c&label=Discord&style=plastic)](https://metamanager.wiki/en/latest/discord/) -[![Reddit](https://img.shields.io/badge/%2Fr%2Fplexmetamanager-e05d44?style=plastic&logo=Reddit&logoColor=white&labelColor=0e8a6a&color=00bc8c)](https://www.reddit.com/r/PlexMetaManager/) -[![Wiki](https://img.shields.io/readthedocs/plex-meta-manager?color=%2300bc8c&style=plastic)](https://metamanager.wiki) -[![Translations](https://img.shields.io/weblate/progress/plex-meta-manager?color=00bc8c&server=https%3A%2F%2Ftranslations.metamanager.wiki&style=plastic)](https://translations.metamanager.wiki/projects/plex-meta-manager/#languages) -[![GitHub Sponsors](https://img.shields.io/github/sponsors/meisnate12?color=%238a2be2&style=plastic)](https://github.com/sponsors/meisnate12) -[![Sponsor or Donate](https://img.shields.io/badge/-Sponsor%2FDonate-blueviolet?style=plastic)](https://github.com/sponsors/meisnate12) -[![Feature Requests](https://img.shields.io/badge/Feature%20Requests-blueviolet?style=plastic)](https://features.metamanager.wiki/) +![Logo](assets/logo-full.png) + +[![GitHub release (latest by date)](https://img.shields.io/github/v/release/Kometa-Team/Kometa?style=plastic)](https://github.com/Kometa-Team/Kometa/releases) +[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/kometateam/kometa?label=docker&sort=semver&style=plastic)](https://hub.docker.com/r/kometateam/kometa) +[![Docker Pulls](https://img.shields.io/docker/pulls/kometateam/kometa?style=plastic)](https://hub.docker.com/r/kometateam/kometa) +[![Develop GitHub commits since latest stable release (by SemVer)](https://img.shields.io/github/commits-since/Kometa-Team/Kometa/latest/develop?label=Commits%20in%20Develop&style=plastic)](https://github.com/Kometa-Team/Kometa/tree/develop) +[![Nightly GitHub commits since latest stable release (by SemVer)](https://img.shields.io/github/commits-since/Kometa-Team/Kometa/latest/nightly?label=Commits%20in%20Nightly&style=plastic)](https://github.com/Kometa-Team/Kometa/tree/nightly) + +[![Discord](https://img.shields.io/discord/822460010649878528?color=%2300bc8c&label=Discord&style=plastic)](https://kometa.wiki/en/latest/discord/) +[![Reddit](https://img.shields.io/badge/%2Fr%2Fkometa-e05d44?style=plastic&logo=Reddit&logoColor=white&labelColor=5d5d5d&color=00bc8c)](https://www.reddit.com/r/Kometa/) +[![Wiki](https://img.shields.io/readthedocs/kometa?color=%2300bc8c&style=plastic)](https://kometa.wiki) +[![Translations](https://img.shields.io/weblate/progress/kometa?color=00bc8c&server=https%3A%2F%2Ftranslations.kometa.wiki&style=plastic)](https://translations.kometa.wiki/projects/kometa/#languages) +[![GitHub Sponsors](https://img.shields.io/github/sponsors/meisnate12?color=00bc8c&style=plastic)](https://github.com/sponsors/meisnate12) +[![Sponsor or Donate](https://img.shields.io/badge/-Sponsor%2FDonate-00bc8c?style=plastic)](https://github.com/sponsors/meisnate12) +[![Feature Requests](https://img.shields.io/badge/Feature%20Requests-00bc8c?style=plastic)](https://features.kometa.wiki/) </center> -Plex Meta Manager is a powerful tool designed to give you complete control over your media libraries. With Plex Meta Manager, you can take your customization to the next level, with granular control over metadata, collections, overlays, and much more. -Transform your media library with Plex Meta Manager and discover its full potential! Connect to third-party services like TMDb, Trakt, and IMDb, among others, to create one-of-a-kind collections, overlays and more. Your media library will stand out and be tailored to your specific needs. +Kometa (formerly known as Plex Meta Manager) is a powerful tool designed to give you complete control over your media libraries. With Kometa, you can take your customization to the next level, with granular control over metadata, collections, overlays, and much more. + +Transform your media library with Kometa and discover its full potential! Connect to third-party services like TMDb, Trakt, and IMDb, among others, to create one-of-a-kind collections, overlays and more. Your media library will stand out and be tailored to your specific needs. + +## What Can Kometa Do? + + +<div class="grid cards" markdown> + +- :octicons-versions-24:{ .lg .middle } __Overhaul Your Media Libraries__ + + --- + + Elevate your library with beautifully crafted metadata - customize artwork, titles, summaries, and more to create a stunning library. + +- :octicons-sliders-16:{ .lg .middle } __Kometa Defaults__ + + --- + + Take advantage of pre-made modular Collections & Overlays to reduce the manual effort and get to the good stuff with less effort! + +- :material-connection:{ .lg .middle } __Third-Party Integrations__ -## What Can Plex Meta Manager Do? + --- -:octicons-versions-24:{ .lg .middle } __Overhaul Your Media Libraries__ + Harness the power of Trakt, TMDb, IMDb and more to create collections and overlays! -- Elevate your library with beautifully crafted metadata - customize artwork, titles, summaries, and more to create a stunning library. + Integrate with Sonarr and Radarr to automate your library growth. -:octicons-sliders-16:{ .lg .middle } __PMM Defaults__ +- :material-tools:{ .lg .middle } __Library Operations__ -- Take advantage of pre-made modular Collections & Overlays to reduce the manual effort and get to the good stuff with less effort! + --- -:material-connection:{ .lg .middle } __Third-Party Integrations__ + Use operations to overhaul aspects of your library -- Harness the power of Trakt, TMDb, IMDb and more to create collections and overlays! -- Integrate with Sonarr and Radarr to automate your library growth. + Replace ratings with your preferred source, fetch new posters from TMDb, backup your metadata to a file and more! + + +- :material-star-face:{ .lg .middle } __And More!__ + + --- + + We're constantly working on new features to take your library management experience to the next level. + + Consider sponsoring the project to allow us to continue building great features for you! + +</div> -:material-star-face:{ .lg .middle } __And More!__ -- We're constantly working on new features to take your library management experience to the next level. -- Consider sponsoring the project to allow us to continue building great features for you! ## Demo Video -The below YouTube video has been created by one of our community members to showcase some of the things that Plex Meta Manager can do for you. +The below YouTube video has been created by one of our community members to showcase some of the things that Kometa can do for you. -<iframe width="840" height="472" src="https://www.youtube.com/embed/nTfCUtKWTYI?si=PUvELjmqFUu4p9yk" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe> +<iframe width="840" height="472" src="https://www.youtube.com/embed/nTfCUtKWTYI?si=PUvELjmqFUu4p9yk" title="Kometa Demo Video" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe> -## Example Plex Meta Manager Libraries +## Example Kometa Libraries -Here are some examples of the things you can achieve using Plex Meta Manager! +Here are some examples of the things you can achieve using Kometa! -**Example Movie Collections using the [Plex Meta Manager Defaults](defaults/collections.md)** (click to enlarge): +**Example Movie Collections using the [Kometa Defaults](defaults/collections.md)** (click to enlarge): ![Movie Collection Preview](images/movie-collection-preview.png){width="600"} -**Example Show Overlays using the [Plex Meta Manager Defaults](defaults/overlays.md)** (click to enlarge): +**Example Show Overlays using the [Kometa Defaults](defaults/overlays.md)** (click to enlarge): ![Show Library Preview](images/show-library-preview.png){ width="600" } -## Plex Meta Manager Defaults +## Kometa Defaults -Want your library to look like the above images? With the [PMM Defaults](defaults/guide.md) you can! These powerful and modular files were designed by the Plex Meta Manager team to make it simple to create a personalized, one-of-a-kind media collection without the hassle of manually defining each one. +Want your library to look like the above images? With the [Kometa Defaults](defaults/guide.md) you can! These powerful and modular files were designed by the Kometa team to make it simple to create a personalized, one-of-a-kind media collection without the hassle of manually defining each one. -Want to see what the community has to offer? Check out the [Plex Meta Manager Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs) repository on GitHub to see user-submitted configuration files, or even add your own to the mix! +Want to see what the community has to offer? Check out the [Kometa Community Configs](https://github.com/Kometa-Team/Community-Configs) repository on GitHub to see user-submitted configuration files, or even add your own to the mix! -With Plex Meta Manager, you can also manage metadata for all your media types, from movies and shows to music and more. And since your metadata is managed outside your libraries, you'll never have to worry about losing your customizations in the event of a media server database loss, you can simply reapply them! It is also easy to move your customizations between servers if you need to. +With Kometa, you can also manage metadata for all your media types, from movies and shows to music and more. And since your metadata is managed outside your libraries, you'll never have to worry about losing your customizations in the event of a media server database loss, you can simply reapply them! It is also easy to move your customizations between servers if you need to. ## Getting Started -To get started with Plex Meta Manager, follow these simple steps: +To get started with Kometa, follow these simple steps: -1. Install Plex Meta Manager on your device. You can find the installation instructions for a variety of platforms [here](pmm/install/overview.md). +1. Install Kometa on your device. You can find the installation instructions for a variety of platforms [here](kometa/install/overview.md). -2. Once you have installed Plex Meta Manager, create your [Configuration File](config/overview.md). This file contains important information such as URLs and credentials needed to connect to services like Plex and TMDb +2. Once you have installed Kometa, create your [Configuration File](config/overview.md). This file contains important information such as URLs and credentials needed to connect to services like Plex and TMDb -3. After creating the Configuration File, you can start updating Metadata and building automatic Collections by creating a [Collection File](files/collections.md) for each Library you want to work with. If you'd rather use some of our pre-made Collection Files, take a look at the [Plex Meta Manager Defaults](defaults/guide.md) +3. After creating the Configuration File, you can start updating Metadata and building automatic Collections by creating a [Collection File](files/collections.md) for each Library you want to work with. If you'd rather use some of our pre-made Collection Files, take a look at the [Kometa Defaults](defaults/guide.md) -4. Finally, check out the [Wiki](https://metamanager.wiki/), you'll find new and exciting ways to truly unlock the potential of your libraries. +4. Finally, check out the [Wiki](https://kometa.wiki/), you'll find new and exciting ways to truly unlock the potential of your libraries. ## Step-by-Step Guides -If you're a beginner to the concepts of Python, Git and/or Plex Meta Manager and find the above steps challenging, don't worry. We've got some step-by-step guides that can help you get started. These guides will take you through the process of installing Plex Meta Manager, creating your Configuration File and getting some basic Collections up and running. +If you're a beginner to the concepts of Python, Git and/or Kometa and find the above steps challenging, don't worry. We've got some step-by-step guides that can help you get started. These guides will take you through the process of installing Kometa, creating your Configuration File and getting some basic Collections up and running. For those who need full installation walkthroughs, please refer to the following walkthrough guides: - * [Local Walkthrough](pmm/install/local.md) - follow this if you are running the script directly on Windows, OS X, or Linux - * [Docker Walkthrough](pmm/install/docker.md) - this discusses using Docker at the command line + * [Local Walkthrough](kometa/install/local.md) - follow this if you are running the script directly on Windows, OS X, or Linux + * [Docker Walkthrough](kometa/install/docker.md) - this discusses using Docker at the command line If you are using unRAID, Kubernetes, QNAP, or Synology refer to the following basic guide to Docker container setup for each system: -**this doesn't cover the PMM setup specifics found in the guides above with regard to creating the config file and collection file, so you may want to go through the [Docker Walkthrough](pmm/install/docker.md) first on your computer to gain that understanding.** +**this doesn't cover the Kometa setup specifics found in the guides above with regard to creating the config file and collection file, so you may want to go through the [Docker Walkthrough](kometa/install/docker.md) first on your computer to gain that understanding.** - * [unRAID Walkthrough](pmm/install/unraid.md) - * [Kubernetes Walkthrough](pmm/install/kubernetes.md) - * [QNAP Walkthrough](pmm/install/qnap.md) - * [Synology Walkthrough](pmm/install/synology.md) + * [unRAID Walkthrough](kometa/install/unraid.md) + * [Kubernetes Walkthrough](kometa/install/kubernetes.md) + * [QNAP Walkthrough](kometa/install/qnap.md) + * [Synology Walkthrough](kometa/install/synology.md) ## Example Usage -Plex Meta Manager puts you in control of your media library by letting you create custom Collections that make discovering and organizing your content a breeze. With powerful search and filtering options, you can build Collections based on popular builders like TMDb, IMDb, Trakt, and many more. +Kometa puts you in control of your media library by letting you create custom Collections that make discovering and organizing your content a breeze. With powerful search and filtering options, you can build Collections based on popular builders like TMDb, IMDb, Trakt, and many more. Imagine having Collections like these at your fingertips: @@ -109,31 +148,31 @@ Imagine having Collections like these at your fingertips: * Actors * Decades -Plex Meta Manager gives you endless possibilities to curate and organize your media library any way you want. Create custom Collections and Overlays that fit your unique preferences and make discovering your content effortless. +Kometa gives you endless possibilities to curate and organize your media library any way you want. Create custom Collections and Overlays that fit your unique preferences and make discovering your content effortless. -But if you don't want to spend time manually creating Collections and Overlays, we've got you covered. Check out the [PMM Defaults](defaults/guide.md) - a handcrafted selection of tried-and-tested Collections and Overlays made by the Plex Meta Manager team. +But if you don't want to spend time manually creating Collections and Overlays, we've got you covered. Check out the [Kometa Defaults](defaults/guide.md) - a handcrafted selection of tried-and-tested Collections and Overlays made by the Kometa team. -## Develop & Nightly Branches +## Alternate Branches -The Develop and Nightly branches are "beta" versions of Plex Meta Manager that are updated more frequently than the stable version (Master branch). These branches are where bug fixes, new features, and other changes are added before being released to the Master branch. +The Develop and Nightly branches are "beta" versions of Kometa that are updated more frequently than the stable version (Master branch). These branches are where bug fixes, new features, and other changes are added before being released to the Master branch. -However, these branches (especially Nightly) are recommended for more technical users who don't mind updating frequently to get the latest changes. Keep in mind that these beta branches may have bugs or other issues that could cause problems with Plex Meta Manager or your media server. So, if you're not comfortable with technical issues, it's best to stick with the Master branch. +However, these branches (especially Nightly) are recommended for more technical users who don't mind updating frequently to get the latest changes. Keep in mind that these beta branches may have bugs or other issues that could cause problems with Kometa or your media server. So, if you're not comfortable with technical issues, it's best to stick with the Master branch. ??? "Develop Branch (click to expand)" - [![Develop GitHub commits since latest stable release (by SemVer)](https://img.shields.io/github/commits-since/meisnate12/plex-meta-manager/latest/develop?label=Commits%20in%20Develop&style=plastic)](https://github.com/meisnate12/Plex-Meta-Manager/tree/develop) + [![Develop GitHub commits since latest stable release (by SemVer)](https://img.shields.io/github/commits-since/Kometa-Team/Kometa/latest/develop?label=Commits%20in%20Develop&style=plastic)](https://github.com/Kometa-Team/Kometa/tree/develop) - The [develop](https://github.com/meisnate12/Plex-Meta-Manager/tree/develop) branch has the most updated **documented** fixes and enhancements to Plex Meta Manager. This version is tested and documented to some degree, but it is still an active Develop branch, so there may be rough edges. + The [develop](https://github.com/Kometa-Team/Kometa/tree/develop) branch has the most updated **documented** fixes and enhancements to Kometa. This version is tested and documented to some degree, but it is still an active Develop branch, so there may be rough edges. Switching to `develop`: === "Running in Docker" Add ":develop" to the image name in your run command or configuration: ``` - meisnate12/plex-meta-manager:develop + kometateam/kometa:develop ``` === "Running on the Host" - In the directory where you cloned PMM: + In the directory where you cloned Kometa: ```bash git checkout develop ``` @@ -141,27 +180,26 @@ However, these branches (especially Nightly) are recommended for more technical ```bash git checkout master ``` - - If switching to the develop branch, it is recommended to also use the [develop branch of the wiki](https://metamanager.wiki/en/develop/), which documents any changes made from the Master branch. + If switching to the develop branch, it is recommended to also use the [develop branch of the wiki](https://kometa.wiki/en/develop/), which documents any changes made from the Master branch. ??? warning "Nightly Branch (click to expand)" - [![Nightly GitHub commits since latest stable release (by SemVer)](https://img.shields.io/github/commits-since/meisnate12/plex-meta-manager/latest/nightly?label=Commits%20in%20Nightly&style=plastic)](https://github.com/meisnate12/Plex-Meta-Manager/tree/nightly) + [![Nightly GitHub commits since latest stable release (by SemVer)](https://img.shields.io/github/commits-since/Kometa-Team/Kometa/latest/nightly?label=Commits%20in%20Nightly&style=plastic)](https://github.com/Kometa-Team/Kometa/tree/nightly) **This branch will have squashed commits which can cause `git pull`/`git fetch` to error you can use `git reset origin/nightly --hard` to fix the branch.** - The [nightly](https://github.com/meisnate12/Plex-Meta-Manager/tree/nightly) branch has the absolute latest version of Plex Meta Manager, but it could easily break, there is no guarantee that it even works, and any new features will not be documented until they have progressed enough to reach the develop branch. + The [nightly](https://github.com/Kometa-Team/Kometa/tree/nightly) branch has the absolute latest version of Kometa, but it could easily break, there is no guarantee that it even works, and any new features will not be documented until they have progressed enough to reach the develop branch. Switching to `nightly`: === "Running in Docker" Add ":nightly" to the image name in your run command or configuration: ``` - meisnate12/plex-meta-manager:nightly + kometateam/kometa:nightly ``` === "Running on the Host" - In the directory where you cloned PMM: + In the directory where you cloned Kometa: ```bash git checkout nightly ``` @@ -170,25 +208,33 @@ However, these branches (especially Nightly) are recommended for more technical git checkout master ``` - As this branch is subject to extreme change, there is no promise of the feature being documented in the [nightly](https://metamanager.wiki/en/nightly/) branch of the wiki and all discussions relating to changes made in the nightly branch will be held within the [Plex Meta Manager Discord Server](https://metamanager.wiki/en/latest/discord/). + As this branch is subject to extreme change, there is no promise of the feature being documented in the [nightly](https://kometa.wiki/en/nightly/) branch of the wiki and all discussions relating to changes made in the nightly branch will be held within the [Kometa Discord Server](https://kometa.wiki/en/latest/discord/). + +???+ tip "`lmxl` Variants for Unsupported Hardware" + + In March 2024, lxml, a prerequisite for operating Kometa, ceased support for older CPUs. This impedes users from running Kometa on unsupported hardware. + + To address this issue, we have implemented 'lxml' variants for each Kometa branch (master, develop, and nightly). These variants resume compatibility with older hardware by freezing lxml on a previous version which has wider hardware support. + + To transition to the lxml branch, simply prepend 'lxml-' to the branch name you are currently utilizing. For instance, `Kometa-Team/Kometa:lxml-master`, `Kometa-Team/Kometa:lxml-develop` and `Kometa-Team/Kometa:lxml-nightly`. ## Discord Support Server -If you're looking for support for any questions or issues you might have, or if you just want to be a part of our growing community, Join the [Plex Meta Manager Discord Server](https://metamanager.wiki/en/latest/discord/). +If you're looking for support for any questions or issues you might have, or if you just want to be a part of our growing community, Join the [Kometa Discord Server](https://kometa.wiki/en/latest/discord/). ## Feature Requests -At Plex Meta Manager, we value our community's input and actively seek feedback to drive the evolution of our product. We want to hear your ideas on how to enhance Plex Meta Manager, and we encourage you to visit our [Feature Request](https://features.metamanager.wiki/features) page to share your thoughts or vote on what features you would like to see added next. Your voice matters and helps shape the future of Plex Meta Manager, so please don't hesitate to join in the conversation and be a part of our community-driven development process. +At Kometa, we value our community's input and actively seek feedback to drive the evolution of our product. We want to hear your ideas on how to enhance Kometa, and we encourage you to visit our [Feature Request](https://features.kometa.wiki/features) page to share your thoughts or vote on what features you would like to see added next. Your voice matters and helps shape the future of Kometa, so please don't hesitate to join in the conversation and be a part of our community-driven development process. ## Errors and Configuration Questions -If you're having trouble, we recommend first joining the [Plex Meta Manager Discord Server](https://metamanager.wiki/en/latest/discord/) and seeking support there. If that isn't possible for you, here's what you can do: +If you're having trouble, we recommend first joining the [Kometa Discord Server](https://kometa.wiki/en/latest/discord/) and seeking support there. If that isn't possible for you, here's what you can do: -* If you get an error, update to the latest version and check if the issue persists. If it does, report the bug by filling out the [Bug Report](https://github.com/meisnate12/Plex-Meta-Manager/issues/new?assignees=meisnate12&labels=status%3Anot-yet-viewed%2C+bug&template=bug_report.md&title=Bug%3A+) template. -* If you spot a mistake or have an idea to improve the [Plex Meta Manager Wiki](https://metamanager.wiki/), submit a request using the [Wiki Request](https://github.com/meisnate12/Plex-Meta-Manager/issues/new?assignees=meisnate12&labels=status%3Anot-yet-viewed%2C+documentation&template=3.docs_request.yml&title=%5BDocs%5D%3A+) template. -* If you have a question about metadata configuration, start a discussion on the [Discussions](https://github.com/meisnate12/Plex-Meta-Manager/discussions). Remember, the community helps shape the future of Plex Meta Manager, so your input is valuable! +* If you get an error, update to the latest version and check if the issue persists. If it does, report the bug by filling out the [Bug Report](https://github.com/Kometa-Team/Kometa/issues/new?assignees=meisnate12&labels=status%3Anot-yet-viewed%2C+bug&template=bug_report.md&title=Bug%3A+) template. +* If you spot a mistake or have an idea to improve the [Kometa Wiki](https://kometa.wiki/), submit a request using the [Wiki Request](https://github.com/Kometa-Team/Kometa/issues/new?assignees=meisnate12&labels=status%3Anot-yet-viewed%2C+documentation&template=3.docs_request.yml&title=%5BDocs%5D%3A+) template. +* If you have a question about metadata configuration, start a discussion on the [Discussions](https://github.com/Kometa-Team/Kometa/discussions). Remember, the community helps shape the future of Kometa, so your input is valuable! -For support on any of the above, visit the [Discord server](https://metamanager.wiki/en/latest/discord/). +For support on any of the above, visit the [Discord server](https://kometa.wiki/en/latest/discord/). ## Contributing * Pull Requests are greatly encouraged, please submit all Pull Requests to the nightly branch. \ No newline at end of file diff --git a/docs/pmm/acknowledgements.md b/docs/kometa/acknowledgements.md similarity index 70% rename from docs/pmm/acknowledgements.md rename to docs/kometa/acknowledgements.md index 345008fe..1612741b 100644 --- a/docs/pmm/acknowledgements.md +++ b/docs/kometa/acknowledgements.md @@ -1,19 +1,19 @@ # Acknowledgements -## Plex Meta Manager Team +## Kometa Team -| GitHub | Discord | Role | -|:----------------------------------------------|:------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [meisnate12](https://github.com/meisnate12/) | Sohjiro | Main PMM Developer | -| [YozoraXCII](https://github.com/YozoraXCII) | Yozora | PMM Discord Moderator, Default Configs Creator & Maintainer, Wiki Contributor, [Configs Repo](https://github.com/meisnate12/Plex-Meta-Manager-Configs) Maintainer | -| [bullmoose20](https://github.com/bullmoose20) | bullmoose20 | PMM Discord Moderator, Default Configs Creator & Maintainer, Wiki Contributor, [Configs Repo](https://github.com/meisnate12/Plex-Meta-Manager-Configs) Maintainer | -| [chazlarson](https://github.com/chazlarson/) | chazlarson | PMM Master Discord Support and Wiki Contributor who created the [Local](install/local.md) and [Docker](install/docker.md) guides | -| [cpt-kuesel](https://github.com/cpt-kuesel) | Cpt Kuesel | PMM Master Discord Support and [Configs Repo](https://github.com/meisnate12/Plex-Meta-Manager-Configs) Maintainer | -| [JohnFawkes](https://github.com/JohnFawkes) | anon_fawkes | PMM Apprentice Discord Support | -| zaP | zaP | PMM Apprentice Discord Support, Reddit Moderator | -| [mikenobbs](https://github.com/mikenobbs) | mikenobbs | PMM Discord Moderator | +| GitHub | Discord | Role | +|:----------------------------------------------|:------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [meisnate12](https://github.com/meisnate12/) | Sohjiro | Main Kometa Developer | +| [YozoraXCII](https://github.com/YozoraXCII) | Yozora | Kometa Discord Moderator, Default Configs Creator & Maintainer, Wiki Contributor, [Community Configs Repo](https://github.com/Kometa-Team/Community-Configs) Maintainer | +| [bullmoose20](https://github.com/bullmoose20) | bullmoose20 | Kometa Discord Moderator, Default Configs Creator & Maintainer, Wiki Contributor, [Community Configs Repo](https://github.com/Kometa-Team/Community-Configs) Maintainer | +| [chazlarson](https://github.com/chazlarson/) | chazlarson | Kometa Master Discord Support and Wiki Contributor who created the [Local](install/local.md) and [Docker](install/docker.md) guides | +| [cpt-kuesel](https://github.com/cpt-kuesel) | Cpt Kuesel | Kometa Master Discord Support and [Community Configs Repo](https://github.com/Kometa-Team/Community-Configs) Maintainer | +| [JohnFawkes](https://github.com/JohnFawkes) | anon_fawkes | Kometa Apprentice Discord Support | +| zaP | zaP | Kometa Apprentice Discord Support, Reddit Moderator | +| [mikenobbs](https://github.com/mikenobbs) | mikenobbs | Kometa Discord Moderator | -The team at Plex Meta Manager would like to recognize and thank those who have helped the project become what it is today. +The team at Kometa would like to recognize and thank those who have helped the project become what it is today. Special Thanks to [RedHeadJedi](https://theposterdb.com/user/RedHeadJedi) over at [ThePosterDB](https://theposterdb.com) and [/r/PlexPosters](https://www.reddit.com/r/PlexPosters) for the Logos and Branding. @@ -23,44 +23,45 @@ Special Thanks to [RedHeadJedi](https://theposterdb.com/user/RedHeadJedi) over a ## Community Developer Acknowledgements -These are the developers and creators who are an active part of the Plex Meta Manager community and help us achieve new goals. +These are the developers and creators who are an active part of the Kometa community and help us achieve new goals. | Acknowledgement | Reason | Sponsor the Developer | |:---------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------:| -| [chazlarson](https://github.com/chazlarson/) | Creator of [Media-Scripts](https://github.com/chazlarson/Media-Scripts) which offers supporting functionality to users of Plex Meta Manager | [Click Here](https://www.google.com/search?q=food+shelf+near+me) | -| [linas](https://github.com/linaspurinis) | Creator of [MDBlist.com](https://github.com/deva5610/IMDBList2PlexCollection) which makes creating Plex Meta Manager compatible lists easy | [Click Here](https://www.patreon.com/mdblist/posts) | -| [nitsua](https://github.com/austinwbest) | Creator of [Notifiarr](https://github.com/Notifiarr) which integrates Plex Meta Manager with Discord | [Click Here](https://github.com/sponsors/Notifiarr) | +| [chazlarson](https://github.com/chazlarson/) | Creator of [Media-Scripts](https://github.com/chazlarson/Media-Scripts) which offers supporting functionality to users of Kometa | [Click Here](https://www.google.com/search?q=food+shelf+near+me) | +| [linas](https://github.com/linaspurinis) | Creator of [MDBlist.com](https://github.com/deva5610/IMDBList2PlexCollection) which makes creating Kometa compatible lists easy | [Click Here](https://www.patreon.com/mdblist/posts) | +| [nitsua](https://github.com/austinwbest) | Creator of [Notifiarr](https://github.com/Notifiarr) which integrates Kometa with Discord | [Click Here](https://github.com/sponsors/Notifiarr) | | [ZeroQI](https://github.com/ZeroQI) | Creator of [Absolute Series Scanner](https://github.com/ZeroQI/Absolute-Series-Scanner) and the [HTTP Anidb Metadata Agent (HAMA)](https://github.com/ZeroQI/Hama.bundle) | [Click Here](https://github.com/sponsors/ZeroQI) | | [ScudLee](https://github.com/ScudLee) | Creator of [AniDb Anime Lists](https://github.com/Anime-Lists/anime-lists) | :fontawesome-solid-circle-xmark:{ .red } | -| [Fribb](https://github.com/Fribb) | Creator of the [MyAnimelist.net Metadata Agent](https://github.com/Fribb/MyAnimeList.bundle) which makes matching Anime easy for Plex Meta Manager users | :fontawesome-solid-circle-xmark:{ .red } | +| [Fribb](https://github.com/Fribb) | Creator of the [MyAnimelist.net Metadata Agent](https://github.com/Fribb/MyAnimeList.bundle) which makes matching Anime easy for Kometa users | :fontawesome-solid-circle-xmark:{ .red } | +| [Koltom](https://mediux.pro/) | Creator of [Mediux](https://mediux.pro/) | :fontawesome-solid-circle-xmark:{ .red } | <br> ## Project Inspiration Acknowledgements -These are the developers and creators who served as inspiration for Plex Meta Manager. +These are the developers and creators who served as inspiration for Kometa. | Acknowledgement | Reason | Sponsor the Developer | |:--------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------:| | [JonnyWong16](https://github.com/JonnyWong16) | Creator of the [IMDb Top 250](https://gist.github.com/JonnyWong16/f5b9af386ea58e19bf18c09f2681df23) collection script which served as inspiration for IMDBList2PlexCollection (and for [Tautulli](https://github.com/Tautulli/Tautulli)!) | [Click Here](https://github.com/sponsors/JonnyWong16) | | [deva5610](https://github.com/deva5610) | Creator of [IMDBList2PlexCollection](https://github.com/deva5610/IMDBList2PlexCollection) which prompted vladimir-tutin to write the original Plex Auto Collections | :fontawesome-solid-circle-xmark:{ .red } | -| [vladimir-tutin](https://github.com/vladimir-tutin) | Creator of the original [Plex Auto Collections](https://github.com/vladimir-tutin/Plex-Auto-Collections) which is the inspiration for Plex Meta Manager. | :fontawesome-solid-circle-xmark:{ .red } | +| [vladimir-tutin](https://github.com/vladimir-tutin) | Creator of the original [Plex Auto Collections](https://github.com/vladimir-tutin/Plex-Auto-Collections) which is the inspiration for Kometa. | :fontawesome-solid-circle-xmark:{ .red } | | [mza921](https://github.com/mza921) and [burkasaurusrex](https://github.com/burkasaurusrex) | Maintaining a forked [Plex Auto Collections](https://github.com/mza921/Plex-Auto-Collections) | :fontawesome-solid-circle-xmark:{ .red } | | [jkirkcaldy](https://github.com/jkirkcaldy) | Creator of [plex-utills](https://github.com/jkirkcaldy/plex-utills) which served as inspiration for Image Overlay | [Click Here](https://opencollective.com/themainframe) | -| [bearlikelion](https://github.com/bearlikelion) | Creator of [popularplex](https://github.com/bearlikelion/popularplex) which served as inspiration for Tautulli support within Plex Meta Manager | :fontawesome-solid-circle-xmark:{ .red } | +| [bearlikelion](https://github.com/bearlikelion) | Creator of [popularplex](https://github.com/bearlikelion/popularplex) which served as inspiration for Tautulli support within Kometa | :fontawesome-solid-circle-xmark:{ .red } | <br> -## PMM Dependency Acknowledgements -These are the developers and creators of the technologies that are required to make Plex Meta Manager work. +## Kometa Dependency Acknowledgements +These are the developers and creators of the technologies that are required to make Kometa work. -| Acknowledgement | Reason | Sponsor the Developer | -|:--------------------------------------------|:-----------------------------------------------------------------------------------------------------------------|:----------------------------------------------------:| -| [pkkid](https://github.com/pkkid) | Creator of [python-plexapi](https://github.com/pkkid/python-plexapi) | :fontawesome-solid-circle-xmark:{ .red } | -| [meisnate12](https://github.com/meisnate12) | Creator of [ArrAPI](https://github.com/meisnate12/ArrAPI) and [TMDbAPIs](https://github.com/meisnate12/TMDbAPIs) | [Click Here](https://github.com/sponsors/meisnate12) | -| [dbader](https://github.com/dbader) | Creator of [schedule](https://github.com/dbader/schedule) | :fontawesome-solid-circle-xmark:{ .red } | -| [rholder](https://github.com/rholder) | Creator of [retrying](https://github.com/rholder/retrying) | :fontawesome-solid-circle-xmark:{ .red } | +| Acknowledgement | Reason | Sponsor the Developer | +|:--------------------------------------------|:-------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------:| +| [pkkid](https://github.com/pkkid) | Creator of [python-plexapi](https://github.com/pkkid/python-plexapi) | :fontawesome-solid-circle-xmark:{ .red } | +| [meisnate12](https://github.com/meisnate12) | Creator of [ArrAPI](https://github.com/Kometa-Team/ArrAPI) and [TMDbAPIs](https://github.com/Kometa-Team/TMDbAPIs) | [Click Here](https://github.com/sponsors/meisnate12) | +| [dbader](https://github.com/dbader) | Creator of [schedule](https://github.com/dbader/schedule) | :fontawesome-solid-circle-xmark:{ .red } | +| [rholder](https://github.com/rholder) | Creator of [retrying](https://github.com/rholder/retrying) | :fontawesome-solid-circle-xmark:{ .red } | +## Other Acknowledgements -<br> -<br> +<a href="https://www.vecteezy.com/free-vector/meteor-logo">Meteor Logo Vectors by Vecteezy</a> \ No newline at end of file diff --git a/docs/pmm/environmental.md b/docs/kometa/environmental.md similarity index 56% rename from docs/pmm/environmental.md rename to docs/kometa/environmental.md index 0d813e76..2789b600 100644 --- a/docs/pmm/environmental.md +++ b/docs/kometa/environmental.md @@ -1,21 +1,21 @@ # Run Commands & Environment Variables -The basic command to run Plex Meta Manager is as follows: +The basic command to run Kometa is as follows: === "Windows / Mac / Linux" ``` py - python plex_meta_manager.py + python kometa.py ``` === "Docker" ``` py - docker run --rm -it -v "/<ROOT_PMM_DIRECTORY_HERE>/config:/config:rw" meisnate12/plex-meta-manager + docker run --rm -it -v "/<ROOT_KOMETA_DIRECTORY_HERE>/config:/config:rw" kometateam/kometa ``` -To customize the running of Plex Meta Manager according to your needs, you can use either run commands or environmental +To customize the running of Kometa according to your needs, you can use either run commands or environmental variables. Environmental variables take precedence over run command attributes. However, if you encounter a race condition where an attribute has been set both via an environmental variable and a shell command, the environmental variable will be given priority. @@ -39,14 +39,14 @@ different ways to specify these things. !!! example === "Local Environment" ``` - python plex_meta_manager.py --collections-only --run + python kometa.py --collections-only --run ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --collections-only --run + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --collections-only --run ``` -??? blank "Config Location      `-c`/`--config`      `PMM_CONFIG`<a class="headerlink" href="#config" title="Permanent link">¶</a>" +??? blank "Config Location      `-c`/`--config`      `KOMETA_CONFIG`<a class="headerlink" href="#config" title="Permanent link">¶</a>" <div id="config" />Specify the location of the configuration YAML file. Will default to `config/config.yml` when not specified. @@ -57,21 +57,21 @@ different ways to specify these things. **Shell Flags:** `-c` or `--config` (ex. `--config /data/config.yml`) - **Environment Variable:** `PMM_CONFIG` (ex. `PMM_CONFIG=/data/config.yml`) + **Environment Variable:** `KOMETA_CONFIG` (ex. `KOMETA_CONFIG=/data/config.yml`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --config /data/config.yml + python kometa.py --config /data/config.yml ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --config /data/config.yml + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --config /data/config.yml ``` -??? blank "Time to Run      `-t`/`--times`      `PMM_TIMES`<a class="headerlink" href="#times" title="Permanent link">¶</a>" +??? blank "Time to Run      `-t`/`--times`      `KOMETA_TIMES`<a class="headerlink" href="#times" title="Permanent link">¶</a>" - <div id="times" />Specify the time of day that Plex Meta Manager will run. Will default to `05:00` when not + <div id="times" />Specify the time of day that Kometa will run. Will default to `05:00` when not specified. <hr style="margin: 0px;"> @@ -80,19 +80,19 @@ different ways to specify these things. **Shell Flags:** `-t` or `--times` (ex. `--times 06:00,18:00`) - **Environment Variable:** `PMM_TIMES` (ex. `PMM_TIMES=06:00,18:00`) + **Environment Variable:** `KOMETA_TIMES` (ex. `KOMETA_TIMES=06:00,18:00`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --times 22:00,03:00 + python kometa.py --times 22:00,03:00 ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --times 22:00,03:00 + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --times 22:00,03:00 ``` -??? blank "Run Immediately      `-r`/`--run`      `PMM_RUN`<a class="headerlink" href="#run" title="Permanent link">¶</a>" +??? blank "Run Immediately      `-r`/`--run`      `KOMETA_RUN`<a class="headerlink" href="#run" title="Permanent link">¶</a>" <div id="run" />Perform a run immediately, bypassing the time to run flag. @@ -100,19 +100,19 @@ different ways to specify these things. **Shell Flags:** `-r` or `--run` (ex. `--run`) - **Environment Variable:** `PMM_RUN` (ex. `PMM_RUN=true`) + **Environment Variable:** `KOMETA_RUN` (ex. `KOMETA_RUN=true`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --run + python kometa.py --run ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --run + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --run ``` -??? blank "Run Tests      `-ts`/`--tests`      `PMM_TESTS`<a class="headerlink" href="#tests" title="Permanent link">¶</a>" +??? blank "Run Tests      `-ts`/`--tests`      `KOMETA_TESTS`<a class="headerlink" href="#tests" title="Permanent link">¶</a>" <div id="tests" />Perform a debug test run immediately, bypassing the time to run flag. **This will only run collections with `test: true` in the definition.** @@ -121,16 +121,16 @@ different ways to specify these things. **Shell Flags:** `-ts` or `--tests` (ex. `--tests`) - **Environment Variable:** `PMM_TESTS` (ex. `PMM_TESTS=true`) + **Environment Variable:** `KOMETA_TESTS` (ex. `KOMETA_TESTS=true`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --tests + python kometa.py --tests ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --tests + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --tests ``` === "Example Collection File" @@ -144,7 +144,8 @@ different ways to specify these things. smart_label: release.desc ``` -??? blank "Debug      `-db`/`--debug`      `PMM_DEBUG`<a class="headerlink" href="#debug" title="Permanent link">¶</a>" +??? blank "Debug      `-db`/`--debug`      `KOMETA_DEBUG`<a class="headerlink" href="#debug" title="Permanent link">¶</a>" + <div id="debug" />Perform a debug test run immediately, bypassing the time to run flag. **This will only run collections with `test: true` in the definition.** @@ -153,19 +154,19 @@ different ways to specify these things. **Shell Flags:** `-db` or `--debug` (ex. `--debug`) - **Environment Variable:** `PMM_DEBUG` (ex. `PMM_DEBUG=true`) + **Environment Variable:** `KOMETA_DEBUG` (ex. `KOMETA_DEBUG=true`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --debug + python kometa.py --debug ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --debug + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --debug ``` -??? blank "Trace      `-tr`/`--trace`      `PMM_TRACE`<a class="headerlink" href="#trace" title="Permanent link">¶</a>" +??? blank "Trace      `-tr`/`--trace`      `KOMETA_TRACE`<a class="headerlink" href="#trace" title="Permanent link">¶</a>" <div id="trace" />Run with extra Trace Debug Logs. @@ -173,19 +174,19 @@ different ways to specify these things. **Shell Flags:** `-tr` or `--trace` (ex. `--trace`) - **Environment Variable:** `PMM_TRACE` (ex. `PMM_TRACE=true`) + **Environment Variable:** `KOMETA_TRACE` (ex. `KOMETA_TRACE=true`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --trace + python kometa.py --trace ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --trace + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --trace ``` -??? blank "Log Requests      `-lr`/`--log-requests`      `PMM_LOG_REQUESTS`<a class="headerlink" href="#log-requests" title="Permanent link">¶</a>" +??? blank "Log Requests      `-lr`/`--log-requests`      `KOMETA_LOG_REQUESTS`<a class="headerlink" href="#log-requests" title="Permanent link">¶</a>" <div id="log-requests" />Run with every network request printed to the Logs. **This can potentially have personal information in it.** @@ -194,19 +195,19 @@ different ways to specify these things. **Shell Flags:** `-lr` or `--log-requests` (ex. `--log-requests`) - **Environment Variable:** `PMM_LOG_REQUESTS` (ex. `PMM_LOG_REQUESTS=true`) + **Environment Variable:** `KOMETA_LOG_REQUESTS` (ex. `KOMETA_LOG_REQUESTS=true`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --log-requests + python kometa.py --log-requests ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --log-requests + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --log-requests ``` -??? blank "Timeout      `-ti`/`--timeout`      `PMM_TIMEOUT`<a class="headerlink" href="#timeout" title="Permanent link">¶</a>" +??? blank "Timeout      `-ti`/`--timeout`      `KOMETA_TIMEOUT`<a class="headerlink" href="#timeout" title="Permanent link">¶</a>" <div id="timeout" />Change the timeout for all non-Plex services (such as TMDb, Radarr, and Trakt). This will default to `180` when not specified and is overwritten by any timeouts mentioned for specific services in the Configuration File. @@ -216,19 +217,19 @@ different ways to specify these things. **Shell Flags:** `-ti` or `--timeout` (ex. `--timeout 06:00,18:00`) - **Environment Variable:** `PMM_TIMEOUT` (ex. `PMM_TIMEOUT=06:00,18:00`) + **Environment Variable:** `KOMETA_TIMEOUT` (ex. `KOMETA_TIMEOUT=06:00,18:00`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --timeout 360 + python kometa.py --timeout 360 ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --timeout 360 + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --timeout 360 ``` -??? blank "Collections Only      `-co`/`--collections-only`      `PMM_COLLECTIONS_ONLY`<a class="headerlink" href="#collections-only" title="Permanent link">¶</a>" +??? blank "Collections Only      `-co`/`--collections-only`      `KOMETA_COLLECTIONS_ONLY`<a class="headerlink" href="#collections-only" title="Permanent link">¶</a>" <div id="collections-only" />Only run collection YAML files, skip library operations, metadata, overlays, and playlists. @@ -236,19 +237,19 @@ different ways to specify these things. **Shell Flags:** `-co` or `--collections-only` (ex. `--collections-only`) - **Environment Variable:** `PMM_COLLECTIONS_ONLY` (ex. `PMM_COLLECTIONS_ONLY=true`) + **Environment Variable:** `KOMETA_COLLECTIONS_ONLY` (ex. `KOMETA_COLLECTIONS_ONLY=true`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --collections-only + python kometa.py --collections-only ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --collections-only + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --collections-only ``` -??? blank "Metadata Only      `-mo`/`--metadata-only`      `PMM_METADATA_ONLY`<a class="headerlink" href="#metadata-only" title="Permanent link">¶</a>" +??? blank "Metadata Only      `-mo`/`--metadata-only`      `KOMETA_METADATA_ONLY`<a class="headerlink" href="#metadata-only" title="Permanent link">¶</a>" <div id="metadata-only" />Only run metadata files, skip library operations, collections, overlays, and playlists. @@ -256,19 +257,19 @@ different ways to specify these things. **Shell Flags:** `-mo` or `--metadata-only` (ex. `--metadata-only`) - **Environment Variable:** `PMM_METADATA_ONLY` (ex. `PMM_METADATA_ONLY=true`) + **Environment Variable:** `KOMETA_METADATA_ONLY` (ex. `KOMETA_METADATA_ONLY=true`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --metadata-only + python kometa.py --metadata-only ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --metadata-only + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --metadata-only ``` -??? blank "Playlists Only      `-po`/`--playlists-only`      `PMM_PLAYLISTS_ONLY`<a class="headerlink" href="#playlists-only" title="Permanent link">¶</a>" +??? blank "Playlists Only      `-po`/`--playlists-only`      `KOMETA_PLAYLISTS_ONLY`<a class="headerlink" href="#playlists-only" title="Permanent link">¶</a>" <div id="playlists-only" />Only run playlist YAML files, skip library operations, overlays, collections, and metadata. @@ -276,19 +277,19 @@ different ways to specify these things. **Shell Flags:** `-po` or `--playlists-only` (ex. `--playlists-only`) - **Environment Variable:** `PMM_PLAYLISTS_ONLY` (ex. `PMM_PLAYLISTS_ONLY=true`) + **Environment Variable:** `KOMETA_PLAYLISTS_ONLY` (ex. `KOMETA_PLAYLISTS_ONLY=true`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --playlists-only + python kometa.py --playlists-only ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --playlists-only + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --playlists-only ``` -??? blank "Operations Only      `-op`/`--operations-only`      `PMM_OPERATIONS_ONLY`<a class="headerlink" href="#operations-only" title="Permanent link">¶</a>" +??? blank "Operations Only      `-op`/`--operations-only`      `KOMETA_OPERATIONS_ONLY`<a class="headerlink" href="#operations-only" title="Permanent link">¶</a>" <div id="operations-only" />Only run library operations skipping collections, metadata, playlists, and overlays. @@ -296,19 +297,19 @@ different ways to specify these things. **Shell Flags:** `-op` or `--operations-only` (ex. `--operations-only`) - **Environment Variable:** `PMM_OPERATIONS_ONLY` (ex. `PMM_OPERATIONS_ONLY=true`) + **Environment Variable:** `KOMETA_OPERATIONS_ONLY` (ex. `KOMETA_OPERATIONS_ONLY=true`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --operations-only + python kometa.py --operations-only ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --operations-only + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --operations-only ``` -??? blank "Overlays Only      `-ov`/`--overlays-only`      `PMM_OVERLAYS_ONLY`<a class="headerlink" href="#overlays-only" title="Permanent link">¶</a>" +??? blank "Overlays Only      `-ov`/`--overlays-only`      `KOMETA_OVERLAYS_ONLY`<a class="headerlink" href="#overlays-only" title="Permanent link">¶</a>" <div id="overlays-only" />Only run library overlay files skipping collections, metadata, playlists, and operations. @@ -316,19 +317,19 @@ different ways to specify these things. **Shell Flags:** `-ov` or `--overlays-only` (ex. `--overlays-only`) - **Environment Variable:** `PMM_OVERLAYS_ONLY` (ex. `PMM_OVERLAYS_ONLY=true`) + **Environment Variable:** `KOMETA_OVERLAYS_ONLY` (ex. `KOMETA_OVERLAYS_ONLY=true`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --overlays-only + python kometa.py --overlays-only ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --overlays-only + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --overlays-only ``` -??? blank "Run Collections      `-rc`/`--run-collections`      `PMM_RUN_COLLECTIONS`<a class="headerlink" href="#run-collections" title="Permanent link">¶</a>" +??? blank "Run Collections      `-rc`/`--run-collections`      `KOMETA_RUN_COLLECTIONS`<a class="headerlink" href="#run-collections" title="Permanent link">¶</a>" <div id="run-collections" />Perform a collections run immediately to run only the pre-defined collections, bypassing the time to run flag. @@ -339,19 +340,19 @@ different ways to specify these things. **Shell Flags:** `-rc` or `--run-collections` (ex. `--run-collections "Harry Potter|Star Wars"`) - **Environment Variable:** `PMM_RUN_COLLECTIONS` (ex. `PMM_RUN_COLLECTIONS=Harry Potter|Star Wars`) + **Environment Variable:** `KOMETA_RUN_COLLECTIONS` (ex. `KOMETA_RUN_COLLECTIONS=Harry Potter|Star Wars`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --run-collections "Harry Potter|Star Wars" + python kometa.py --run-collections "Harry Potter|Star Wars" ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --run-collections "Harry Potter|Star Wars" + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --run-collections "Harry Potter|Star Wars" ``` -??? blank "Run Libraries      `-rl`/`--run-libraries`      `PMM_RUN_LIBRARIES`<a class="headerlink" href="#run-libraries" title="Permanent link">¶</a>" +??? blank "Run Libraries      `-rl`/`--run-libraries`      `KOMETA_RUN_LIBRARIES`<a class="headerlink" href="#run-libraries" title="Permanent link">¶</a>" <div id="run-libraries" />Perform a libraries run immediately to run only the pre-defined libraries, bypassing the time to run flag. @@ -362,22 +363,22 @@ different ways to specify these things. **Shell Flags:** `-rl` or `--run-libraries` (ex. `--run-libraries "Movies - 4K|TV Shows - 4K"`) - **Environment Variable:** `PMM_RUN_LIBRARIES` (ex. `PMM_RUN_LIBRARIES=Movies - 4K|TV Shows - 4K`) + **Environment Variable:** `KOMETA_RUN_LIBRARIES` (ex. `KOMETA_RUN_LIBRARIES=Movies - 4K|TV Shows - 4K`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --run-libraries "Movies - 4K|TV Shows - 4K" + python kometa.py --run-libraries "Movies - 4K|TV Shows - 4K" ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --run-libraries "Movies - 4K|TV Shows - 4K" + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --run-libraries "Movies - 4K|TV Shows - 4K" ``` -??? blank "Run Files      `-rf`/`--run-files`      `PMM_RUN_FILES`<a class="headerlink" href="#run-files" title="Permanent link">¶</a>" +??? blank "Run Files      `-rf`/`--run-files`      `KOMETA_RUN_FILES`<a class="headerlink" href="#run-files" title="Permanent link">¶</a>" <div id="run-files" />Perform a run immediately to run only the pre-defined Collection, Metadata or Playlist files, - bypassing the time to run flag. This works for all different paths i.e. `pmm`, `git`, `url`, `file`, or `repo`. + bypassing the time to run flag. This works for all different paths i.e. `default`, `git`, `url`, `file`, or `repo`. ???+ warning @@ -389,19 +390,19 @@ different ways to specify these things. **Shell Flags:** `-rf` or `--run-files` (ex. `--run-files "Movies.yml|MovieCharts"`) - **Environment Variable:** `PMM_RUN_FILES` (ex. `PMM_RUN_FILES=Movies.yml|MovieCharts`) + **Environment Variable:** `KOMETA_RUN_FILES` (ex. `KOMETA_RUN_FILES=Movies.yml|MovieCharts`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --run-files "Movies.yml|MovieCharts" + python kometa.py --run-files "Movies.yml|MovieCharts" ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --run-files "Movies.yml|MovieCharts" + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --run-files "Movies.yml|MovieCharts" ``` -??? blank "Ignore Schedules      `-is`/`--ignore-schedules`      `PMM_IGNORE_SCHEDULES`<a class="headerlink" href="#ignore-schedules" title="Permanent link">¶</a>" +??? blank "Ignore Schedules      `-is`/`--ignore-schedules`      `KOMETA_IGNORE_SCHEDULES`<a class="headerlink" href="#ignore-schedules" title="Permanent link">¶</a>" <div id="ignore-schedules" />Ignore all schedules for the run. Range Scheduled collections (such as Christmas movies) will still be ignored. @@ -410,19 +411,19 @@ different ways to specify these things. **Shell Flags:** `-is` or `--ignore-schedules` (ex. `--ignore-schedules`) - **Environment Variable:** `PMM_IGNORE_SCHEDULES` (ex. `PMM_IGNORE_SCHEDULES=true`) + **Environment Variable:** `KOMETA_IGNORE_SCHEDULES` (ex. `KOMETA_IGNORE_SCHEDULES=true`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --ignore-schedules + python kometa.py --ignore-schedules ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --ignore-schedules + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --ignore-schedules ``` -??? blank "Ignore Ghost      `-ig`/`--ignore-ghost`      `PMM_IGNORE_GHOST`<a class="headerlink" href="#ignore-ghost" title="Permanent link">¶</a>" +??? blank "Ignore Ghost      `-ig`/`--ignore-ghost`      `KOMETA_IGNORE_GHOST`<a class="headerlink" href="#ignore-ghost" title="Permanent link">¶</a>" <div id="ignore-ghost" />Ignore all ghost logging for the run. A ghost log is what's printed to the console to show progress during steps. @@ -431,50 +432,50 @@ different ways to specify these things. **Shell Flags:** `-ig` or `--ignore-ghost` (ex. `--ignore-ghost`) - **Environment Variable:** `PMM_IGNORE_GHOST` (ex. `PMM_IGNORE_GHOST=true`) + **Environment Variable:** `KOMETA_IGNORE_GHOST` (ex. `KOMETA_IGNORE_GHOST=true`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --ignore-ghost + python kometa.py --ignore-ghost ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --ignore-ghost + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --ignore-ghost ``` -??? blank "Delete Collections      `-dc`/`--delete-collections`      `PMM_DELETE_COLLECTIONS`<a class="headerlink" href="#delete-collections" title="Permanent link">¶</a>" +??? blank "Delete Collections      `-dc`/`--delete-collections`      `KOMETA_DELETE_COLLECTIONS`<a class="headerlink" href="#delete-collections" title="Permanent link">¶</a>" <div id="delete-collections" />Delete all collections in a Library prior to running collections/operations. ???+ warning You will lose **all** collections in the library - this will delete all collections, including ones not created - or maintained by Plex Meta Manager. + or maintained by Kometa. <hr style="margin: 0px;"> **Shell Flags:** `-dc` or `--delete-collections` (ex. `--delete-collections`) - **Environment Variable:** `PMM_DELETE_COLLECTIONS` (ex. `PMM_DELETE_COLLECTIONS=true`) + **Environment Variable:** `KOMETA_DELETE_COLLECTIONS` (ex. `KOMETA_DELETE_COLLECTIONS=true`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --delete-collections + python kometa.py --delete-collections ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --delete-collections + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --delete-collections ``` -??? blank "Delete Labels      `-dl`/`--delete-labels`      `PMM_DELETE_LABELS`<a class="headerlink" href="#delete-labels" title="Permanent link">¶</a>" +??? blank "Delete Labels      `-dl`/`--delete-labels`      `KOMETA_DELETE_LABELS`<a class="headerlink" href="#delete-labels" title="Permanent link">¶</a>" <div id="delete-labels" />Delete all labels on every item in a Library prior to running collections/operations. ???+ warning - To preserve functionality of PMM, this will **not** remove the Overlay label, which is required for PMM to know + To preserve functionality of Kometa, this will **not** remove the Overlay label, which is required for Kometa to know which items have Overlays applied. This will impact any [Smart Label Collections](../files/builders/smart.md#smart-label) that you have in your @@ -487,19 +488,19 @@ different ways to specify these things. **Shell Flags:** `-dl` or `--delete-labels` (ex. `--delete-labels`) - **Environment Variable:** `PMM_DELETE_LABELS` (ex. `PMM_DELETE_LABELS=true`) + **Environment Variable:** `KOMETA_DELETE_LABELS` (ex. `KOMETA_DELETE_LABELS=true`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --delete-labels + python kometa.py --delete-labels ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --delete-labels + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --delete-labels ``` -??? blank "Resume Run      `-re`/`--resume`      `PMM_RESUME`<a class="headerlink" href="#resume" title="Permanent link">¶</a>" +??? blank "Resume Run      `-re`/`--resume`      `KOMETA_RESUME`<a class="headerlink" href="#resume" title="Permanent link">¶</a>" <div id="resume" />Perform a resume run immediately resuming from the first instance of the specified collection, bypassing the time to run flag. @@ -508,19 +509,19 @@ different ways to specify these things. **Shell Flags:** `-re` or `--resume` (ex. `--resume "Star Wars"`) - **Environment Variable:** `PMM_RESUME` (ex. `PMM_RESUME=Star Wars`) + **Environment Variable:** `KOMETA_RESUME` (ex. `KOMETA_RESUME=Star Wars`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --resume "Star Wars" + python kometa.py --resume "Star Wars" ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --resume "Star Wars" + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --resume "Star Wars" ``` -??? blank "No Countdown      `-nc`/`--no-countdown`      `PMM_NO_COUNTDOWN`<a class="headerlink" href="#no-countdown" title="Permanent link">¶</a>" +??? blank "No Countdown      `-nc`/`--no-countdown`      `KOMETA_NO_COUNTDOWN`<a class="headerlink" href="#no-countdown" title="Permanent link">¶</a>" <div id="no-countdown" />Run without displaying a countdown to the next scheduled run. @@ -528,19 +529,19 @@ different ways to specify these things. **Shell Flags:** `-nc` or `--no-countdown` (ex. `--no-countdown`) - **Environment Variable:** `PMM_NO_COUNTDOWN` (ex. `PMM_NO_COUNTDOWN=true`) + **Environment Variable:** `KOMETA_NO_COUNTDOWN` (ex. `KOMETA_NO_COUNTDOWN=true`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --no-countdown + python kometa.py --no-countdown ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --no-countdown + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --no-countdown ``` -??? blank "No Missing      `-nm`/`--no-missing`      `PMM_NO_MISSING`<a class="headerlink" href="#no-missing" title="Permanent link">¶</a>" +??? blank "No Missing      `-nm`/`--no-missing`      `KOMETA_NO_MISSING`<a class="headerlink" href="#no-missing" title="Permanent link">¶</a>" <div id="no-missing" />Run without utilizing the missing movie/show functions. @@ -548,19 +549,19 @@ different ways to specify these things. **Shell Flags:** `-nm` or `--no-missing` (ex. `--no-missing`) - **Environment Variable:** `PMM_NO_MISSING` (ex. `PMM_NO_MISSING=true`) + **Environment Variable:** `KOMETA_NO_MISSING` (ex. `KOMETA_NO_MISSING=true`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --no-missing + python kometa.py --no-missing ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --no-missing + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --no-missing ``` -??? blank "No Report      `-nr`/`--no-report`      `PMM_NO_REPORT`<a class="headerlink" href="#no-report" title="Permanent link">¶</a>" +??? blank "No Report      `-nr`/`--no-report`      `KOMETA_NO_REPORT`<a class="headerlink" href="#no-report" title="Permanent link">¶</a>" <div id="no-report" />Run without saving the report. @@ -568,19 +569,19 @@ different ways to specify these things. **Shell Flags:** `-nr` or `--no-report` (ex. `--no-report`) - **Environment Variable:** `PMM_NO_REPORT` (ex. `PMM_NO_REPORT=true`) + **Environment Variable:** `KOMETA_NO_REPORT` (ex. `KOMETA_NO_REPORT=true`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --no-report + python kometa.py --no-report ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --no-report + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --no-report ``` -??? blank "Read Only Config      `-ro`/`--read-only-config`      `PMM_READ_ONLY_CONFIG`<a class="headerlink" href="#read-only-config" title="Permanent link">¶</a>" +??? blank "Read Only Config      `-ro`/`--read-only-config`      `KOMETA_READ_ONLY_CONFIG`<a class="headerlink" href="#read-only-config" title="Permanent link">¶</a>" <div id="read-only-config" />Run without writing to the configuration file. @@ -588,19 +589,19 @@ different ways to specify these things. **Shell Flags:** `-ro` or `--read-only-config` (ex. `--read-only-config`) - **Environment Variable:** `PMM_READ_ONLY_CONFIG` (ex. `PMM_READ_ONLY_CONFIG=true`) + **Environment Variable:** `KOMETA_READ_ONLY_CONFIG` (ex. `KOMETA_READ_ONLY_CONFIG=true`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --read-only-config + python kometa.py --read-only-config ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --read-only-config + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --read-only-config ``` -??? blank "Divider Character      `-d`/`--divider`      `PMM_DIVIDER`<a class="headerlink" href="#divider" title="Permanent link">¶</a>" +??? blank "Divider Character      `-d`/`--divider`      `KOMETA_DIVIDER`<a class="headerlink" href="#divider" title="Permanent link">¶</a>" <div id="divider" />Change the terminal output divider character. Will default to `=` if not specified. @@ -610,19 +611,19 @@ different ways to specify these things. **Shell Flags:** `-d` or `--divider` (ex. `--divider *`) - **Environment Variable:** `PMM_DIVIDER` (ex. `PMM_DIVIDER=*`) + **Environment Variable:** `KOMETA_DIVIDER` (ex. `KOMETA_DIVIDER=*`) !!! example === "Local Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --divider * - python plex_meta_manager.py --divider * + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --divider * + python kometa.py --divider * ``` === "Docker Environment" ``` ``` -??? blank "Screen Width      `-w`/`--width`      `PMM_WIDTH`<a class="headerlink" href="#width" title="Permanent link">¶</a>" +??? blank "Screen Width      `-w`/`--width`      `KOMETA_WIDTH`<a class="headerlink" href="#width" title="Permanent link">¶</a>" <div id="width" />Change the terminal output width. Will default to `100` if not specified. @@ -632,40 +633,40 @@ different ways to specify these things. **Shell Flags:** `-w` or `--width` (ex. `--width 150`) - **Environment Variable:** `PMM_WIDTH` (ex. `PMM_WIDTH=150`) + **Environment Variable:** `KOMETA_WIDTH` (ex. `KOMETA_WIDTH=150`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --width 150 + python kometa.py --width 150 ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --width 150 + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --width 150 ``` -??? blank "Config Secrets      `--pmm-***`      `PMM_***`<a class="headerlink" href="#pmm-vars" title="Permanent link">¶</a>" +??? blank "Config Secrets      `--kometa-***`      `KOMETA_***`<a class="headerlink" href="#kometa-vars" title="Permanent link">¶</a>" - <div id="pmm-vars" />All Run Commands that are in the format `--pmm-***` and Environment Variables that are in the - format `PMM_***`, where `***` is the name you want to call the variable, will be loaded in as Config Secrets. + <div id="kometa-vars" />All Run Commands that are in the format `--kometa-***` and Environment Variables that are in the + format `KOMETA_***`, where `***` is the name you want to call the variable, will be loaded in as Config Secrets. These Config Secrets can be loaded into the config by placing `<<***>>` in any field in the config, where `***` is whatever name you called the variable. <hr style="margin: 0px;"> - **Shell Flags:** `--pmm-***` (ex. `--pmm-mysecret 123456789`) + **Shell Flags:** `--kometa-***` (ex. `--kometa-mysecret 123456789`) - **Environment Variable:** `PMM_***` (ex. `PMM_MYSECRET=123456789`) + **Environment Variable:** `KOMETA_***` (ex. `KOMETA_MYSECRET=123456789`) !!! example === "Local Environment" ``` - python plex_meta_manager.py --pmm-mysecret 123456789 + python kometa.py --kometa-mysecret 123456789 ``` === "Docker Environment" ``` - docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --pmm-mysecret 123456789 + docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --kometa-mysecret 123456789 ``` **Example Config Usage:** diff --git a/docs/pmm/faqs.md b/docs/kometa/faqs.md similarity index 64% rename from docs/pmm/faqs.md rename to docs/kometa/faqs.md index e5469477..1b1546eb 100644 --- a/docs/pmm/faqs.md +++ b/docs/kometa/faqs.md @@ -4,31 +4,31 @@ search: --- # FAQ & Knowledgebase -This page aims to provide knowledge based on combined user experience, and to answer the frequent questions that we are asked in our [Discord Server](https://metamanager.wiki/en/latest/discord/). +This page aims to provide knowledge based on combined user experience, and to answer the frequent questions that we are asked in our [Discord Server](https://kometa.wiki/en/latest/discord/). -If you have a question that is not answered here, try entering some keywords into the search bar above, or join our [Discord Server](https://metamanager.wiki/en/latest/discord/). +If you have a question that is not answered here, try entering some keywords into the search bar above, or join our [Discord Server](https://kometa.wiki/en/latest/discord/). ## Frequently Asked Questions This section aims to answer the most commonly asked questions that users have. -### PMM Versions & Updating +### Kometa Versions & Updating -The commands here should work in any terminal on the respective platforms, but that can't be guaranteed. If you know shortcuts for some of these things, go ahead and use them. For example, in many terminals, `cd ~/Plex-Meta-Manager` is the same as `cd /Users/YOUR_USERNAME/Plex-Meta-Manager`. +The commands here should work in any terminal on the respective platforms, but that can't be guaranteed. If you know shortcuts for some of these things, go ahead and use them. For example, in many terminals, `cd ~/Kometa` is the same as `cd /Users/YOUR_USERNAME/Kometa`. -Your PMM installation may not be located at the paths referenced below. These are the paths used in the walkthroughs in this documentation, so if you installed it somewhere else you will have to change the path[s] to reflect your system and the choices you made during installation. +Your Kometa installation may not be located at the paths referenced below. These are the paths used in the walkthroughs in this documentation, so if you installed it somewhere else you will have to change the path[s] to reflect your system and the choices you made during installation. -??? question "How do I update to the latest version of Plex Meta Manager?" +??? question "How do I update to the latest version of Kometa?" === ":fontawesome-brands-linux: Linux" [type this into your terminal, changing `YOUR_USERNAME` to your username] - cd /Users/YOUR_USERNAME/Plex-Meta-Manager + cd /Users/YOUR_USERNAME/Kometa git stash git stash clear git pull - source pmm-venv/bin/activate + source kometa-venv/bin/activate python -m pip install -r requirements.txt These two commands: @@ -36,18 +36,18 @@ Your PMM installation may not be located at the paths referenced below. These ar git stash git stash clear - Will reset any changes you have made to PMM-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. + Will reset any changes you have made to Kometa-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. === ":fontawesome-brands-apple: macOS" [type this into your terminal, changing `YOUR_USERNAME` to your username] - cd /Users/YOUR_USERNAME/Plex-Meta-Manager + cd /Users/YOUR_USERNAME/Kometa git stash git stash clear git pull - source pmm-venv/bin/activate + source kometa-venv/bin/activate python -m pip install -r requirements.txt These two commands: @@ -55,18 +55,18 @@ Your PMM installation may not be located at the paths referenced below. These ar git stash git stash clear - Will reset any changes you have made to PMM-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. + Will reset any changes you have made to Kometa-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. === ":fontawesome-brands-windows: Windows" [type this into your terminal, changing `YOUR_USERNAME` to your username and the drive letter if needed] C: - cd C:\Users\YOUR_USERNAME\Plex-Meta-Manager + cd C:\Users\YOUR_USERNAME\Kometa git stash git stash clear git pull - .\pmm-venv\Scripts\activate + .\kometa-venv\Scripts\activate python -m pip install -r requirements.txt These two commands: @@ -74,13 +74,13 @@ Your PMM installation may not be located at the paths referenced below. These ar git stash git stash clear - Will reset any changes you have made to PMM-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. + Will reset any changes you have made to Kometa-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. === ":fontawesome-brands-docker: Docker" [type this into your terminal] - docker pull meisnate12/plex-meta-manager:TAG_HERE + docker pull kometateam/kometa:TAG_HERE replacing TAG_HERE with latest, develop, or nightly [whichever you are currently using] @@ -94,12 +94,12 @@ Your PMM installation may not be located at the paths referenced below. These ar [type this into your terminal, changing `YOUR_USERNAME` to your username] - cd /Users/YOUR_USERNAME/Plex-Meta-Manager + cd /Users/YOUR_USERNAME/Kometa git stash git stash clear git checkout develop git pull - source pmm-venv/bin/activate + source kometa-venv/bin/activate python -m pip install -r requirements.txt @@ -108,18 +108,18 @@ Your PMM installation may not be located at the paths referenced below. These ar git stash git stash clear - Will reset any changes you have made to PMM-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. + Will reset any changes you have made to Kometa-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. === ":fontawesome-brands-apple: macOS" [type this into your terminal, changing `YOUR_USERNAME` to your username] - cd /Users/YOUR_USERNAME/Plex-Meta-Manager + cd /Users/YOUR_USERNAME/Kometa git stash git stash clear git checkout develop git pull - source pmm-venv/bin/activate + source kometa-venv/bin/activate python -m pip install -r requirements.txt These two commands: @@ -127,19 +127,19 @@ Your PMM installation may not be located at the paths referenced below. These ar git stash git stash clear - Will reset any changes you have made to PMM-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. + Will reset any changes you have made to Kometa-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. === ":fontawesome-brands-windows: Windows" [type this into your terminal, changing `YOUR_USERNAME` to your username and the drive letter if needed] C: - cd C:\Users\YOUR_USERNAME\Plex-Meta-Manager + cd C:\Users\YOUR_USERNAME\Kometa git stash git stash clear git checkout develop git pull - .\pmm-venv\Scripts\activate + .\kometa-venv\Scripts\activate python -m pip install -r requirements.txt These two commands: @@ -147,15 +147,15 @@ Your PMM installation may not be located at the paths referenced below. These ar git stash git stash clear - Will reset any changes you have made to PMM-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. + Will reset any changes you have made to Kometa-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. === ":fontawesome-brands-docker: Docker" [type this into your terminal] - docker pull meisnate12/plex-meta-manager:develop + docker pull kometateam/kometa:develop - Then recreate your container via whatever means you used to create it [docker run, docker-compose, etc.], changing the image in the docker command or the `docker-compose.yml` to `meisnate12/plex-meta-manager:develop`. + Then recreate your container via whatever means you used to create it [docker run, docker-compose, etc.], changing the image in the docker command or the `docker-compose.yml` to `kometateam/kometa:develop`. If you are using Docker on a NAS like Synology or UNRaid, they will provide some means of doing those two things. @@ -166,12 +166,12 @@ Your PMM installation may not be located at the paths referenced below. These ar [type this into your terminal, changing `YOUR_USERNAME` to your username] - cd /Users/YOUR_USERNAME/Plex-Meta-Manager + cd /Users/YOUR_USERNAME/Kometa git stash git stash clear git checkout nightly git pull - source pmm-venv/bin/activate + source kometa-venv/bin/activate python -m pip install -r requirements.txt These two commands: @@ -179,18 +179,18 @@ Your PMM installation may not be located at the paths referenced below. These ar git stash git stash clear - Will reset any changes you have made to PMM-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. + Will reset any changes you have made to Kometa-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. === ":fontawesome-brands-apple: macOS" [type this into your terminal, changing `YOUR_USERNAME` to your username] - cd /Users/YOUR_USERNAME/Plex-Meta-Manager + cd /Users/YOUR_USERNAME/Kometa git stash git stash clear git checkout nightly git pull - source pmm-venv/bin/activate + source kometa-venv/bin/activate python -m pip install -r requirements.txt These two commands: @@ -198,19 +198,19 @@ Your PMM installation may not be located at the paths referenced below. These ar git stash git stash clear - Will reset any changes you have made to PMM-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. + Will reset any changes you have made to Kometa-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. === ":fontawesome-brands-windows: Windows" [type this into your terminal, changing `YOUR_USERNAME` to your username and the drive letter if needed] C: - cd C:\Users\YOUR_USERNAME\Plex-Meta-Manager + cd C:\Users\YOUR_USERNAME\Kometa git stash git stash clear git checkout nightly git pull - .\pmm-venv\Scripts\activate + .\kometa-venv\Scripts\activate python -m pip install -r requirements.txt These two commands: @@ -218,15 +218,15 @@ Your PMM installation may not be located at the paths referenced below. These ar git stash git stash clear - Will reset any changes you have made to PMM-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. + Will reset any changes you have made to Kometa-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. === ":fontawesome-brands-docker: Docker" [type this into your terminal] - docker pull meisnate12/plex-meta-manager:nightly + docker pull kometateam/kometa:nightly - Then recreate your container via whatever means you used to create it [docker run, docker-compose, etc.], changing the image in the docker command or the `docker-compose.yml` to `meisnate12/plex-meta-manager:nightly`. + Then recreate your container via whatever means you used to create it [docker run, docker-compose, etc.], changing the image in the docker command or the `docker-compose.yml` to `kometateam/kometa:nightly`. If you are using Docker on a NAS like Synology or UNRaid, they will provide some means of doing those two things. @@ -236,12 +236,12 @@ Your PMM installation may not be located at the paths referenced below. These ar [type this into your terminal, changing `YOUR_USERNAME` to your username] - cd /Users/YOUR_USERNAME/Plex-Meta-Manager + cd /Users/YOUR_USERNAME/Kometa git stash git stash clear git checkout master git pull - source pmm-venv/bin/activate + source kometa-venv/bin/activate python -m pip install -r requirements.txt These two commands: @@ -249,18 +249,18 @@ Your PMM installation may not be located at the paths referenced below. These ar git stash git stash clear - Will reset any changes you have made to PMM-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. + Will reset any changes you have made to Kometa-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. === ":fontawesome-brands-apple: macOS" [type this into your terminal, changing `YOUR_USERNAME` to your username] - cd /Users/YOUR_USERNAME/Plex-Meta-Manager + cd /Users/YOUR_USERNAME/Kometa git stash git stash clear git checkout master git pull - source pmm-venv/bin/activate + source kometa-venv/bin/activate python -m pip install -r requirements.txt These two commands: @@ -268,19 +268,19 @@ Your PMM installation may not be located at the paths referenced below. These ar git stash git stash clear - Will reset any changes you have made to PMM-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. + Will reset any changes you have made to Kometa-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. === ":fontawesome-brands-windows: Windows" [type this into your terminal, changing `YOUR_USERNAME` to your username and the drive letter if needed] C: - cd C:\Users\YOUR_USERNAME\Plex-Meta-Manager + cd C:\Users\YOUR_USERNAME\Kometa git stash git stash clear git checkout master git pull - .\pmm-venv\Scripts\activate + .\kometa-venv\Scripts\activate python -m pip install -r requirements.txt These two commands: @@ -288,36 +288,36 @@ Your PMM installation may not be located at the paths referenced below. These ar git stash git stash clear - Will reset any changes you have made to PMM-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. + Will reset any changes you have made to Kometa-owned files [YOUR CONFIG FILES ARE NOT AFFECTED]. You shouldn't be doing this, so typically this will not lose any of your work. If you have done this, the assumption is that you know enough about `git` to know how to prevent that from happening. === ":fontawesome-brands-docker: Docker" [type this into your terminal] - docker pull meisnate12/plex-meta-manager:latest + docker pull kometateam/kometa:latest - Then recreate your container via whatever means you used to create it [docker run, docker-compose, etc.], changing the image in the docker command or the `docker-compose.yml` to `meisnate12/plex-meta-manager:latest`. + Then recreate your container via whatever means you used to create it [docker run, docker-compose, etc.], changing the image in the docker command or the `docker-compose.yml` to `kometateam/kometa:latest`. If you are using Docker on a NAS like Synology or UNRaid, they will provide some means of doing those two things. ### Performance & Scheduling -??? question "Any tips on increasing PMM performance?" +??? question "Any tips on increasing Kometa performance?" - Use PMM Caching where possible, this allows PMM to temporarily store commonly-used information so that it can be retrieved more efficiently. There are [multiple things](https://metamanager.wiki/en/latest/search.html?q=cache&check_keywords=yes&area=default) that can be cached within PMM. + Use Kometa Caching where possible, this allows Kometa to temporarily store commonly-used information so that it can be retrieved more efficiently. There are [multiple things](https://kometa.wiki/en/latest/search.html?q=cache&check_keywords=yes&area=default) that can be cached within Kometa. - Run PMM after PLEX Scheduled Tasks, as Plex's API tends to be slower at responding whilst it is performing the tasks. By default, PMM runs at 5AM to avoid the 3-5am window that Plex suggests for Scheduled Tasks. + Run Kometa after PLEX Scheduled Tasks, as Plex's API tends to be slower at responding whilst it is performing the tasks. By default, Kometa runs at 5AM to avoid the 3-5am window that Plex suggests for Scheduled Tasks. For users who are more technically advanced and happy to risk manipulating the Plex database, considering altering the [PRAGMA_CACHE settings](https://www.reddit.com/r/PleX/comments/ic3cjr/anyone_try_giving_sqlite3_more_cache_to_help/) within Plex. **Note:** you MUST use the version of sqlite3 tool that comes with your running version of PLEX or you will mess up your PLEX DB beyond repair. See [this article](https://support.plex.tv/articles/repair-a-corrupted-database/) on how to find the proper version for your setup. -??? question "Why does my PMM run take so long to complete?" +??? question "Why does my Kometa run take so long to complete?" - Every time an item (media, collection, overlay) needs to be updated, PMM needs to send the request to Plex, and then receive confirmation back from Plex that the action has been completed. This can take anywhere from seconds to minutes depending on when Plex provides a response. Given that the typical run can update hundreds or even thousands of items, this can quickly add up to a lot of time. If "Mass Update" operations are used, then every single item in the library needs to go through this process, which can be lengthy. + Every time an item (media, collection, overlay) needs to be updated, Kometa needs to send the request to Plex, and then receive confirmation back from Plex that the action has been completed. This can take anywhere from seconds to minutes depending on when Plex provides a response. Given that the typical run can update hundreds or even thousands of items, this can quickly add up to a lot of time. If "Mass Update" operations are used, then every single item in the library needs to go through this process, which can be lengthy. - Overlays can be particularly cumbersome as PMM needs to perform the following actions for each of the items that need to have an overlay applied: + Overlays can be particularly cumbersome as Kometa needs to perform the following actions for each of the items that need to have an overlay applied: - Check which overlays are applicable (this will take more time depending on how many overlays you are applying) - Compare the current poster to confirm what overlays are already applied, if changes are needed then continue with the following steps @@ -327,7 +327,7 @@ Your PMM installation may not be located at the paths referenced below. These ar - Tell Plex to apply new image to the item - Wait for Plex to respond confirming that the change has been made - The above two points can be greatly exacerbated if PMM has to update every episode within a Show library rather than just the Shows themselves, as there can often be hundreds of thousands of episodes to be updated with mass operations or overlays. + The above two points can be greatly exacerbated if Kometa has to update every episode within a Show library rather than just the Shows themselves, as there can often be hundreds of thousands of episodes to be updated with mass operations or overlays. Additionally, some collections require a lot of computing resources to determine the critera of the collections that are to be made. This is commonly seen in the Defaults files for Actor/Director/Producer/Writer which need to get the crew information for each of the movies/shows within your library, and then calculate which ones appear the most to find out which are the most popular. The larger your library, the longer this process will take. @@ -344,16 +344,16 @@ Your PMM installation may not be located at the paths referenced below. These ar operations: split_duplicates: true overlay_files: - - pmm: resolution + - default: resolution ``` ### Errors & Issues -??? question "Why doesn't PMM let me enter my authentication information for Trakt/MAL?" +??? question "Why doesn't Kometa let me enter my authentication information for Trakt/MAL?" - PMM needs to run in an interactive mode which allows the user to enter information (such as the Trakt/MAL PIN) as part of the authentication process. This can prove troublesome in some environments, particularly NAS. + Kometa needs to run in an interactive mode which allows the user to enter information (such as the Trakt/MAL PIN) as part of the authentication process. This can prove troublesome in some environments, particularly NAS. - Chazlarson has developed an online tool which will allow you to perform the authentication of both Trakt and MAL outside of PMM, and will then provide you the completed code block to paste into your config.yml. + Chazlarson has developed an online tool which will allow you to perform the authentication of both Trakt and MAL outside of Kometa, and will then provide you the completed code block to paste into your config.yml. The scripts can be found here. Click the green play button, wait a little bit, then follow the prompts. @@ -366,7 +366,7 @@ Your PMM installation may not be located at the paths referenced below. These ar A 500 Internal Server Error happens when the server has an unexpected error when responding to an API request. - There could be any number of reasons why this happens and it depends on what server PMM is talking to although it's most likely coming from your Plex Server. + There could be any number of reasons why this happens and it depends on what server Kometa is talking to although it's most likely coming from your Plex Server. Most of the time these errors need to be resolved by changing something specific to your set up but some do come up that can be fixed (i.e. Plex throws one if you upload a photo larger than 10 MB) @@ -378,29 +378,29 @@ Your PMM installation may not be located at the paths referenced below. These ar :two: Check the plex logs (container or other) for the "Busy DB Sleeping for 200ms) - There is nothing that PMM or our support staff can really do to resolve a 500 error. + There is nothing that Kometa or our support staff can really do to resolve a 500 error. ## Knowledgebase This section aims to provide some insight as to articles/information that we feel is important to document as they may pop up infrequently but often enough to require entry here. -### PMM 1.20 Release Changes +### Kometa 1.20 Release Changes -With the release of PMM 1.20, several changes have been made. Please read the document below thoroughly! +With the release of Kometa 1.20, several changes have been made. Please read the document below thoroughly! ??? blank "`metadata_path` and `overlay_path` are now legacy attributes (click to expand).<a class="headerlink" href="#metadata-overlay-path" title="Permanent link">¶</a>" <div id="metadata-overlay-path" /> - The attributes `metadata_path` and `overlay_path` are now legacy, and will likely produce an error `metadata attribute is required` when running PMM. + The attributes `metadata_path` and `overlay_path` are now legacy, and will likely produce an error `metadata attribute is required` when running Kometa. We have new attributes: `collection_files`, `overlay_files` and `metadata_files` which you can read more about on the [Libraries Attributes page](../config/libraries.md#attributes) Whilst this error can be ignored, we strongly advise you to move over to the new attributes, which can be done following this guidance: - :fontawesome-solid-1: If your YAML file creates collections or is a PMM Defaults Collection File then it belongs under `collection_files`. + :fontawesome-solid-1: If your YAML file creates collections or is a Kometa Defaults Collection File then it belongs under `collection_files`. - :fontawesome-solid-2: If your YAML file creates overlays or is a PMM Defaults Overlay File then it belongs under `overlay_files` + :fontawesome-solid-2: If your YAML file creates overlays or is a Kometa Defaults Overlay File then it belongs under `overlay_files` :fontawesome-solid-3: If your YAML file edits item metadata ([see this example](../files/metadata.md/#__tabbed_1_1)) then it belongs under `metadata_files` @@ -417,12 +417,12 @@ With the release of PMM 1.20, several changes have been made. Please read the do Movies: collection_files: #(1)! - file: config/Movies.yml #(2)! - - pmm: imdb #(2)! + - default: imdb #(2)! metadata_files: #(3)! - file: config/MetadataEdits.yml #(4)! overlay_files: #(5)! - file: config/Overlays.yml #(6)! - - pmm: audio_codec #(6)! + - default: audio_codec #(6)! ``` 1. This attribute used to be `metadata_path` and defines files that will relate to Collections @@ -450,10 +450,10 @@ With the release of PMM 1.20, several changes have been made. Please read the do # reset_overlays: plex #(2)! schedule_overlays: daily overlay_files: - - pmm: audio_codec + - default: audio_codec ``` - 1. We strongly advise never setting this to `true` as it can cause [Image Bloat](scripts/image-cleanup.md) + 1. We strongly advise never setting this to `true` as it can cause [Image Bloat](scripts/imagemaid.md) 2. This is purely an example, you do not need to specify `reset_overlays` or any of these attributes unless you specifically need to use them. ??? blank "`imdb_list` no longer works for Title or Keyword search URLs (click to expand).<a class="headerlink" href="#imdb-search" title="Permanent link">¶</a>" @@ -493,10 +493,10 @@ With the release of PMM 1.20, several changes have been made. Please read the do Due to FlixPatrol moving a lot of their data behind a paywall and them reworking their pages to remove IMDb IDs and TMDb IDs the flixpatrol builders and default files have been removed. There currently are no plans to re-add them. -??? blank "PMM Default `other_award` replaced with individual Award files (click to expand).<a class="headerlink" href="#awards" title="Permanent link">¶</a>" +??? blank "Kometa Default `other_award` replaced with individual Award files (click to expand).<a class="headerlink" href="#awards" title="Permanent link">¶</a>" <div id="awards" /> - The PMM Default file `other_award` is now deprecated and will no longer function. + The Kometa Default file `other_award` is now deprecated and will no longer function. - Individual PMM Default files have been introduced for several Awards, see the [Awards List](../defaults/collection_list.md#award-collections) for more information on the new options. + Individual Kometa Default files have been introduced for several Awards, see the [Awards List](../defaults/collection_list.md#award-collections) for more information on the new options. diff --git a/docs/pmm/guides/assets.md b/docs/kometa/guides/assets.md similarity index 90% rename from docs/pmm/guides/assets.md rename to docs/kometa/guides/assets.md index a85990c3..f2771edf 100644 --- a/docs/pmm/guides/assets.md +++ b/docs/kometa/guides/assets.md @@ -11,9 +11,9 @@ You can specify your asset folders under the `settings` attribute `asset_directo ???+ important - Assets can be stored anywhere on the host system that PMM has visibility of (i.e. if using docker, the directory must be mounted/visible to the docker container). + Assets can be stored anywhere on the host system that Kometa has visibility of (i.e. if using docker, the directory must be mounted/visible to the docker container). - For the sake of this document, we will assume that your assets folders are all based within the directory mapped to `config` within your PMM environment. + For the sake of this document, we will assume that your assets folders are all based within the directory mapped to `config` within your Kometa environment. ```yaml settings: @@ -38,9 +38,9 @@ settings: Assets can be applied to collections [managed or unmanaged], playlists, and media items [movies, shows, seasons, and episodes]. -Managed Collection and Playlist assets are applied whenever that collection/playlist is run. You do not have to specifically enable assets for these items; PMM will always search for and apply them. +Managed Collection and Playlist assets are applied whenever that collection/playlist is run. You do not have to specifically enable assets for these items; Kometa will always search for and apply them. -Item [movie/show/etc] assets and Unmanaged Collections assets have to be specifically enabled before PMM will search for and apply them. Do this by enabling the `assets_for_all` Library Operation: +Item [movie/show/etc] assets and Unmanaged Collections assets have to be specifically enabled before Kometa will search for and apply them. Do this by enabling the `assets_for_all` Library Operation: ```yaml Movies: @@ -60,13 +60,13 @@ If a media item has an asset associated with it, that asset image is taken as th ## Asset Naming -The table below shows the asset folder path structures that will be searched for. There are two options for how Plex Meta Manager looks at the files inside your Asset Directories. Choose an option with the [`asset_folders` Setting Attribute](../../config/settings.md). Note that `asset_folders` is a toggle; you can't put some images in folders and some not in a context where it is enabled. +The table below shows the asset folder path structures that will be searched for. There are two options for how Kometa looks at the files inside your Asset Directories. Choose an option with the [`asset_folders` Setting Attribute](../../config/settings.md). Note that `asset_folders` is a toggle; you can't put some images in folders and some not in a context where it is enabled. -Assets can be stored anywhere on the host system that PMM has visibility of (i.e. if using docker, the directory must be mounted/visible to the docker container). +Assets can be stored anywhere on the host system that Kometa has visibility of (i.e. if using docker, the directory must be mounted/visible to the docker container). ???+ important - The below table assumes that your assets are stored within the directory mapped to `config` in your PMM environment. + The below table assumes that your assets are stored within the directory mapped to `config` in your Kometa environment. | Image Type | Asset Folders Image Paths<br>`asset_folders: true` | Flat Assets Image Paths<br>`asset_folders: false` | |:---------------------------------|:---------------------------------------------------------|:--------------------------------------------------------------| @@ -107,7 +107,7 @@ Assets can be stored anywhere on the host system that PMM has visibility of (i.e /path/to/media/movies/Star Wars (1977) {imdb-tt0076759} {tmdb-11}/Star Wars (1977) [1080p].mp4 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -- THIS IS ASSET_NAME ``` - The asset names that PMM will look for are: + The asset names that Kometa will look for are: ASSET_FOLDERS=True: ``` @@ -134,7 +134,7 @@ Assets can be stored anywhere on the host system that PMM has visibility of (i.e /path/to/media/tv/The Expanse (2015) {tvdb-280619}/Season 01/The Expanse (2015) - S01E01 - Dulcinea.mkv ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -- THIS IS ASSET_NAME ``` - The asset names that PMM will look for are: + The asset names that Kometa will look for are: ASSET_FOLDERS=True: ``` @@ -155,7 +155,7 @@ Assets can be stored anywhere on the host system that PMM has visibility of (i.e /path/to/media/tv/The Expanse (2015) {tvdb-280619}/Season 01/The Expanse (2015) - S01E01 - Dulcinea.mkv ``` - The asset names that PMM will look for are: + The asset names that Kometa will look for are: ASSET_FOLDERS=True: ``` @@ -176,7 +176,7 @@ Assets can be stored anywhere on the host system that PMM has visibility of (i.e /path/to/media/tv/The Expanse (2015) {tvdb-280619}/Season 01/The Expanse (2015) - S01E01 - Dulcinea.mkv ``` - The asset names that PMM will look for are: + The asset names that Kometa will look for are: ASSET_FOLDERS=True: ``` diff --git a/docs/pmm/guides/formula.md b/docs/kometa/guides/formula.md similarity index 96% rename from docs/pmm/guides/formula.md rename to docs/kometa/guides/formula.md index e431e280..b4949eb0 100644 --- a/docs/pmm/guides/formula.md +++ b/docs/kometa/guides/formula.md @@ -64,12 +64,12 @@ Formula -> Library Folder └── 04x15 - Azerbaijan GP - Ted's Race Notebook.mkv ``` -What matters for plex and for pmm. +What matters for plex and for Kometa. * Change the Plex Agent to "Personal Media Shows" for F1 libraries * The show name can be whatever you want it to be but the pre created collection file will only work if you use just the year numbers. * The season folder can be called whatever you want as long as plex scans it in with the Season Number matching the race number. -* The episodes must follow plex's naming convention to have them scanned in properly but in order for PMM to update the metadata the files need to be specifically name like above. +* The episodes must follow plex's naming convention to have them scanned in properly but in order for Kometa to update the metadata the files need to be specifically name like above. ## Collection File diff --git a/docs/pmm/guides/images/ratings-01.png b/docs/kometa/guides/images/ratings-01.png similarity index 100% rename from docs/pmm/guides/images/ratings-01.png rename to docs/kometa/guides/images/ratings-01.png diff --git a/docs/pmm/guides/images/ratings-02.png b/docs/kometa/guides/images/ratings-02.png similarity index 100% rename from docs/pmm/guides/images/ratings-02.png rename to docs/kometa/guides/images/ratings-02.png diff --git a/docs/pmm/guides/images/ratings-03.png b/docs/kometa/guides/images/ratings-03.png similarity index 100% rename from docs/pmm/guides/images/ratings-03.png rename to docs/kometa/guides/images/ratings-03.png diff --git a/docs/pmm/guides/images/ratings-04.png b/docs/kometa/guides/images/ratings-04.png similarity index 100% rename from docs/pmm/guides/images/ratings-04.png rename to docs/kometa/guides/images/ratings-04.png diff --git a/docs/pmm/guides/images/ratings-05.png b/docs/kometa/guides/images/ratings-05.png similarity index 100% rename from docs/pmm/guides/images/ratings-05.png rename to docs/kometa/guides/images/ratings-05.png diff --git a/docs/pmm/guides/images/ratings-06.png b/docs/kometa/guides/images/ratings-06.png similarity index 100% rename from docs/pmm/guides/images/ratings-06.png rename to docs/kometa/guides/images/ratings-06.png diff --git a/docs/pmm/guides/images/ratings-07.png b/docs/kometa/guides/images/ratings-07.png similarity index 100% rename from docs/pmm/guides/images/ratings-07.png rename to docs/kometa/guides/images/ratings-07.png diff --git a/docs/pmm/guides/images/ratings-08.png b/docs/kometa/guides/images/ratings-08.png similarity index 100% rename from docs/pmm/guides/images/ratings-08.png rename to docs/kometa/guides/images/ratings-08.png diff --git a/docs/pmm/guides/images/ratings-09.png b/docs/kometa/guides/images/ratings-09.png similarity index 100% rename from docs/pmm/guides/images/ratings-09.png rename to docs/kometa/guides/images/ratings-09.png diff --git a/docs/pmm/guides/images/ratings-10.png b/docs/kometa/guides/images/ratings-10.png similarity index 100% rename from docs/pmm/guides/images/ratings-10.png rename to docs/kometa/guides/images/ratings-10.png diff --git a/docs/pmm/guides/images/scheduling-01-runner-cmd.png b/docs/kometa/guides/images/scheduling-01-runner-cmd.png similarity index 100% rename from docs/pmm/guides/images/scheduling-01-runner-cmd.png rename to docs/kometa/guides/images/scheduling-01-runner-cmd.png diff --git a/docs/pmm/guides/images/scheduling-02-open-task-scheduler.png b/docs/kometa/guides/images/scheduling-02-open-task-scheduler.png similarity index 100% rename from docs/pmm/guides/images/scheduling-02-open-task-scheduler.png rename to docs/kometa/guides/images/scheduling-02-open-task-scheduler.png diff --git a/docs/pmm/guides/images/scheduling-03-task-scheduler-main.png b/docs/kometa/guides/images/scheduling-03-task-scheduler-main.png similarity index 100% rename from docs/pmm/guides/images/scheduling-03-task-scheduler-main.png rename to docs/kometa/guides/images/scheduling-03-task-scheduler-main.png diff --git a/docs/pmm/guides/images/scheduling-04-basic-task-01.png b/docs/kometa/guides/images/scheduling-04-basic-task-01.png similarity index 100% rename from docs/pmm/guides/images/scheduling-04-basic-task-01.png rename to docs/kometa/guides/images/scheduling-04-basic-task-01.png diff --git a/docs/pmm/guides/images/scheduling-04-basic-task-02.png b/docs/kometa/guides/images/scheduling-04-basic-task-02.png similarity index 100% rename from docs/pmm/guides/images/scheduling-04-basic-task-02.png rename to docs/kometa/guides/images/scheduling-04-basic-task-02.png diff --git a/docs/pmm/guides/images/scheduling-04-basic-task-03.png b/docs/kometa/guides/images/scheduling-04-basic-task-03.png similarity index 100% rename from docs/pmm/guides/images/scheduling-04-basic-task-03.png rename to docs/kometa/guides/images/scheduling-04-basic-task-03.png diff --git a/docs/pmm/guides/images/scheduling-04-basic-task-04.png b/docs/kometa/guides/images/scheduling-04-basic-task-04.png similarity index 100% rename from docs/pmm/guides/images/scheduling-04-basic-task-04.png rename to docs/kometa/guides/images/scheduling-04-basic-task-04.png diff --git a/docs/pmm/guides/images/scheduling-04-basic-task-05.png b/docs/kometa/guides/images/scheduling-04-basic-task-05.png similarity index 100% rename from docs/pmm/guides/images/scheduling-04-basic-task-05.png rename to docs/kometa/guides/images/scheduling-04-basic-task-05.png diff --git a/docs/pmm/guides/images/scheduling-04-basic-task-06.png b/docs/kometa/guides/images/scheduling-04-basic-task-06.png similarity index 100% rename from docs/pmm/guides/images/scheduling-04-basic-task-06.png rename to docs/kometa/guides/images/scheduling-04-basic-task-06.png diff --git a/docs/pmm/guides/images/scheduling-04-basic-task-07.png b/docs/kometa/guides/images/scheduling-04-basic-task-07.png similarity index 100% rename from docs/pmm/guides/images/scheduling-04-basic-task-07.png rename to docs/kometa/guides/images/scheduling-04-basic-task-07.png diff --git a/docs/pmm/guides/images/scheduling-04-basic-task-08.png b/docs/kometa/guides/images/scheduling-04-basic-task-08.png similarity index 100% rename from docs/pmm/guides/images/scheduling-04-basic-task-08.png rename to docs/kometa/guides/images/scheduling-04-basic-task-08.png diff --git a/docs/pmm/guides/images/scheduling-04-basic-task-09.png b/docs/kometa/guides/images/scheduling-04-basic-task-09.png similarity index 100% rename from docs/pmm/guides/images/scheduling-04-basic-task-09.png rename to docs/kometa/guides/images/scheduling-04-basic-task-09.png diff --git a/docs/pmm/guides/images/scheduling-05-waiter-cmd.png b/docs/kometa/guides/images/scheduling-05-waiter-cmd.png similarity index 100% rename from docs/pmm/guides/images/scheduling-05-waiter-cmd.png rename to docs/kometa/guides/images/scheduling-05-waiter-cmd.png diff --git a/docs/pmm/guides/images/scheduling-06-basic-task-01.png b/docs/kometa/guides/images/scheduling-06-basic-task-01.png similarity index 100% rename from docs/pmm/guides/images/scheduling-06-basic-task-01.png rename to docs/kometa/guides/images/scheduling-06-basic-task-01.png diff --git a/docs/pmm/guides/images/scheduling-06-basic-task-02.png b/docs/kometa/guides/images/scheduling-06-basic-task-02.png similarity index 100% rename from docs/pmm/guides/images/scheduling-06-basic-task-02.png rename to docs/kometa/guides/images/scheduling-06-basic-task-02.png diff --git a/docs/pmm/guides/images/scheduling-06-basic-task-03.png b/docs/kometa/guides/images/scheduling-06-basic-task-03.png similarity index 100% rename from docs/pmm/guides/images/scheduling-06-basic-task-03.png rename to docs/kometa/guides/images/scheduling-06-basic-task-03.png diff --git a/docs/pmm/guides/images/scheduling-06-basic-task-04.png b/docs/kometa/guides/images/scheduling-06-basic-task-04.png similarity index 100% rename from docs/pmm/guides/images/scheduling-06-basic-task-04.png rename to docs/kometa/guides/images/scheduling-06-basic-task-04.png diff --git a/docs/pmm/guides/images/scheduling-06-basic-task-05.png b/docs/kometa/guides/images/scheduling-06-basic-task-05.png similarity index 100% rename from docs/pmm/guides/images/scheduling-06-basic-task-05.png rename to docs/kometa/guides/images/scheduling-06-basic-task-05.png diff --git a/docs/pmm/guides/images/scheduling-06-basic-task-06.png b/docs/kometa/guides/images/scheduling-06-basic-task-06.png similarity index 100% rename from docs/pmm/guides/images/scheduling-06-basic-task-06.png rename to docs/kometa/guides/images/scheduling-06-basic-task-06.png diff --git a/docs/pmm/guides/images/scheduling-07-waiter-cmd-times.png b/docs/kometa/guides/images/scheduling-07-waiter-cmd-times.png similarity index 100% rename from docs/pmm/guides/images/scheduling-07-waiter-cmd-times.png rename to docs/kometa/guides/images/scheduling-07-waiter-cmd-times.png diff --git a/docs/kometa/guides/images/step1.png b/docs/kometa/guides/images/step1.png new file mode 100644 index 00000000..1858b6a4 Binary files /dev/null and b/docs/kometa/guides/images/step1.png differ diff --git a/docs/kometa/guides/images/step2.png b/docs/kometa/guides/images/step2.png new file mode 100644 index 00000000..a7fed9c5 Binary files /dev/null and b/docs/kometa/guides/images/step2.png differ diff --git a/docs/kometa/guides/images/step3.png b/docs/kometa/guides/images/step3.png new file mode 100644 index 00000000..17898769 Binary files /dev/null and b/docs/kometa/guides/images/step3.png differ diff --git a/docs/kometa/guides/images/step4.png b/docs/kometa/guides/images/step4.png new file mode 100644 index 00000000..9d808fb7 Binary files /dev/null and b/docs/kometa/guides/images/step4.png differ diff --git a/docs/kometa/guides/images/step5.png b/docs/kometa/guides/images/step5.png new file mode 100644 index 00000000..fde6bb41 Binary files /dev/null and b/docs/kometa/guides/images/step5.png differ diff --git a/docs/kometa/guides/mediux.md b/docs/kometa/guides/mediux.md new file mode 100644 index 00000000..83c64644 --- /dev/null +++ b/docs/kometa/guides/mediux.md @@ -0,0 +1,76 @@ +--- +search: + boost: 2 +--- +# Using MediUX Sets + +Have you noticed the "YAML" button on MediUX but aren't sure what it does? + +Using Kometa, you can automatically apply MediUX assets to the items in your library without having to manually download and/or set each one within Plex. + +This is done using a [Metadata File](../../files/metadata.md). + +## Setting up the Metadata File + +Let's start by creating a folder called "metadata" within the `config` directory of our system. I will then create a file called "mediux.yml" within that folder. + +For now, we will just add a simple line to start the `mediux.yml` file: + +```yaml +metadata: +``` + +You should have something like this: + +![Step 1](images/step1.png) + + +## Adding your Set + +!!! danger "Important" + + It is imperative that the `metadata:` line only appears **once** within the mediux.yml file. If it appears more than once, the file will not load in Kometa and your assets will not be set. + + If your Set in MediUX includes a `metadata:` line, you should remove it and only have `metadata:` appearing on line 1 of your `mediux.yml` file. + +Now let's navigate to the MediUX website and find the Set that we want to use. In this case, I'm going to use [Olivier_286's Toy Story Collection Set](https://mediux.pro/sets/15639) + +Once I have logged in to MediUX, I can click on the "YAML" button here: + +![Step 2](images/step2.png) + +I am now presented with a "Copy Links" button which includes the YAML code I need to set the assets from the Set against my library. + +!!! tip "Tip" + + At present, Kometa cannot set Collection images from Metadata files. This is a known limitation. + + In this example, the "Toy Story Collection" image is not present in the "Copy Links" pop-up, you would need to manually set the Collection image yourself. + +I will click the copy button highlighted: + +![Step 3](images/step3.png) + +And now I will paste it directly into my `mediux.yml` file, and it now looks like this: + +![Step 4](images/step4.png) + +The file can now be saved and is ready for use. + +## Running the Metadata File + +Now that my metadata file is ready, I can run it against my library. + +I will open my `config.yml` file and add the `mediux.yml` within the `metadata_files` section of my Movies library: + +My config.yml `libraries` section now looks like this: +```yaml +libraries: + Movies: + metadata_files: + - file: config/metadata/mediux.yml +``` + +After running Kometa and navigating to Plex, I can see that my posters for the Toy Story movies have been updated with the images from the Set in MediUX: + +![Step 5](images/step5.png) diff --git a/docs/kometa/guides/overview.md b/docs/kometa/guides/overview.md new file mode 100644 index 00000000..16ae929e --- /dev/null +++ b/docs/kometa/guides/overview.md @@ -0,0 +1,95 @@ +# Kometa Guides, Explanations & Recipes + +This page outlines the explanations, guides and recipes that will help you understand certain aspects of Kometa that may not be easily understood without expanded context or examples that would be difficult to provide in the standard wiki pages. + +Special credit to [Chazlarson](https://github.com/chazlarson) for the time and effort he has spent developing a lot of these guides. + +## Installation Guides + +These guides will walk you through installing Kometa on your system. + +- [Local (Win/Mac/Linux)](../install/local.md) +- [Docker](../install/docker.md) +- [unRAID](../install/unraid.md) +- [Kubernetes](../install/kubernetes.md) +- [QNAP](../install/qnap.md) +- [Synology](../install/synology.md) + +## Explanations + +The below guides and recipes have been created to assist users with various aspects of Komets and its companion scripts. + +- [Plex Ratings Explained](ratings.md) +- [Scheduling Kometa Runs Guide](scheduling.md) +- [Image Asset Directory Guide](assets.md) +- [Log Files](../logs.md) +- [Understanding YAML File Syntax](../yaml.md) +- [Formula 1 Metadata Edit Guide](formula.md) +- [Using MediUX Sets Guide](mediux.md) + +- {% + include-markdown "https://raw.githubusercontent.com/Kometa-Team/Cookbook/main/guides/README.md" +%} + +## Recipes + +A lot of these guides are stored on Google Drive as using the traditional wiki pages would make the formatting difficult to understand. + +{% + include-markdown "https://raw.githubusercontent.com/Kometa-Team/Cookbook/main/cookbook/README.md" +%} + +## Associated Git Repos + +- [Kometa Community Configs](https://github.com/Kometa-Team/Community-Configs) + - Kometa's Community submitted Config Repo + +<br> + +- [ImageMaid](https://github.com/Kometa-Team/ImageMaid) + - Removes Image bloat from your Plex Server +- [Kometa Overlay Reset](https://github.com/Kometa-Team/Overlay-Reset) + - Resets your Library back to default images removing all overlays +- [Kometa Anime IDs](https://github.com/Kometa-Team/Anime-IDs) + - How Kometa translates Anime IDs to TVDB IDs +- [Kometa IMDb Awards](https://github.com/Kometa-Team/IMDb-Awards) + - How Kometa stores the IMDB Award Lists +- [Kometa Mediastingers](https://github.com/Kometa-Team/Mediastingers) + - How Kometa stores the Mediastingers List + +<br> + +- [ArrAPI](https://github.com/Kometa-Team/ArrAPI) + - Module to interface with Radarr/Sonarr +- [TMDbAPIs](https://github.com/Kometa-Team/TMDbAPIs) + - Module to interface with TMDb +- [kometautils](https://github.com/Kometa-Team/Kometa-Utils) + - Module for various common files among Kometa Repos + +<br> + +- [Default Images](https://github.com/Kometa-Team/Default-Images) + - Repo to store Kometa's various Images for the Defaults +- [People Auto Readme](https://github.com/Kometa-Team/People-Auto-Readme) + - Stores the File that generates the Readme file for the other Actor repos +- [People Images](https://github.com/Kometa-Team/People-Images) + - Stores the original image for all our actor posters +- [People Images Black & White (bw)](https://github.com/Kometa-Team/People-Images-bw) + - Stores the Black & White actor posters +- [People Images Rainier (rainier)](https://github.com/Kometa-Team/People-Images-rainier) + - Stores the Rainier actor posters +- [People Images Signature (signature)](https://github.com/Kometa-Team/People-Images-signature) + - Stores the Signature actor posters +- [People Images DIIVOY (diiivoy)](https://github.com/Kometa-Team/People-Images-diiivoy) + - Stores the DIIVOY actor posters +- [People Images DIIVOY Color (diiivoycolor)](https://github.com/Kometa-Team/People-Images-diiivoycolor) + - Stores the DIIVOY Color actor posters +- [People Images Transparent (transparent)](https://github.com/Kometa-Team/People-Images-transparent) + - Stores the Transparent actor posters + +<br> + +- [Unraid Templates](https://github.com/Kometa-Team/Unraid-Templates) + - Stores the Kometa Unraid Templates +- [Translations](https://github.com/Kometa-Team/Translations) + - Stores the data for Kometa Translations \ No newline at end of file diff --git a/docs/pmm/guides/ratings.md b/docs/kometa/guides/ratings.md similarity index 81% rename from docs/pmm/guides/ratings.md rename to docs/kometa/guides/ratings.md index 4facbe1f..4e66f7fb 100644 --- a/docs/pmm/guides/ratings.md +++ b/docs/kometa/guides/ratings.md @@ -2,9 +2,9 @@ search: boost: 2 --- -# Plex Meta Manager Ratings Explained +# Kometa Ratings Explained -How do ratings and ratings overlays work in Plex Meta Manager? This Guide will walk through some basics of how ratings work in conjunction with Plex Meta Manager. +How do ratings and ratings overlays work in Kometa? This Guide will walk through some basics of how ratings work in conjunction with Kometa. <h4>Basics</h4> @@ -12,7 +12,7 @@ Each thing in Plex that can have a rating [movie, show, episode, album, track] h The Critic and Audience ratings are typically managed by Plex, pulling from whatever you specify as the ratings source for the library; this is what determines the images that are displayed in the Plex UI. The User rating is the star rating assigned by you to the item. -Plex Meta Manager can insert a broader range of values into those fields than Plex supports natively, then it can leverage those values in overlays and the like. +Kometa can insert a broader range of values into those fields than Plex supports natively, then it can leverage those values in overlays and the like. It's doing this "behind Plex's back", so there can be some seeming inconsistencies in the way things are displayed in the UI. This guide is intended to clear up some of these things. @@ -41,7 +41,7 @@ Now let's add rating overlays to the poster. We're going to use the minimal conf One Movie: reapply_overlays: true overlay_files: - - pmm: ratings + - default: ratings template_variables: rating1: critic rating1_image: rt_tomato @@ -55,16 +55,16 @@ Now let's add rating overlays to the poster. We're going to use the minimal conf * `rating3` is set to be the user rating and it's image (`rating3_image`) is set to IMDb just because we have to pick something. - * `reapply_overlays` is set to true to ensure that Plex Meta Manager always updates the overlays as we run things. + * `reapply_overlays` is set to true to ensure that Kometa always updates the overlays as we run things. * We do not recommend using `reapply_overlays: true` consistently in a live/production environment, make sure to switch this back to `false` when finished. -After Plex Meta Manager is run on this library, you'll get this result: +After Kometa is run on this library, you'll get this result: ![](images/ratings-03.png) -* Plex Meta Manager has added those two ratings to the poster using the values already stored with the movie. The icons and values are correctly associated simply because we made sure they are in the config file. +* Kometa has added those two ratings to the poster using the values already stored with the movie. The icons and values are correctly associated simply because we made sure they are in the config file. * The two ratings match, and there is no IMDb rating icon on the poster since there is no user rating. (no star rating on the right) @@ -72,17 +72,17 @@ Now we're going to add a user rating by clicking the middle star on the right fo ![](images/ratings-04.png) -Now just run Plex Meta Manager again without changing anything else and the user rating overlay will appear: +Now just run Kometa again without changing anything else and the user rating overlay will appear: ![](images/ratings-05.png) -* Plex Meta Manager added the third rating overlay, since there is now a value in the user rating. +* Kometa added the third rating overlay, since there is now a value in the user rating. * It gave it an IMDb icon because we told it to in the config file. ([Why does it say 250 instead of IMDb?](#why-do-different-images-appear-for-the-same-source)) * It's displaying 6.0 since 3 stars on a 5-star scale is 60%. #### Change Rating Image -You and I both know that the IMDb rating isn't 6.0, but Plex Meta Manager is just doing what it's told. Nobody but us humans know where those numbers come from. As an example, let's change the icons to "prove" that Plex Meta Manager doesn't know or care: +You and I both know that the IMDb rating isn't 6.0, but Kometa is just doing what it's told. Nobody but us humans know where those numbers come from. As an example, let's change the icons to "prove" that Kometa doesn't know or care: ??? example "Updated config (click to expand)" @@ -91,7 +91,7 @@ You and I both know that the IMDb rating isn't 6.0, but Plex Meta Manager is jus One Movie: reapply_overlays: true overlay_files: - - pmm: ratings + - default: ratings template_variables: rating1: critic rating1_image: imdb @@ -110,8 +110,8 @@ When the above is run you see this result: ![](images/ratings-06.png) * Three different ratings on the poster, all IMDb; All while the Plex UI still shows RT icons. -* Note that the existing RT ratings numbers (`93%` and `96%`) display on the poster as `9.3` and `9.6`. This is happening because we just told Plex Meta Manager that those ratings were IMDb, and IMDb ratings are on a 1-10 scale. Plex Meta Manager doesn't "know" where those numbers are from, it just does what it's told to do and places the value (critic/audience/user) in that rating box. -* That first overlay showing an IMDb rating of `9.3` is not evidence that Plex Meta Manager pulled the wrong IMDb rating; it just shows that it has been told to display the number in the critic rating box (whatever that number is) as an IMDb rating. All three of those overlays mean the same thing; Plex Meta Manager read a number from a field and stuck it on the poster formatted as requested. +* Note that the existing RT ratings numbers (`93%` and `96%`) display on the poster as `9.3` and `9.6`. This is happening because we just told Kometa that those ratings were IMDb, and IMDb ratings are on a 1-10 scale. Kometa doesn't "know" where those numbers are from, it just does what it's told to do and places the value (critic/audience/user) in that rating box. +* That first overlay showing an IMDb rating of `9.3` is not evidence that Kometa pulled the wrong IMDb rating; it just shows that it has been told to display the number in the critic rating box (whatever that number is) as an IMDb rating. All three of those overlays mean the same thing; Kometa read a number from a field and stuck it on the poster formatted as requested. #### Update User Ratings @@ -124,7 +124,7 @@ Now let's actually update the ratings and push some numbers into those boxes usi One Movie: reapply_overlays: true overlay_files: - - pmm: ratings + - default: ratings template_variables: rating1: critic rating1_image: rt_tomato @@ -162,7 +162,7 @@ Now let's update the critic and audience ratings to some different ratings: One Movie: reapply_overlays: true overlay_files: - - pmm: ratings + - default: ratings template_variables: rating1: critic rating1_image: rt_tomato @@ -188,7 +188,7 @@ Running the above will put the Trakt User's personal rating into the critic box * Audience rating matches the TMDb rating of `82%`. * Note how the values have changed dramatically and all match between the overlay, plex ratings, and external sites. -The log will show Plex Meta Manager updating those values. +The log will show Kometa updating those values. ``` | Processing: 1/1 Star Wars: Episode IV - A New Hope | @@ -197,7 +197,7 @@ The log will show Plex Meta Manager updating those values. | Critic Rating | 6.0 | ``` -* And the poster reflects those numbers, though with the wrong icons, since that's what **Plex Meta Manager has been told to do**. +* And the poster reflects those numbers, though with the wrong icons, since that's what **Kometa has been told to do**. * The Plex UI still shows RT icons, and it always will, even though the numbers displayed are no longer RT ratings. Plex has no idea. #### Use Trakt Rating @@ -211,7 +211,7 @@ Let's change the Trakt rating to that trakt public rating of `85%` instead, whic One Movie: reapply_overlays: true overlay_files: - - pmm: ratings + - default: ratings template_variables: rating1: critic rating1_image: rt_tomato @@ -246,7 +246,7 @@ Now, finally, let's make the poster rating images match the numbers we put in th One Movie: reapply_overlays: true overlay_files: - - pmm: ratings + - default: ratings template_variables: rating1: critic rating1_image: trakt @@ -274,7 +274,7 @@ This config file is the **only linkage** between the ratings we are setting and You can see that the Plex UI still shows the RT icons with the Trakt and TMDb numbers we put into the relevant fields, since again, it has no idea those numbers got changed behind its back. -The poster displays the correct icons because we told Plex Meta Manager to do so in the config file. +The poster displays the correct icons because we told Kometa to do so in the config file. ## Why do different Images appear for the same source? diff --git a/docs/pmm/guides/scheduling.md b/docs/kometa/guides/scheduling.md similarity index 58% rename from docs/pmm/guides/scheduling.md rename to docs/kometa/guides/scheduling.md index eba056f8..09e8b485 100644 --- a/docs/pmm/guides/scheduling.md +++ b/docs/kometa/guides/scheduling.md @@ -2,52 +2,52 @@ search: boost: 3 --- -# Scheduling PMM Runs Guide +# Scheduling Kometa Runs Guide -Plex Meta Manager is designed to be a background running service that "wakes up" and "sleeps" when it is scheduled to do so. By default unless configured using the [Time to Run Command](../environmental.md#time-to-run), Plex Meta Manager expects to run every day at 5AM local time. +Kometa is designed to be a background running service that "wakes up" and "sleeps" when it is scheduled to do so. By default unless configured using the [Time to Run Command](../environmental.md#time-to-run), Kometa expects to run every day at 5AM local time. -Whilst it is possible to have `python plex-meta-manager.py` running in an open window constantly, this is not the recommended approach as it relies on an always-open command window that can be obtrusive to the user. +Whilst it is possible to have `python kometa.py` running in an open window constantly, this is not the recommended approach as it relies on an always-open command window that can be obtrusive to the user. -Instead, it is recommended to set an automated scheduling service so that Plex Meta Manager can run in the background when scheduled to without any visible impact to the user (other than the Plex libraries and playlists updating). +Instead, it is recommended to set an automated scheduling service so that Kometa can run in the background when scheduled to without any visible impact to the user (other than the Plex libraries and playlists updating). -**To control how individual parts of Plex Meta Manager are scheduled see the [Schedule detail](../../config/schedule.md)** +**To control how individual parts of Kometa are scheduled see the [Schedule detail](../../config/schedule.md)** IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path to that directory on *your* system. === "Docker" - Using docker is the simplest and most robust solution to automating Plex Meta Manager scheduling. + Using docker is the simplest and most robust solution to automating Kometa scheduling. - When running Plex Meta Manager within docker, the session will resume after a system reboot (assuming Docker is set to start at system startup, which is the default) and Plex Meta Manager will run in the background at all times. + When running Kometa within docker, the session will resume after a system reboot (assuming Docker is set to start at system startup, which is the default) and Kometa will run in the background at all times. - There's a [Docker Walkthrough](../install/docker.md) with more detailed instructions on setting up Plex Meta Manager within docker. The simplest command to facilitate a docker run is: + There's a [Docker Walkthrough](../install/docker.md) with more detailed instructions on setting up Kometa within docker. The simplest command to facilitate a docker run is: ``` docker run -d \ --restart=unless-stopped \ -e TZ=<TIMEZONE> \ -v /path/to/config:/config:rw \ - meisnate12/plex-meta-manager + kometateam/kometa ``` - Change `/path/to/config` to reflect where you've installed Plex Meta Manager. + Change `/path/to/config` to reflect where you've installed Kometa. TZ=<TIMEZONE> - <TIMEZONE> is replaced with your local timezone, or the timezone your device is in that is running Plex Meta Manager. For a list of available timezones, please see [Timezones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). You want to replace <TIMEZONE> with the TZ Database Name. + <TIMEZONE> is replaced with your local timezone, or the timezone your device is in that is running Kometa. For a list of available timezones, please see [Timezones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). You want to replace <TIMEZONE> with the TZ Database Name. ``` TZ=America/New_York ``` - This will run Plex Meta Manager in the background persistently until it is stopped by the user. While the docker container will be persistently running, Plex Meta Manager will not begin the run until the scheduled time. + This will run Kometa in the background persistently until it is stopped by the user. While the docker container will be persistently running, Kometa will not begin the run until the scheduled time. - Further customizations of the docker run command can be used to specify set times to run Plex Meta Manager, further information on this and other Run Commands can be found [here](../environmental.md#time-to-run) + Further customizations of the docker run command can be used to specify set times to run Kometa, further information on this and other Run Commands can be found [here](../environmental.md#time-to-run) === "Windows Task Scheduler" - Windows Task Scheduler is advised for those who followed the Windows instructions in the [Local Walkthrough Guides](../install/local.md) and/or do not want to run Plex Meta Manager within docker. + Windows Task Scheduler is advised for those who followed the Windows instructions in the [Local Walkthrough Guides](../install/local.md) and/or do not want to run Kometa within docker. Windows Task Scheduler allows the user to run commands and services at scheduled times and intervals. - There are two methods of running Plex Meta Manager: + There are two methods of running Kometa: * Single run Scheduled Task * Background run Scheduled Task @@ -57,9 +57,9 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path ### Background Run Scheduled Task - This method will start Plex Meta Manager at system startup and will keep Plex Meta Manager running in the background indefinitely. The user can then define set days and times for the Configuration File to be processed, and Plex Meta Manager will handle processing as and when required. + This method will start Kometa at system startup and will keep Kometa running in the background indefinitely. The user can then define set days and times for the Configuration File to be processed, and Kometa will handle processing as and when required. - This is the recommended approach as it allows the user additional control over how and when Plex Meta Manager processes. + This is the recommended approach as it allows the user additional control over how and when Kometa processes. If you don't specify a time, the script will run at 5AM each day. You can change this with the [time-to-run](../environmental.md#time-to-run) runtime flag. @@ -68,10 +68,10 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path 1. Create a `waiter.cmd` file by opening the text editor (i.e. Notepad, TextEdit) and pasting the following code: ```batch - cd C:\Users\USERNAMEHERE\Plex-Meta-Manager - .\pmm-venv\Scripts\python .\plex_meta_manager.py + cd C:\Users\USERNAMEHERE\Kometa + .\kometa-venv\Scripts\python .\kometa.py ``` - * This will navigate to the Plex Meta Manager directory, then run PMM. At the scheduled time [as defined within Plex Meta Manager], PMM will process the Configuration File and will then wait until the next scheduled time. + * This will navigate to the Kometa directory, then run Kometa. At the scheduled time [as defined within Kometa], Kometa will process the Configuration File and will then wait until the next scheduled time. 2. Open Task Scheduler by searching for it in the Start Menu or by opening the Run window (Windows + R) and typing taskschd.msc before hitting OK. @@ -83,11 +83,11 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path ![task-scheduler](images/scheduling-03-task-scheduler-main.png) - 4. Give the task a name, in this example `Background PMM` and then select "Next" + 4. Give the task a name, in this example `Background Kometa` and then select "Next" ![task-scheduler](images/scheduling-06-basic-task-02.png) - 5. Choose the frequency that PMM should run and then select "Next", `When the computer starts` is recommended. + 5. Choose the frequency that Kometa should run and then select "Next", `When the computer starts` is recommended. ![task-scheduler](images/scheduling-06-basic-task-03.png) @@ -95,36 +95,36 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path ![task-scheduler](images/scheduling-06-basic-task-04.png) - 7. Click "Browse", Navigate to the PMM directory and choose `waiter.cmd`, which was created in Step 1, then select "Open". NOTE: Your path may vary from the illustration here; navigate to the file you created and saved in Step 1. + 7. Click "Browse", Navigate to the Kometa directory and choose `waiter.cmd`, which was created in Step 1, then select "Open". NOTE: Your path may vary from the illustration here; navigate to the file you created and saved in Step 1. ![task-scheduler](images/scheduling-06-basic-task-05.png) - 8. Copy the directory everything up to but not including `waiter.cmd` from the "Program/Script" field, and paste it into the "Start in" field. This is `C:\User\IEUser\Plex-Meta-Manager-1.15.1` in the example below, then select "next". NOTE: Your path may vary from the illustration or example. + 8. Copy the directory everything up to but not including `waiter.cmd` from the "Program/Script" field, and paste it into the "Start in" field. This is `C:\User\IEUser\Kometa-1.15.1` in the example below, then select "next". NOTE: Your path may vary from the illustration or example. ![task-scheduler](images/scheduling-06-basic-task-06.png) 9. Click "Finish". - 10. Click "Task Schedule Library" on the left. The "Background PMM" task should be visible. + 10. Click "Task Schedule Library" on the left. The "Background Kometa" task should be visible. - Plex Meta Manager will now launch at system startup, but will wait until the user-specified scheduled time before executing, and will then wait in the background for the next scheduled run. + Kometa will now launch at system startup, but will wait until the user-specified scheduled time before executing, and will then wait in the background for the next scheduled run. ### Single Run Scheduled Task - This method will start Plex Meta Manager at the desired time, immediately begin running the Configuration File and will then kill the process once it has completed. + This method will start Kometa at the desired time, immediately begin running the Configuration File and will then kill the process once it has completed. ??? abstract "Single Run Scheduled Task" 1. Create a `runner.cmd` file by opening the text editor (i.e. Notepad, TextEdit) and pasting the following code: ```batch - cd C:\Users\USERNAMEHERE\Plex-Meta-Manager - .\pmm-venv\Scripts\python .\plex_meta_manager.py --run + cd C:\Users\USERNAMEHERE\Kometa + .\kometa-venv\Scripts\python .\kometa.py --run ``` - * This will navigate to the PMM directory, then launch PMM using the `-r`/`--run` flag which triggers an immediate run. Once complete, Plex Meta Manager will exit. + * This will navigate to the Kometa directory, then launch Kometa using the `-r`/`--run` flag which triggers an immediate run. Once complete, Kometa will exit. - Save this file to C:\Users\USERNAMEHERE\Plex-Meta-Manager\runner.cmd`. + Save this file to C:\Users\USERNAMEHERE\Kometa\runner.cmd`. 2. Open Task Scheduler by searching for it in the Start Menu or by opening the Run window (Windows + R) and typing taskschd.msc before hitting OK. @@ -136,15 +136,15 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path ![task-scheduler](images/scheduling-03-task-scheduler-main.png) - 4. Give the task a name, in this example `Run PMM` and then select "Next" + 4. Give the task a name, in this example `Run Kometa` and then select "Next" ![task-scheduler](images/scheduling-04-basic-task-01.png) - 5. Choose the frequency that PMM should run and then select "Next", `Daily` is recommended. + 5. Choose the frequency that Kometa should run and then select "Next", `Daily` is recommended. ![task-scheduler](images/scheduling-04-basic-task-02.png) - 6. Specify the first date and time at which PMM should run and then select "Next". + 6. Specify the first date and time at which Kometa should run and then select "Next". ![task-scheduler](images/scheduling-04-basic-task-03.png) @@ -152,11 +152,11 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path ![task-scheduler](images/scheduling-04-basic-task-04.png) - 8. Click "Browse", Navigate to the PMM directory and choose `runner.cmd`, which was created in Step 1, then select "Open". + 8. Click "Browse", Navigate to the Kometa directory and choose `runner.cmd`, which was created in Step 1, then select "Open". ![task-scheduler](images/scheduling-04-basic-task-05.png) - 9. Copy the directory everything up to but not including `runner.cmd` from the "Program/Script" field, and paste it into the "Start in" field. This is `C:\User\IEUser\Plex-Meta-Manager-1.15.1` in the example below, then select "next". + 9. Copy the directory everything up to but not including `runner.cmd` from the "Program/Script" field, and paste it into the "Start in" field. This is `C:\User\IEUser\Kometa-1.15.1` in the example below, then select "next". ![task-scheduler](images/scheduling-04-basic-task-06.png) @@ -164,11 +164,11 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path ![task-scheduler](images/scheduling-04-basic-task-07.png) - 11. Click "Task Schedule Library" on the left. The PMM Run task should be visible. + 11. Click "Task Schedule Library" on the left. The Kometa Run task should be visible. ![task-scheduler](images/scheduling-04-basic-task-09.png) - Plex Meta Manager will now run at the set date/time you selected in Step 6, and will run each subsequent day at the same time. + Kometa will now run at the set date/time you selected in Step 6, and will run each subsequent day at the same time. === "MacOS Launchd Service" @@ -177,9 +177,9 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path A couple examples; you'll want to edit the THINGS IN ALL CAPS to reflect your system. - Change `/path/to/plex-meta-manager` to reflect where you've installed Plex Meta Manager. + Change `/path/to/kometa` to reflect where you've installed Kometa. - Keep PMM running constantly, let it wait to do its thing at 3AM: + Keep Kometa running constantly, let it wait to do its thing at 3AM: ``` <?xml version="1.0" encoding="UTF-8"?> @@ -187,22 +187,22 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path <plist version="1.0"> <dict> <key>Label</key> - <string>com.YOUR_USERNAME.plex-meta-manager</string> + <string>com.YOUR_USERNAME.kometa</string> <key>ProgramArguments</key> <array> <string>sh</string> <string>-c</string> - <string>pmm-venv/bin/python plex-meta-manager.py --config /path/to/plex-meta-managerconfig/config.yml</string> + <string>kometa-venv/bin/python kometa.py --config /path/to/kometa-config/config.yml</string> </array> <key>UserName</key> <string>YOUR_USERNAME</string> <key>WorkingDirectory</key> - <string>/PATH/TO/PMM</string> + <string>/PATH/TO/KOMETA</string> </dict> </plist> ``` - Run PMM every 6 hours, running it immediately and letting it quit: + Run Kometa every 6 hours, running it immediately and letting it quit: ``` <?xml version="1.0" encoding="UTF-8"?> @@ -210,12 +210,12 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path <plist version="1.0"> <dict> <key>Label</key> - <string>com.YOUR_USERNAME.plex-meta-manager</string> + <string>com.YOUR_USERNAME.kometa</string> <key>ProgramArguments</key> <array> <string>sh</string> <string>-c</string> - <string>pmm-venv/bin/python plex-meta-manager.py --config /path/to/plex-meta-managerconfig/config.yml --run</string> + <string>kometa-venv/bin/python kometa.py --config /path/to/kometa-config/config.yml --run</string> </array> <key>StartCalendarInterval</key> <array> @@ -239,14 +239,14 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path <key>UserName</key> <string>YOUR_USERNAME</string> <key>WorkingDirectory</key> - <string>/PATH/TO/PMM</string> + <string>/PATH/TO/KOMETA</string> </dict> </plist> ``` A useful tool to generate these plist files is [https://zerolaunched.herokuapp.com/](https://zerolaunched.herokuapp.com/) - Save this file as `com.YOUR_USERNAME.plex-meta-manager.plist` in `~/Library/LaunchAgents`. + Save this file as `com.YOUR_USERNAME.kometa.plist` in `~/Library/LaunchAgents`. 2. Load and start the agent 🚀 @@ -256,13 +256,13 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path ``` cd ~/Library/LaunchAgents/ - launchctl bootstrap gui/YOUR-USER-ID com.YOUR_USERNAME.plex-meta-manager.plist + launchctl bootstrap gui/YOUR-USER-ID com.YOUR_USERNAME.kometa.plist ``` And then kick-start it with: ``` - launchctl kickstart -k gui/YOUR-USER-ID/com.YOUR_USERNAME.plex-meta-manager + launchctl kickstart -k gui/YOUR-USER-ID/com.YOUR_USERNAME.kometa ``` Note that this command uses the *label*, not the plist filename. The -k options means that the service will first be killed, if running. @@ -274,15 +274,15 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path 1. Create the service file: ```bash - sudo nano /etc/systemd/system/plex-meta-manager.service + sudo nano /etc/systemd/system/kometa.service ``` Put the following into the file: ``` - # /etc/systemd/system/plex-meta-manager.service + # /etc/systemd/system/kometa.service [Unit] - Description=Plex Meta Manager + Description=Kometa After=network-online.target [Service] @@ -291,8 +291,8 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path Type=simple Environment=LC_ALL=C.UTF-8 Environment=LANG=C.UTF-8 - WorkingDirectory=/path/to/plex-meta-manager - ExecStart=/path/to/plex-meta-manager/pmm-venv/bin/python /path/to/plex-meta-manager/plex_meta_manager.py + WorkingDirectory=/path/to/kometa + ExecStart=/path/to/kometa/kometa-venv/bin/python /path/to/kometa/kometa.py Restart=always RestartSec=10 @@ -302,9 +302,9 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path Change `USER` and `GROUP` to reflect your user and group. - Change `/path/to/plex-meta-manager` to reflect where you've installed Plex Meta Manager. + Change `/path/to/kometa` to reflect where you've installed Kometa. - NOTE: This is assuming you created the `pmm-venv` virtual environment as described in the [Local Walkthrough](../install/local.md) + NOTE: This is assuming you created the `kometa-venv` virtual environment as described in the [Local Walkthrough](../install/local.md) Save and close the file. @@ -312,19 +312,19 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path ```shell sudo systemctl daemon-reload - sudo systemctl start plex-meta-manager.service + sudo systemctl start kometa.service ``` 3. You can check whether the service is running with: ```shell - sudo systemctl status plex-meta-manager.service + sudo systemctl status kometa.service ``` === "cron" The cron utility is used for running scripts and commands at regular intervals, and at specific times and dates. It’s built into most Operating Systems (namely Linux and Mac), and provides a very useful way to schedule tasks on your server. It also works for running Docker commands on a schedule. - 1. Decide when you want to run Plex Meta Manager + 1. Decide when you want to run Kometa `cron` needs a specific syntax to express schedules. A cron schedule is something like "Every Tuesday at 4" or "5 minutes past every other hour". @@ -335,13 +335,13 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path A command you could use for this: ``` - cd /path/to/plex-meta-manager && pmm-venv/bin/python plex_meta_manager.py --config config/config.yml --run + cd /path/to/kometa && kometa-venv/bin/python kometa.py --config config/config.yml --run ``` - Change `/path/to/plex-meta-manager` to reflect where you've installed Plex Meta Manager. + Change `/path/to/kometa` to reflect where you've installed Kometa. This is an example, which does nothing but run the script immediately. If you want to add additional flags you can do so. - NOTE: This is assuming you created the `pmm-venv` virtual environment as described in the [Local Walkthrough](../install/local.md) + NOTE: This is assuming you created the `kometa-venv` virtual environment as described in the [Local Walkthrough](../install/local.md) 2. Open the system crontab for editing: diff --git a/docs/pmm/images/movie-collection-preview.png b/docs/kometa/images/movie-collection-preview.png similarity index 100% rename from docs/pmm/images/movie-collection-preview.png rename to docs/kometa/images/movie-collection-preview.png diff --git a/docs/pmm/images/movie-library-preview.png b/docs/kometa/images/movie-library-preview.png similarity index 100% rename from docs/pmm/images/movie-library-preview.png rename to docs/kometa/images/movie-library-preview.png diff --git a/docs/pmm/images/show-collection-preview.png b/docs/kometa/images/show-collection-preview.png similarity index 100% rename from docs/pmm/images/show-collection-preview.png rename to docs/kometa/images/show-collection-preview.png diff --git a/docs/pmm/images/show-library-preview.png b/docs/kometa/images/show-library-preview.png similarity index 100% rename from docs/pmm/images/show-library-preview.png rename to docs/kometa/images/show-library-preview.png diff --git a/docs/pmm/install/docker.md b/docs/kometa/install/docker.md similarity index 76% rename from docs/pmm/install/docker.md rename to docs/kometa/install/docker.md index 0c80180b..93006678 100644 --- a/docs/pmm/install/docker.md +++ b/docs/kometa/install/docker.md @@ -1,6 +1,6 @@ # Docker Walkthrough -This article will walk you through getting Plex Meta Manager set up and running via Docker. It will cover: +This article will walk you through getting Kometa set up and running via Docker. It will cover: 1. Installing Docker 2. Retrieving the image @@ -11,9 +11,9 @@ This article will walk you through getting Plex Meta Manager set up and running The specific steps you will be taking: 1. Verify that Docker is installed and install it if not -2. Use `docker` to retrieve the Plex Meta Manager Docker image +2. Use `docker` to retrieve the Kometa Docker image 3. Create a directory for your config files and learn how to tell Docker to use it -4. Gather two things that Plex Meta Manager requires: +4. Gather two things that Kometa requires: - TMDb API Key - Plex URL and Token 5. Then, iteratively: @@ -22,9 +22,9 @@ The specific steps you will be taking: Note that running a Docker container is inherently a pretty technical process. If you are unable or unwilling to learn the rudiments of using Docker, this may not be the tool for you. -If the idea of editing YAML files by hand is daunting, this may not be the tool for you. All the configuration of Plex Meta Manager is done via YAML text files, so if you are unable or unwilling to learn how those work, you should stop here. +If the idea of editing YAML files by hand is daunting, this may not be the tool for you. All the configuration of Kometa is done via YAML text files, so if you are unable or unwilling to learn how those work, you should stop here. -Finally, this walkthrough is intended to give you a basic grounding in how to get Plex Meta Manager running. It doesn't cover how to create your own collections, or how to add overlays, or any of the myriad other things Plex Meta Manager is capable of. It provides a simple "Getting Started" guide for those for whom the standard install instructions make no sense; presumably because you've never run a Docker container before. +Finally, this walkthrough is intended to give you a basic grounding in how to get Kometa running. It doesn't cover how to create your own collections, or how to add overlays, or any of the myriad other things Kometa is capable of. It provides a simple "Getting Started" guide for those for whom the standard install instructions make no sense; presumably because you've never run a Docker container before. ## Prerequisites @@ -108,14 +108,14 @@ If that doesn't work, stop here until you fix that. Diagnoing and repairing Doc #### Important note on Docker images -This tutorial uses the official image, and you should, too. Don't change `meisnate12/plex-meta-manager` to the `linuxserver.io` image or any other; other images may have [idiosyncracies](images.md) that will prevent this walkthrough from working. The official image *will* behave exactly as documented below. Others very possibly won't. +This tutorial uses the official image, and you should, too. Don't change `kometateam/kometa` to the `linuxserver.io` image or any other; other images may have [idiosyncracies](images.md) that will prevent this walkthrough from working. The official image *will* behave exactly as documented below. Others very possibly won't. -The great thing about Docker is that all the setup you'd have to do to run Plex Meta Manager is already done inside the docker image. +The great thing about Docker is that all the setup you'd have to do to run Kometa is already done inside the docker image. That means we can just jump right into running it. At the command prompt, type: ``` -docker run --rm meisnate12/plex-meta-manager --run +docker run --rm kometateam/kometa --run ``` @@ -124,8 +124,8 @@ This is going to fail with an error. That's expected. You should see something like this: ``` { .shell .no-copy } -Unable to find image 'meisnate12/plex-meta-manager:latest' locally -latest: Pulling from meisnate12/plex-meta-manager +Unable to find image 'kometateam/kometa:latest' locally +latest: Pulling from kometateam/kometa 7d63c13d9b9b: Already exists 6ad2a11ca37b: Already exists 8076cdef4689: Pull complete @@ -136,7 +136,7 @@ ed6716577767: Pull complete 0547721ab7a3: Pull complete ea4d35bce959: Pull complete Digest: sha256:472be179a75259e07e68a3da365851b58c2f98383e02ac815804299da6f99824 -Status: Downloaded newer image for meisnate12/plex-meta-manager:latest +Status: Downloaded newer image for kometateam/kometa:latest Config Error: config not found at //config ``` @@ -144,7 +144,7 @@ That error means you don’t have a config file, but we know that most everythin ### Setting up a volume map -Plex Meta Manager, inside that Docker container, can only see other things *inside the container*. We want to add our own files for config and metadata, so we need to set something up that lets Plex Meta Manager see files we create *outside* the container. This is called a "volume map". +Kometa, inside that Docker container, can only see other things *inside the container*. We want to add our own files for config and metadata, so we need to set something up that lets Kometa see files we create *outside* the container. This is called a "volume map". Go to your home directory and create a new directory: @@ -152,22 +152,22 @@ Go to your home directory and create a new directory: ``` { .shell .no-copy linenums="1"} cd ~ #(1)! -mkdir plex-meta-manager #(2)! +mkdir kometa #(2)! ``` 1. This changes to your home directory, which will be something like `/home/yourname` or `/Users/yourname` or `C:\Users\YourName` depending on the platform. -2. This creates a directory called "plex-meta-manager" +2. This creates a directory called "kometa" cd into that directory and create another directory: [type this into your terminal] ``` { .shell .no-copy linenums="1"} -cd ~/plex-meta-manager #(1)! +cd ~/kometa #(1)! mkdir config #(2)! ``` -1. This navigates to the plex-meta-manager folder within your home directory. +1. This navigates to the kometa folder within your home directory. 2. This creates a directory called "config" 3. get the full path: @@ -183,19 +183,19 @@ This will display a full path: === ":fontawesome-brands-linux: Linux" ``` { .shell .no-copy } - /home/YOURUSERNAME/plex-meta-manager + /home/YOURUSERNAME/kometa ``` === ":fontawesome-brands-apple: macOS" ``` { .shell .no-copy } - /Users/YOURUSERNAME/plex-meta-manager + /Users/YOURUSERNAME/kometa ``` === ":fontawesome-brands-windows: Windows" ``` { .shell .no-copy } - C:\Users\YOURUSERNAME\plex-meta-manager + C:\Users\YOURUSERNAME\kometa ``` Add "config" onto the end of that to get the host path to your config directory, for example: @@ -203,19 +203,19 @@ Add "config" onto the end of that to get the host path to your config directory, === ":fontawesome-brands-linux: Linux" ``` - /home/YOURUSERNAME/plex-meta-manager/config + /home/YOURUSERNAME/kometa/config ``` === ":fontawesome-brands-apple: macOS" ``` - /Users/YOURUSERNAME/plex-meta-manager/config + /Users/YOURUSERNAME/kometa/config ``` === ":fontawesome-brands-windows: Windows" ``` - C:\Users\YOURUSERNAME\plex-meta-manager\config + C:\Users\YOURUSERNAME\kometa\config ``` @@ -224,26 +224,26 @@ You'll need to add this to the docker command every time you run it, like this: === ":fontawesome-brands-linux: Linux" ``` - docker run --rm -it -v "/home/YOURUSERNAME/plex-meta-manager/config:/config:rw" meisnate12/plex-meta-manager + docker run --rm -it -v "/home/YOURUSERNAME/kometa/config:/config:rw" kometateam/kometa ``` === ":fontawesome-brands-apple: macOS" ``` - docker run --rm -it -v "/Users/YOURUSERNAME/plex-meta-manager/config:/config:rw" meisnate12/plex-meta-manager + docker run --rm -it -v "/Users/YOURUSERNAME/kometa/config:/config:rw" kometateam/kometa ``` === ":fontawesome-brands-windows: Windows" ``` - docker run --rm -it -v "C:\Users\YOURUSERNAME\plex-meta-manager\config:/config:rw" meisnate12/plex-meta-manager + docker run --rm -it -v "C:\Users\YOURUSERNAME\kometa\config:/config:rw" kometateam/kometa ``` If you run that command now it will display a similar error to before, but without all the image loading: ``` { .bash .no-copy } -$ docker run --rm -it -v "/Users/mroche/plex-meta-manager/config:/config:rw" meisnate12/plex-meta-manager --run +$ docker run --rm -it -v "/Users/mroche/kometa/config:/config:rw" kometateam/kometa --run Config Error: config not found at //config ``` @@ -300,21 +300,21 @@ First, make a copy of the template: Get a copy of the template to edit [type this into your terminal]: ``` - curl -fLvo config/config.yml https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/master/config/config.yml.template + curl -fLvo config/config.yml https://raw.githubusercontent.com/kometateam/kometa/master/config/config.yml.template ``` === ":fontawesome-brands-apple: macOS" Get a copy of the template to edit [type this into your terminal]: ``` - curl -fLvo config/config.yml https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/master/config/config.yml.template + curl -fLvo config/config.yml https://raw.githubusercontent.com/kometateam/kometa/master/config/config.yml.template ``` === ":fontawesome-brands-windows: Windows" - Go to [this URL](https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/master/config/config.yml.template) using a web browser; choose the "Save" command, then save the file at: + Go to [this URL](https://raw.githubusercontent.com/kometateam/kometa/master/config/config.yml.template) using a web browser; choose the "Save" command, then save the file at: ``` - C:\Users\YOURUSERNAME\plex-meta-manager\config\config.yml + C:\Users\YOURUSERNAME\kometa\config\config.yml ``` @@ -339,7 +339,7 @@ Save the file: %} -Then run Plex Meta Manager again: +Then run Kometa again: {% include-markdown "./wt/wt-run-docker.md" @@ -358,7 +358,7 @@ Then run Plex Meta Manager again: %} -So let's run Plex Meta Manager and see this happen: +So let's run Kometa and see this happen: {% include-markdown "./wt/wt-run-docker.md" @@ -384,7 +384,7 @@ Save the file: %} -Then run Plex Meta Manager again: +Then run Kometa again: {% include-markdown "./wt/wt-run-docker.md" @@ -410,7 +410,7 @@ Save the file: %} -Then run Plex Meta Manager again: +Then run Kometa again: {% include-markdown "./wt/wt-run-docker.md" @@ -441,7 +441,7 @@ Then run Plex Meta Manager again: Add the `develop` tag to the image name in your run command [or wherever you specify the image in your environment] ``` -docker run --rm -it -v "Plex Meta Manager_PATH_GOES_HERE:/config:rw" meisnate12/plex-meta-manager:develop --run +docker run --rm -it -v "KOMETA_PATH_GOES_HERE:/config:rw" kometateam/kometa:develop --run ^^^^^^^ ``` @@ -452,7 +452,7 @@ This may not work if you are not using the official image; for example, it does Add the `nightly` tag to the image name in your run command [or wherever you specify the image in your environment] ``` -docker run --rm -it -v "Plex Meta Manager_PATH_GOES_HERE:/config:rw" meisnate12/plex-meta-manager:nightly --run +docker run --rm -it -v "KOMETA_PATH_GOES_HERE:/config:rw" kometateam/kometa:nightly --run ^^^^^^^ ``` @@ -463,7 +463,7 @@ This may not work if you are not using the official image; for example, it does Add the `latest` tag to the image name in your run command [or wherever you specify the image in your environment] ``` -docker run --rm -it -v "Plex Meta Manager_PATH_GOES_HERE:/config:rw" meisnate12/plex-meta-manager:latest --run +docker run --rm -it -v "KOMETA_PATH_GOES_HERE:/config:rw" kometateam/kometa:latest --run ^^^^^^ ``` diff --git a/docs/pmm/install/images.md b/docs/kometa/install/images.md similarity index 57% rename from docs/pmm/install/images.md rename to docs/kometa/install/images.md index 903b7c82..c0e50e45 100644 --- a/docs/pmm/install/images.md +++ b/docs/kometa/install/images.md @@ -3,23 +3,31 @@ You should use the official docker image: ``` -meisnate12/plex-meta-manager +kometateam/kometa ``` All the examples in the wiki are assuming the use of this image, and many do not work with non-official Docker images due to differences in how the authors have chosen to construct their images. One alternate image we see a lot is the Linuxserver image, due to its prominent placement in unRAID and linuxserver's general reputation. +## LXML Images + +In March 2024, lxml, a prerequisite for operating Kometa, ceased support for older CPUs. This impedes users from running Kometa on unsupported hardware. + +To address this issue, we have implemented 'lxml' variants for each Kometa branch (master, develop, and nightly). These variants resume compatibility with older hardware by freezing lxml on a previous version which has wider hardware support. + +To transition to the lxml branch, simply prepend 'lxml-' to the branch name you are currently utilizing. For instance, `kometateam/kometa:lxml-master`, `kometateam/kometa:lxml-develop` and `kometateam/kometa:lxml-nightly`. + ## LinuxServer -The first image offered in unRAID for Plex Meta Manager is the Linuxserver.io image [`linuxserver/plex-meta-manager`] +The first image offered in unRAID for Kometa is the Linuxserver.io image [`linuxserver/kometa`] -This image is different to the official image [meisnate12/plex-meta-manager] in a few ways that cause a variety of problems particularly for new users. +This image is different to the official image [kometateam/kometa] in a few ways that cause a variety of problems particularly for new users. One typical error is something like: ``` -Path does not exist: /run/s6/services/plex-meta-manager/config/SOMETHING +Path does not exist: /run/s6/services/kometa/config/SOMETHING ``` The result is that the stock config file and a lot of the examples found in the wiki and config repo don't work. @@ -35,16 +43,16 @@ The LSIO image: 3. Doesn't support [runtime flags](../environmental.md), only ENV vars. This means that a command like: ``` - docker run -it --rm -v /opt/pmm/config:/config linuxserver/plex-meta-manager --config config/config.yml -r --run-libraries "Movies - 4K DV" + docker run -it --rm -v /opt/kometa/config:/config linuxserver/kometa --config config/config.yml -r --run-libraries "Movies - 4K DV" ``` doesn't work with the LSIO image; it would have to be: ``` - docker run -it --rm -v /opt/pmm/config:/config -e PMM_CONFIG=/config/config.yml -e PMM_RUN=true -e PMM_LIBRARIES="Movies - 4K DV" linuxserver/plex-meta-manager + docker run -it --rm -v /opt/kometa/config:/config -e KOMETA_CONFIG=/config/config.yml -e KOMETA_RUN=true -e KOMETA_LIBRARIES="Movies - 4K DV" linuxserver/kometa ``` -4. Doesn't do manual runs correctly; they loop over and over. That command in the previous bullet point [which uses `PMM_RUN` to run it right now] will run over and over until you manually kill the container. The same thing using the official image will run once and quit, as expected. +4. Doesn't do manual runs correctly; they loop over and over. That command in the previous bullet point [which uses `KOMETA_RUN` to run it right now] will run over and over until you manually kill the container. The same thing using the official image will run once and quit, as expected. 5. Resets ownership of entire config dir every run. In tests, the ownership of the config dir and its contents was set to 911:911 with each run. diff --git a/docs/pmm/install/images/dsm6-01.png b/docs/kometa/install/images/dsm6-01.png similarity index 100% rename from docs/pmm/install/images/dsm6-01.png rename to docs/kometa/install/images/dsm6-01.png diff --git a/docs/pmm/install/images/dsm6-02.png b/docs/kometa/install/images/dsm6-02.png similarity index 100% rename from docs/pmm/install/images/dsm6-02.png rename to docs/kometa/install/images/dsm6-02.png diff --git a/docs/pmm/install/images/dsm6-03.png b/docs/kometa/install/images/dsm6-03.png similarity index 100% rename from docs/pmm/install/images/dsm6-03.png rename to docs/kometa/install/images/dsm6-03.png diff --git a/docs/pmm/install/images/dsm6-04.png b/docs/kometa/install/images/dsm6-04.png similarity index 100% rename from docs/pmm/install/images/dsm6-04.png rename to docs/kometa/install/images/dsm6-04.png diff --git a/docs/pmm/install/images/dsm6-05.png b/docs/kometa/install/images/dsm6-05.png similarity index 100% rename from docs/pmm/install/images/dsm6-05.png rename to docs/kometa/install/images/dsm6-05.png diff --git a/docs/pmm/install/images/dsm7-01.png b/docs/kometa/install/images/dsm7-01.png similarity index 100% rename from docs/pmm/install/images/dsm7-01.png rename to docs/kometa/install/images/dsm7-01.png diff --git a/docs/pmm/install/images/dsm7-02.png b/docs/kometa/install/images/dsm7-02.png similarity index 100% rename from docs/pmm/install/images/dsm7-02.png rename to docs/kometa/install/images/dsm7-02.png diff --git a/docs/pmm/install/images/dsm7-03.png b/docs/kometa/install/images/dsm7-03.png similarity index 100% rename from docs/pmm/install/images/dsm7-03.png rename to docs/kometa/install/images/dsm7-03.png diff --git a/docs/pmm/install/images/dsm7-04.png b/docs/kometa/install/images/dsm7-04.png similarity index 100% rename from docs/pmm/install/images/dsm7-04.png rename to docs/kometa/install/images/dsm7-04.png diff --git a/docs/pmm/install/images/dsm7-05.png b/docs/kometa/install/images/dsm7-05.png similarity index 100% rename from docs/pmm/install/images/dsm7-05.png rename to docs/kometa/install/images/dsm7-05.png diff --git a/docs/pmm/install/images/dsm7-06.png b/docs/kometa/install/images/dsm7-06.png similarity index 100% rename from docs/pmm/install/images/dsm7-06.png rename to docs/kometa/install/images/dsm7-06.png diff --git a/docs/pmm/install/images/dsm7-07.png b/docs/kometa/install/images/dsm7-07.png similarity index 100% rename from docs/pmm/install/images/dsm7-07.png rename to docs/kometa/install/images/dsm7-07.png diff --git a/docs/pmm/install/images/dsm7-08.png b/docs/kometa/install/images/dsm7-08.png similarity index 100% rename from docs/pmm/install/images/dsm7-08.png rename to docs/kometa/install/images/dsm7-08.png diff --git a/docs/pmm/install/images/qnap1.png b/docs/kometa/install/images/qnap1.png similarity index 100% rename from docs/pmm/install/images/qnap1.png rename to docs/kometa/install/images/qnap1.png diff --git a/docs/pmm/install/images/qnap2.png b/docs/kometa/install/images/qnap2.png similarity index 100% rename from docs/pmm/install/images/qnap2.png rename to docs/kometa/install/images/qnap2.png diff --git a/docs/pmm/install/images/qnap3-01.png b/docs/kometa/install/images/qnap3-01.png similarity index 100% rename from docs/pmm/install/images/qnap3-01.png rename to docs/kometa/install/images/qnap3-01.png diff --git a/docs/pmm/install/images/qnap3-02.png b/docs/kometa/install/images/qnap3-02.png similarity index 100% rename from docs/pmm/install/images/qnap3-02.png rename to docs/kometa/install/images/qnap3-02.png diff --git a/docs/pmm/install/images/qnap3-03.png b/docs/kometa/install/images/qnap3-03.png similarity index 100% rename from docs/pmm/install/images/qnap3-03.png rename to docs/kometa/install/images/qnap3-03.png diff --git a/docs/pmm/install/images/qnap3-03a.png b/docs/kometa/install/images/qnap3-03a.png similarity index 100% rename from docs/pmm/install/images/qnap3-03a.png rename to docs/kometa/install/images/qnap3-03a.png diff --git a/docs/pmm/install/images/qnap3-04.png b/docs/kometa/install/images/qnap3-04.png similarity index 100% rename from docs/pmm/install/images/qnap3-04.png rename to docs/kometa/install/images/qnap3-04.png diff --git a/docs/pmm/install/images/qnap3-05.png b/docs/kometa/install/images/qnap3-05.png similarity index 100% rename from docs/pmm/install/images/qnap3-05.png rename to docs/kometa/install/images/qnap3-05.png diff --git a/docs/pmm/install/images/qnap3-06.png b/docs/kometa/install/images/qnap3-06.png similarity index 100% rename from docs/pmm/install/images/qnap3-06.png rename to docs/kometa/install/images/qnap3-06.png diff --git a/docs/pmm/install/images/qnap3-07.png b/docs/kometa/install/images/qnap3-07.png similarity index 100% rename from docs/pmm/install/images/qnap3-07.png rename to docs/kometa/install/images/qnap3-07.png diff --git a/docs/pmm/install/images/qnap3-08.png b/docs/kometa/install/images/qnap3-08.png similarity index 100% rename from docs/pmm/install/images/qnap3-08.png rename to docs/kometa/install/images/qnap3-08.png diff --git a/docs/pmm/install/images/qnap3-09.png b/docs/kometa/install/images/qnap3-09.png similarity index 100% rename from docs/pmm/install/images/qnap3-09.png rename to docs/kometa/install/images/qnap3-09.png diff --git a/docs/pmm/install/images/qnap3-10.png b/docs/kometa/install/images/qnap3-10.png similarity index 100% rename from docs/pmm/install/images/qnap3-10.png rename to docs/kometa/install/images/qnap3-10.png diff --git a/docs/pmm/install/images/qnap3-11.png b/docs/kometa/install/images/qnap3-11.png similarity index 100% rename from docs/pmm/install/images/qnap3-11.png rename to docs/kometa/install/images/qnap3-11.png diff --git a/docs/pmm/install/images/qnap3-12.png b/docs/kometa/install/images/qnap3-12.png similarity index 100% rename from docs/pmm/install/images/qnap3-12.png rename to docs/kometa/install/images/qnap3-12.png diff --git a/docs/pmm/install/images/qnap3-13.png b/docs/kometa/install/images/qnap3-13.png similarity index 100% rename from docs/pmm/install/images/qnap3-13.png rename to docs/kometa/install/images/qnap3-13.png diff --git a/docs/pmm/install/images/qnap3-14.png b/docs/kometa/install/images/qnap3-14.png similarity index 100% rename from docs/pmm/install/images/qnap3-14.png rename to docs/kometa/install/images/qnap3-14.png diff --git a/docs/pmm/install/images/qnap3.png b/docs/kometa/install/images/qnap3.png similarity index 100% rename from docs/pmm/install/images/qnap3.png rename to docs/kometa/install/images/qnap3.png diff --git a/docs/pmm/install/images/qnap4.png b/docs/kometa/install/images/qnap4.png similarity index 100% rename from docs/pmm/install/images/qnap4.png rename to docs/kometa/install/images/qnap4.png diff --git a/docs/pmm/install/images/qnap5.png b/docs/kometa/install/images/qnap5.png similarity index 100% rename from docs/pmm/install/images/qnap5.png rename to docs/kometa/install/images/qnap5.png diff --git a/docs/pmm/install/images/qnap6.png b/docs/kometa/install/images/qnap6.png similarity index 100% rename from docs/pmm/install/images/qnap6.png rename to docs/kometa/install/images/qnap6.png diff --git a/docs/pmm/install/images/qnap7.png b/docs/kometa/install/images/qnap7.png similarity index 100% rename from docs/pmm/install/images/qnap7.png rename to docs/kometa/install/images/qnap7.png diff --git a/docs/pmm/install/images/synology-01.png b/docs/kometa/install/images/synology-01.png similarity index 100% rename from docs/pmm/install/images/synology-01.png rename to docs/kometa/install/images/synology-01.png diff --git a/docs/pmm/install/images/synology-02.png b/docs/kometa/install/images/synology-02.png similarity index 100% rename from docs/pmm/install/images/synology-02.png rename to docs/kometa/install/images/synology-02.png diff --git a/docs/pmm/install/images/synology-03.png b/docs/kometa/install/images/synology-03.png similarity index 100% rename from docs/pmm/install/images/synology-03.png rename to docs/kometa/install/images/synology-03.png diff --git a/docs/pmm/install/images/synology-04.png b/docs/kometa/install/images/synology-04.png similarity index 100% rename from docs/pmm/install/images/synology-04.png rename to docs/kometa/install/images/synology-04.png diff --git a/docs/pmm/install/images/synology-05.png b/docs/kometa/install/images/synology-05.png similarity index 100% rename from docs/pmm/install/images/synology-05.png rename to docs/kometa/install/images/synology-05.png diff --git a/docs/pmm/install/images/synology-06.png b/docs/kometa/install/images/synology-06.png similarity index 100% rename from docs/pmm/install/images/synology-06.png rename to docs/kometa/install/images/synology-06.png diff --git a/docs/pmm/install/images/wt-default-collections.png b/docs/kometa/install/images/wt-default-collections.png similarity index 100% rename from docs/pmm/install/images/wt-default-collections.png rename to docs/kometa/install/images/wt-default-collections.png diff --git a/docs/pmm/install/images/wt-finished.png b/docs/kometa/install/images/wt-finished.png similarity index 100% rename from docs/pmm/install/images/wt-finished.png rename to docs/kometa/install/images/wt-finished.png diff --git a/docs/pmm/install/images/wt-git-install.png b/docs/kometa/install/images/wt-git-install.png similarity index 100% rename from docs/pmm/install/images/wt-git-install.png rename to docs/kometa/install/images/wt-git-install.png diff --git a/docs/pmm/install/images/wt-movie-lib-name.png b/docs/kometa/install/images/wt-movie-lib-name.png similarity index 100% rename from docs/pmm/install/images/wt-movie-lib-name.png rename to docs/kometa/install/images/wt-movie-lib-name.png diff --git a/docs/pmm/install/images/wt-overlays.png b/docs/kometa/install/images/wt-overlays.png similarity index 100% rename from docs/pmm/install/images/wt-overlays.png rename to docs/kometa/install/images/wt-overlays.png diff --git a/docs/pmm/install/kubernetes.md b/docs/kometa/install/kubernetes.md similarity index 89% rename from docs/pmm/install/kubernetes.md rename to docs/kometa/install/kubernetes.md index 77fe1378..5a60e81e 100644 --- a/docs/pmm/install/kubernetes.md +++ b/docs/kometa/install/kubernetes.md @@ -1,6 +1,6 @@ # Kubernetes Walkthrough -This article will walk you through getting Plex-Meta-Manager [PMM] set up and running in Kubernetes. It will cover: +This article will walk you through getting Kometa set up and running in Kubernetes. It will cover: 1. Creating the Kubernetes CronJob 2. Creating configuration files as Config Maps @@ -14,7 +14,7 @@ do not, but are interested, [minikube](https://minikube.sigs.k8s.io/docs/start/) ## Creating the Kubernetes CronJob -When running PMM in Kubernetes, executing it as a CronJob gives us the ability to define a schedule for execution and have +When running Kometa in Kubernetes, executing it as a CronJob gives us the ability to define a schedule for execution and have Kubernetes manage the rest. Some parts of this to tweak to your needs: @@ -27,7 +27,7 @@ site if you aren't sure on how to create a schedule. apiVersion: batch/v1 kind: CronJob metadata: - name: plex-media-manager + name: kometa namespace: media spec: schedule: "0 0 * * *" @@ -39,8 +39,8 @@ spec: runAsUser: 1000 runAsGroup: 1000 containers: - - name: plex-media-manager - image: meisnate12/plex-meta-manager:latest + - name: kometa + image: kometateam/kometa:latest imagePullPolicy: IfNotPresent args: [ "--run", "--read-only-config" ] resources: @@ -53,7 +53,7 @@ spec: volumeMounts: - name: config mountPath: /config - - name: pmm-config + - name: kometa-config mountPath: /config/config.yml subPath: config.yml - name: movie-config @@ -65,10 +65,10 @@ spec: volumes: - name: config persistentVolumeClaim: - claimName: plex-media-manager + claimName: kometa - configMap: - name: pmm-config - name: pmm-config + name: kometa-config + name: kometa-config - configMap: name: movie-config name: movie-config @@ -90,8 +90,8 @@ apiVersion: v1 kind: PersistentVolumeClaim metadata: labels: - app: plex-media-manager - name: plex-media-manager + app: kometa + name: kometa namespace: media spec: accessModes: @@ -104,12 +104,12 @@ spec: ## Creating the Config Maps -In Kubernetes, configurations are managed via Config Maps. So we deploy the configurations for PMM as config maps. The -minimum requirement is the PMM config, but the example here assumes you have a separate config for movies and tv shows. +In Kubernetes, configurations are managed via Config Maps. So we deploy the configurations for Kometa as config maps. The +minimum requirement is the Kometa config, but the example here assumes you have a separate config for movies and tv shows. -### PMM Config +### Kometa Config -Here's a config map for the `config.yml` file for PMM. Note there are many placeholders that will need update based on +Here's a config map for the `config.yml` file for Kometa. Note there are many placeholders that will need update based on your environment and needs. Follow the [Trakt Attributes](../../config/trakt.md) directions for generating the OAuth authorization @@ -179,7 +179,7 @@ data: monitor: false availability: cinemas quality_profile: HD - 720p/1080p - tag: pmm + tag: kometa add_existing: false search: false radarr_path: @@ -195,7 +195,7 @@ data: language_profile: English series_type: standard season_folder: true - tag: pmm + tag: kometa search: true cutoff_search: false sonarr_path: @@ -212,7 +212,7 @@ data: created_at: 1642462048 kind: ConfigMap metadata: - name: pmm-config + name: kometa-config namespace: media ``` @@ -292,7 +292,7 @@ NOTE the environment value nameed `JINJA_DEST_FILE` is the resulting name of the apiVersion: batch/v1 kind: CronJob metadata: - name: plex-media-manager + name: kometa namespace: media spec: schedule: "0 0 * * *" @@ -323,8 +323,8 @@ spec: - name: config mountPath: /config containers: - - name: plex-media-manager - image: meisnate12/plex-meta-manager:latest + - name: kometa + image: kometateam/kometa:latest imagePullPolicy: Always args: [ "--run", "--read-only-config" ] resources: @@ -337,7 +337,7 @@ spec: volumeMounts: - name: config mountPath: /config - - name: pmm-config + - name: kometa-config mountPath: /config/config.yml subPath: config.yml - name: movie-config @@ -346,10 +346,10 @@ spec: volumes: - name: config persistentVolumeClaim: - claimName: plex-media-manager + claimName: kometa - configMap: - name: pmm-config - name: pmm-config + name: kometa-config + name: kometa-config - configMap: name: movie-config name: movie-config diff --git a/docs/pmm/install/local.md b/docs/kometa/install/local.md similarity index 82% rename from docs/pmm/install/local.md rename to docs/kometa/install/local.md index 4a0e889d..0e33fe3a 100644 --- a/docs/pmm/install/local.md +++ b/docs/kometa/install/local.md @@ -1,8 +1,8 @@ # Local Walkthrough -This article will walk you through getting Plex-Meta-Manager [PMM] set up and running. It will cover: +This article will walk you through getting Kometa set up and running. It will cover: -1. Retrieving the PMM code +1. Retrieving the Kometa code 2. Installing requirements 3. Setting up the initial config file 4. Setting up a collection file and creating a couple sample collections. @@ -12,7 +12,7 @@ The specific steps you will be taking: 1. Verify that Python 3.8 or better is installed and install it if not 2. Verify that the Git tools are installed and install them if not 3. Use `git` to retrieve the code -4. Install requirements [extra bits of code required for PMM] +4. Install requirements [extra bits of code required for Kometa] 5. Gather two things that the script requires: 1. TMDb API Key 2. Plex URL and Token @@ -21,11 +21,11 @@ The specific steps you will be taking: 1. use `python` to run the script 2. use a text editor to modify a couple of text files until you have a working config file and a single working collection file. -Note that running a Python script is inherently a pretty technical process. If you are unable or unwilling to learn the rudiments of using tools like python and git, you should probably strongly consider running PMM in [Docker](docker.md). That will eliminate the Python and git installs from this process and make it as simple as it can be. +Note that running a Python script is inherently a pretty technical process. If you are unable or unwilling to learn the rudiments of using tools like python and git, you should probably strongly consider running Kometa in [Docker](docker.md). That will eliminate the Python and git installs from this process and make it as simple as it can be. -If the idea of editing YAML files by hand is daunting, this may not be the tool for you. All the configuration of PMM is done via YAML text files, so if you are unable or unwilling to learn how those work, you should stop here. +If the idea of editing YAML files by hand is daunting, this may not be the tool for you. All the configuration of Kometa is done via YAML text files, so if you are unable or unwilling to learn how those work, you should stop here. -Finally, this walkthrough is intended to give you a basic grounding in how to get the script running. It doesn't cover how to create your own collections, or how to add overlays, or any of the myriad other things PMM is capable of. It provides a simple "Getting Started" guide for those for whom the standard install instructions make no sense; presumably because you've never run a Python script before. +Finally, this walkthrough is intended to give you a basic grounding in how to get the script running. It doesn't cover how to create your own collections, or how to add overlays, or any of the myriad other things Kometa is capable of. It provides a simple "Getting Started" guide for those for whom the standard install instructions make no sense; presumably because you've never run a Python script before. ## Prerequisites. @@ -47,7 +47,7 @@ That’s a command you’re going to type or paste into your terminal (OSX or Li ???+ danger "Important" - This walkthrough is assuming you are doing the entire process on the same platform; i.e. you're installing PMM and editing its config files on a single Linux, Windows, or OS X machine. It doesn't account for situations like running PMM on a Linux machine while editing the config files on your Windows box. + This walkthrough is assuming you are doing the entire process on the same platform; i.e. you're installing Kometa and editing its config files on a single Linux, Windows, or OS X machine. It doesn't account for situations like running Kometa on a Linux machine while editing the config files on your Windows box. ### Prepare a small test library [optional] @@ -111,7 +111,7 @@ If this doesn't return `3.8.0` or higher, you'll need to get Python 3 installed. #### Why the next-to-latest? - There is one dependency [`lxml`] that lags behind new Python releases; this will cause a failure when installing requirements in a moment if the newest Python version is too new [at time of writing the current is 3.11, and the requirements install fails on the lxml library]. You can avoid this by using the next-to-latest release. At some point this will no longer be a problem, but that is outside the control of PMM. + There is one dependency [`lxml`] that lags behind new Python releases; this will cause a failure when installing requirements in a moment if the newest Python version is too new [at time of writing the current is 3.11, and the requirements install fails on the lxml library]. You can avoid this by using the next-to-latest release. At some point this will no longer be a problem, but that is outside the control of Kometa. Once downloaded, run the installer. Tick “Add to path” checkbox at the bottom and click “Install Now”. @@ -122,7 +122,7 @@ If this doesn't return `3.8.0` or higher, you'll need to get Python 3 installed. ### Installing git -To copy the Plex-Meta-Manager code to your machine, we'll be using git. This may be installed on Mac or Linux, and probably isn't in Windows. +To copy the Kometa code to your machine, we'll be using git. This may be installed on Mac or Linux, and probably isn't in Windows. First let's check if it's installed already [type this into your terminal]: @@ -153,7 +153,7 @@ If this doesn't return a version number, you'll need to get git installed. --- -### Retrieving the Plex-Meta-Manager code +### Retrieving the Kometa code Now we're going to use `git` to make a copy of the code on your local computer. @@ -161,22 +161,22 @@ Clone the repo into your home directory and go into that directory [type this in ``` cd ~ -git clone https://github.com/meisnate12/Plex-Meta-Manager -cd Plex-Meta-Manager +git clone https://github.com/Kometa-Team/Kometa +cd Kometa ``` **NOTE: The rest of this walkthrough assumes you are staying in this directory in this terminal/Powershell window.** -**IMPORTANT: In the future, when you want to run PMM at the command line, you have to be in this directory.** +**IMPORTANT: In the future, when you want to run Kometa at the command line, you have to be in this directory.** -When you open a command window to run PMM, the first step will always be: +When you open a command window to run Kometa, the first step will always be: ``` cd ~ -cd Plex-Meta-Manager +cd Kometa ``` -There are parts of the code that are assuming and expecting that you will be in this directory when you run PMM [the fonts used in overlays are one example]. Be sure that you are always in this directory when you run PMM. +There are parts of the code that are assuming and expecting that you will be in this directory when you run Kometa [the fonts used in overlays are one example]. Be sure that you are always in this directory when you run Kometa. <details> <summary>What did that do?</summary> @@ -186,11 +186,11 @@ There are parts of the code that are assuming and expecting that you will be in ``` This changes to your home directory, which will be something like `/home/yourname` or `/Users/yourname` or `C:\Users\YourName` depending on the platform. ``` - git clone https://github.com/meisnate12/Plex-Meta-Manager + git clone https://github.com/Kometa-Team/Kometa ``` - This uses `git` to make a copy of (`clone`) the PMM code from where it is stored on `github`. + This uses `git` to make a copy of (`clone`) the Kometa code from where it is stored on `github`. ``` - cd Plex-Meta-Manager + cd Kometa ``` This moves into the directory that was created by the `clone` command. </details> @@ -224,11 +224,11 @@ This walkthrough is going to use a "virtual environment", since that provides a [type this into your terminal] ``` - python3 -m venv pmm-venv + python3 -m venv kometa-venv ``` If you see an error like: ``` - Error: Command '['/home/mroche/Plex-Meta-Manager/pmm-venv/bin/python3', '-Im', 'ensurepip', '--upgrade', '--default-pip']' returned non-zero exit status 1. + Error: Command '['/home/mroche/Kometa/kometa-venv/bin/python3', '-Im', 'ensurepip', '--upgrade', '--default-pip']' returned non-zero exit status 1. ``` You probably need to make sure the Python 3.9-specific virtualenv support library is installed: [type this into your terminal] @@ -241,14 +241,14 @@ This walkthrough is going to use a "virtual environment", since that provides a [type this into your terminal] ``` - python3 -m venv pmm-venv + python3 -m venv kometa-venv ``` === ":fontawesome-brands-windows: Windows" [type this into your terminal] ``` - python -m venv pmm-venv + python -m venv kometa-venv ``` If you see: ``` @@ -261,15 +261,15 @@ This walkthrough is going to use a "virtual environment", since that provides a <summary>What did that do?</summary> ``` - python3 -m venv pmm-venv + python3 -m venv kometa-venv ``` - This tells Python3 to use the `venv` module to create a virtual environment called `pmm-venv`. The only visible effect will be the creation of a `pmm-venv` directory. + This tells Python3 to use the `venv` module to create a virtual environment called `kometa-venv`. The only visible effect will be the creation of a `kometa-venv` directory. </details> That command will not produce any output if it works; it will display an error if a problem occurs. If everything is fine, you will be looking at something like this: ``` -> python -m venv pmm-venv +> python -m venv kometa-venv > ``` @@ -281,27 +281,27 @@ That will create the virtual environment, and then you need to activate it: [type this into your terminal] ``` - source pmm-venv/bin/activate + source kometa-venv/bin/activate ``` === ":fontawesome-brands-apple: macOS" [type this into your terminal] ``` - source pmm-venv/bin/activate + source kometa-venv/bin/activate ``` === ":fontawesome-brands-windows: Windows" [type this into your terminal] ``` - .\pmm-venv\Scripts\activate + .\kometa-venv\Scripts\activate ``` If you see something like this: ```powershell - .\pmm-venv\Scripts\activate : File C:\Users\mroche\Plex-Meta-Manager\pmm-venv\Scripts\Activate.ps1 cannot be loaded because running scripts is disabled on this system. For more information, see about_Execution_Policies at https:/go.microsoft.com/fwlink LinkID=135170. + .\kometa-venv\Scripts\activate : File C:\Users\mroche\Kometa\kometa-venv\Scripts\Activate.ps1 cannot be loaded because running scripts is disabled on this system. For more information, see about_Execution_Policies at https:/go.microsoft.com/fwlink LinkID=135170. At line:1 char:1 - + .\pmm-venv\Scripts\activate + + .\kometa-venv\Scripts\activate + ~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : SecurityError: (:) [], PSSecurityException + FullyQualifiedErrorId : UnauthorizedAccess @@ -318,19 +318,19 @@ That command will not produce any output if it works; it will display an error i You may see a change in your prompt, something like this: ``` -➜ Plex-Meta-Manager git:(master) ✗ source pmm-venv/bin/activate -(pmm-venv) ➜ Plex-Meta-Manager git:(master) ✗ +➜ Kometa git:(master) ✗ source kometa-venv/bin/activate +(kometa-venv) ➜ Kometa git:(master) ✗ ``` -Note that the prompt now shows the name of the virtual environment. You may not see this; it's dependent on *your* terminal configuration, not anything to do with Python or PMM. +Note that the prompt now shows the name of the virtual environment. You may not see this; it's dependent on *your* terminal configuration, not anything to do with Python or Kometa. <details> <summary>What did that do?</summary> - This tells Python to make the virtual environment "active", which means to use the copy of python that is available there, install all support libraries there, etc. This keeps the PMM code and its runtime environment totally separate from your host machine's environment. + This tells Python to make the virtual environment "active", which means to use the copy of python that is available there, install all support libraries there, etc. This keeps the Kometa code and its runtime environment totally separate from your host machine's environment. </details> -An advantage of doing this in a virtual environment is that in the event something goes wrong with this part of the setup, you can delete that pmm-venv directory and do the setup again. +An advantage of doing this in a virtual environment is that in the event something goes wrong with this part of the setup, you can delete that kometa-venv directory and do the setup again. **IMPORTANT: In the future, when you want to run the script, you will need to do this "activation" step every time. Not the venv creation, just the activation**: @@ -338,26 +338,26 @@ An advantage of doing this in a virtual environment is that in the event somethi [type this into your terminal] ``` - source pmm-venv/bin/activate + source kometa-venv/bin/activate ``` === ":fontawesome-brands-apple: macOS" [type this into your terminal] ``` - source pmm-venv/bin/activate + source kometa-venv/bin/activate ``` === ":fontawesome-brands-windows: Windows" [type this into your terminal] ``` - .\pmm-venv\Scripts\activate + .\kometa-venv\Scripts\activate ``` ### Installing requirements -Plex-Meta-Manager, like every other Python script, depends on support libraries that manage things like connections to Plex, or getting things from the internet, or writing files and so on. +Kometa, like every other Python script, depends on support libraries that manage things like connections to Plex, or getting things from the internet, or writing files and so on. These support libraries are called “requirements”, and they are defined in that file called `requirements.txt`. To install them, type the following command [type this into your terminal]: @@ -379,7 +379,7 @@ Installing collected packages: urllib3, idna, charset-normalizer, certifi, six, Running setup.py install for arrapi ... done Successfully installed PlexAPI-4.7.0 arrapi-1.1.3 certifi-2021.10.8 charset-normalizer-2.0.7 idna-3.3 lxml-4.6.3 pathvalidate-2.4.1 pillow-8.3.2 requests-2.26.0 retrying-1.3.3 ruamel.yaml-0.17.10 ruamel.yaml.clib-0.2.6 schedule-1.1.0 six-1.16.0 tmdbv3api-1.7.6 urllib3-1.26.7 WARNING: You are using pip version 21.1.3; however, version 21.3 is available. -You should consider upgrading via the '/Users/mroche/Plex-Meta-Manager/pmm-venv/bin/python -m pip install --upgrade pip' command. +You should consider upgrading via the '/Users/mroche/Kometa/kometa-venv/bin/python -m pip install --upgrade pip' command. ``` Don't worry about the WARNING about `pip version thus-and-such` if it comes up. @@ -409,7 +409,7 @@ Don't worry about the WARNING about `pip version thus-and-such` if it comes up. <details> <summary>What did that do?</summary> - This told Python to use the `pip` module to install some libraries that PMM needs. + This told Python to use the `pip` module to install some libraries that Kometa needs. </details> Let’s make sure it’s working so far. @@ -423,7 +423,7 @@ This is going to fail with an error, which you will then fix. You should see something like this: ``` -Config Error: config not found at /Users/mroche/Plex-Meta-Manager/config +Config Error: config not found at /Users/mroche/Kometa/config ``` That error means you don’t have a config file, but we at least know that the requirements are in place and the script can run. @@ -500,7 +500,7 @@ Save the file: {% include-markdown "./wt/wt-save.md" %} -Then run Plex Meta Manager again: +Then run Kometa again: {% include-markdown "./wt/wt-run-shell.md" %} @@ -510,7 +510,7 @@ Then run Plex Meta Manager again: {% include-markdown "./wt/wt-04-default-intro.md" %} -So let's run Plex Meta Manager and see this happen: +So let's run Kometa and see this happen: {% include-markdown "./wt/wt-run-shell.md" %} @@ -525,7 +525,7 @@ Save the file: {% include-markdown "./wt/wt-save.md" %} -Then run Plex Meta Manager again: +Then run Kometa again: {% include-markdown "./wt/wt-run-shell.md" %} @@ -539,7 +539,7 @@ Save the file: {% include-markdown "./wt/wt-save.md" %} -Then run Plex Meta Manager again: +Then run Kometa again: {% include-markdown "./wt/wt-run-shell.md" %} @@ -563,15 +563,15 @@ deactivate include-markdown "./wt/wt-10-scheduling.md" %} -### I want to update to the latest version of PMM +### I want to update to the latest version of Kometa === ":fontawesome-brands-linux: Linux" [type this into your terminal] ``` - cd ~/Plex-Meta-Manager + cd ~/Kometa git pull - source pmm-venv/bin/activate + source kometa-venv/bin/activate python -m pip install -r requirements.txt ``` @@ -579,9 +579,9 @@ deactivate [type this into your terminal] ``` - cd ~/Plex-Meta-Manager + cd ~/Kometa git pull - source pmm-venv/bin/activate + source kometa-venv/bin/activate python -m pip install -r requirements.txt ``` @@ -589,9 +589,9 @@ deactivate [type this into your terminal] ``` - cd ~\Plex-Meta-Manager + cd ~\Kometa git pull - .\pmm-venv\Scripts\activate + .\kometa-venv\Scripts\activate python -m pip install -r requirements.txt ``` @@ -602,10 +602,10 @@ deactivate [type this into your terminal] ``` - cd ~/Plex-Meta-Manager + cd ~/Kometa git checkout develop git pull - source pmm-venv/bin/activate + source kometa-venv/bin/activate python -m pip install -r requirements.txt ``` @@ -613,10 +613,10 @@ deactivate [type this into your terminal] ``` - cd ~/Plex-Meta-Manager + cd ~/Kometa git checkout develop git pull - source pmm-venv/bin/activate + source kometa-venv/bin/activate python -m pip install -r requirements.txt ``` @@ -624,10 +624,10 @@ deactivate [type this into your terminal] ``` - cd ~/Plex-Meta-Manager + cd ~/Kometa git checkout develop git pull - .\pmm-venv\Scripts\activate + .\kometa-venv\Scripts\activate python -m pip install -r requirements.txt ``` diff --git a/docs/pmm/install/overview.md b/docs/kometa/install/overview.md similarity index 60% rename from docs/pmm/install/overview.md rename to docs/kometa/install/overview.md index 00f90e14..758eb8de 100644 --- a/docs/pmm/install/overview.md +++ b/docs/kometa/install/overview.md @@ -1,6 +1,6 @@ -# Installing Plex Meta Manager +# Installing Kometa -Generally, Plex Meta Manager can be installed in one of two ways: +Generally, Kometa can be installed in one of two ways: 1. Running on a system as a Python script [we will refer to this as a "local" install] 2. Running as a Docker container @@ -11,11 +11,11 @@ For this reason, it's generally recommended that you install via Docker rather t If you have some specific reason to avoid Docker, or you prefer running it as a Python script for some particular reason, then this general recommendation is not aimed at you. It's aimed at someone who doesn't have an existing compelling reason to choose one over the other. -## Where to install Plex Meta Manager +## Where to install Kometa -Plex Meta Manager communicates with all services [Plex, Radarr, Trakt, etc] via their network APIs, so Plex Meta Manager does *not* have to be installed on the same machine as Plex. Plex Meta Manager does not require [nor would it use] access to the filesystem behind your Plex libraries. +Kometa communicates with all services [Plex, Radarr, Trakt, etc] via their network APIs, so Kometa does *not* have to be installed on the same machine as Plex. Kometa does not require [nor would it use] access to the filesystem behind your Plex libraries. -Perhaps your Plex server is remote and you want to run Plex Meta Manager on a machine in your home. That's fine. The relative locations of Plex Meta Manager and Plex have no effect on the installation [except perhaps the URL you would use in the config]. +Perhaps your Plex server is remote and you want to run Kometa on a machine in your home. That's fine. The relative locations of Kometa and Plex have no effect on the installation [except perhaps the URL you would use in the config]. ## Install Walkthroughs @@ -28,7 +28,7 @@ For those who need full installation walkthroughs, please refer to the following If you are using unRAID, Kubernetes, QNAP, or Synology refer to the following basic guide to Docker container setup for each system: -**this doesn't cover the PMM setup specifics found in the guides above with regard to creating the config file and collection file, so you may want to go through the [Docker Walkthrough](docker.md) first on your computer to gain that understanding.** +**this doesn't cover the Kometa setup specifics found in the guides above with regard to creating the config file and collection file, so you may want to go through the [Docker Walkthrough](docker.md) first on your computer to gain that understanding.** * [unRAID Walkthrough](unraid.md) * [Kubernetes Walkthrough](kubernetes.md) @@ -37,14 +37,14 @@ If you are using unRAID, Kubernetes, QNAP, or Synology refer to the following ba ## Local Install Overview -Plex Meta Manager is compatible with Python 3.8 through 3.11. Later versions may function but are untested. +Kometa is compatible with Python 3.8 through 3.11. Later versions may function but are untested. These are high-level steps which assume the user has knowledge of python and pip, and the general ability to troubleshoot issues. For a detailed step-by-step walkthrough, refer to the [Local Walkthrough](local.md) guide. -1. Clone or [download and unzip](https://github.com/meisnate12/Plex-Meta-Manager/archive/refs/heads/master.zip) the repo. +1. Clone or [download and unzip](https://github.com/Kometa-Team/Kometa/archive/refs/heads/master.zip) the repo. ```shell -git clone https://github.com/meisnate12/Plex-Meta-Manager +git clone https://github.com/Kometa-Team/Kometa ``` 2. Install dependencies: @@ -58,10 +58,10 @@ pip install -r requirements.txt pip install -r requirements.txt --ignore-installed ``` -At this point Plex Meta Manager has been installed, and you can verify installation by running: +At this point Kometa has been installed, and you can verify installation by running: ```shell -python plex_meta_manager.py +python kometa.py ``` ## Docker Install Overview @@ -69,7 +69,7 @@ python plex_meta_manager.py ### Docker Run: ```shell -docker run -it -v <PATH_TO_CONFIG>:/config:rw meisnate12/plex-meta-manager +docker run -it -v <PATH_TO_CONFIG>:/config:rw kometateam/kometa ``` - The `-it` flag allows you to interact with the script when needed (such as for Trakt or MyAnimeList authentication). @@ -85,7 +85,7 @@ Example Docker Run command: These docs are assuming you have a basic understanding of Docker concepts. One place to get familiar with Docker would be the [official tutorial](https://www.docker.com/101-tutorial/). ```shell -docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager +docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa ``` ### Docker Compose: @@ -94,9 +94,9 @@ This is an example docker-compose which will have to be edited to suit your envi ```yaml services: - plex-meta-manager: - image: meisnate12/plex-meta-manager - container_name: plex-meta-manager + kometa: + image: kometateam/kometa + container_name: kometa environment: - TZ=TIMEZONE #optional volumes: @@ -106,13 +106,13 @@ services: ### Dockerfile -A `Dockerfile` is included within the GitHub repository for those who require it, although this is only suggested for those with knowledge of dockerfiles. The official Plex Meta Manager build is available on the [Dockerhub Website](https://hub.docker.com/r/meisnate12/plex-meta-manager). +A `Dockerfile` is included within the GitHub repository for those who require it, although this is only suggested for those with knowledge of dockerfiles. The official Kometa build is available on the [Dockerhub Website](https://hub.docker.com/r/kometateam/kometa). ## Customizing the docker-compose file with runtime flags and ENV vars -Plex Meta Manager's behavior can be modified in a variety of ways using either runtime flags or environment variables. These flags and vars are detailed [here](../environmental.md). +Kometa's behavior can be modified in a variety of ways using either runtime flags or environment variables. These flags and vars are detailed [here](../environmental.md). -This is optional, and is not necessary to run PMM. Many if not most users will have no reason to do this and can use something more like the basic docker-compose just above. +This is optional, and is not necessary to run Kometa. Many if not most users will have no reason to do this and can use something more like the basic docker-compose just above. This example docker-compose would create a container that runs immediately upon start (rather than waiting until 5AM), uses a particular config file, processes only overlays on only one library, and exits when done. Those four changes are made by the four `environment:` entries, which are discussed in detail after the example: @@ -120,24 +120,24 @@ As with the one above, this is an example docker-compose which will have to be e ```yaml services: - plex-meta-manager: - image: meisnate12/plex-meta-manager - container_name: plex-meta-manager + kometa: + image: kometateam/kometa + container_name: kometa environment: - - PMM_RUN=true - - PMM_CONFIG=/config/special-config.yml - - PMM_OVERLAYS_ONLY=true - - PMM_RUN_LIBRARIES=Movies + - KOMETA_RUN=true + - KOMETA_CONFIG=/config/special-config.yml + - KOMETA_OVERLAYS_ONLY=true + - KOMETA_RUN_LIBRARIES=Movies volumes: - /path/to/config:/config ``` -`- PMM_RUN=true` tells PMM to run right away, +`- KOMETA_RUN=true` tells Kometa to run right away, -`- PMM_CONFIG=/config/special-config.yml` points PMM at a particular config file, +`- KOMETA_CONFIG=/config/special-config.yml` points Kometa at a particular config file, -`- PMM_OVERLAYS_ONLY=true` tells PMM to run overlays only, and +`- KOMETA_OVERLAYS_ONLY=true` tells Kometa to run overlays only, and -`- PMM_RUN_LIBRARIES=Movies` tells PMM to process only a library called "Movies" +`- KOMETA_RUN_LIBRARIES=Movies` tells Kometa to process only a library called "Movies" Again, a list of the available environment variables can be found [here](../environmental.md). diff --git a/docs/pmm/install/qnap.md b/docs/kometa/install/qnap.md similarity index 88% rename from docs/pmm/install/qnap.md rename to docs/kometa/install/qnap.md index dcccc7c5..e4de8fed 100644 --- a/docs/pmm/install/qnap.md +++ b/docs/kometa/install/qnap.md @@ -1,10 +1,10 @@ # QNAP Walkthrough -This is a quick walkthrough of setting up the Plex-Meta-Manager Docker container in the QNAP "Container Station" UI. +This is a quick walkthrough of setting up the Kometa Docker container in the QNAP "Container Station" UI. The "Container Station" UI on your QNAP may differ from these screenshots, but the concepts are the same: -1. Create a container based on the `meisnate12/plex-meta-manager` image. +1. Create a container based on the `kometateam/kometa` image. 2. Set environment variables to control the container's behavior [optional]. 3. Point the container to the directory where your configuration files are to be stored. @@ -27,9 +27,9 @@ Detailed steps: Under the "Image" section you will be typing in the name and version of the docker image you wish to pull. Type in the image you wish to use as follows: ``` - meisnate12/plex-meta-manager:latest - meisnate12/plex-meta-manager:develop - meisnate12/plex-meta-manager:nightly + kometateam/kometa:latest + kometateam/kometa:develop + kometateam/kometa:nightly ``` 4. Then click Pull. @@ -68,7 +68,7 @@ Detailed steps: Anything you can do via command-line arguments can be done with [Environment Variables](../environmental.md), which is more typical in Docker environments. - For example, you could add an environment variable named `PMM_TESTS` with a value of `true` to run the collections you have defined as tests. + For example, you could add an environment variable named `KOMETA_TESTS` with a value of `true` to run the collections you have defined as tests. Click "Environments" on the left to set environment variables. @@ -108,7 +108,7 @@ Detailed steps: ![](images/qnap1.png) - 2. Search for `meisnate12/plex-meta-manager`. + 2. Search for `kometateam/kometa`. On the "Docker Hub" tab you should see the image; click on it and click "Install". @@ -125,11 +125,11 @@ Detailed steps: 4. Change the container name if you wish. - Command line arguments can be entered in the "Entrypoint" field after `/tini -s python3 plex_meta_manager.py --` + Command line arguments can be entered in the "Entrypoint" field after `/tini -s python3 kometa.py --` IMPORTANT: **DO NOT REMOVE** ANY ELEMENT OF THAT TEXT. DO NOT ENTER ANYTHING INTO THE "Command" FIELD. - For example, you could enter the following into the "Entrypoint" field to make PMM run immediately when the container starts up: `/tini -s python3 plex_meta_manager.py -- --run` + For example, you could enter the following into the "Entrypoint" field to make Kometa run immediately when the container starts up: `/tini -s python3 kometa.py -- --run` Typically, in a Docker environment, this sort of thing is done via Environment Variables [the next step here]. Editing the "Entrypoint" is not recommended, as it's easy to render the container non-functional if you are not sure what you're doing. @@ -143,7 +143,7 @@ Detailed steps: Anything you can do via command-line arguments can be done with Environment Variables, which is more typical in Docker environments. - For example, you could add an environment variable named `PMM_RUN` with a value of `True` to make PMM run immediately when the container starts up. + For example, you could add an environment variable named `KOMETA_RUN` with a value of `True` to make Kometa run immediately when the container starts up. Information on available Environment Variables can be found [here](../environmental.md) diff --git a/docs/pmm/install/synology.md b/docs/kometa/install/synology.md similarity index 89% rename from docs/pmm/install/synology.md rename to docs/kometa/install/synology.md index 9bfd29c2..a03d986d 100644 --- a/docs/pmm/install/synology.md +++ b/docs/kometa/install/synology.md @@ -1,6 +1,6 @@ # Synology Walkthrough -This is a quick walkthrough of setting up the Plex-Meta-Manager Docker container in the Synology UI. +This is a quick walkthrough of setting up the Kometa Docker container in the Synology UI. ## Prerequisite: Installing Docker @@ -12,7 +12,7 @@ This is a quick walkthrough of setting up the Plex-Meta-Manager Docker container ![Prerequisite 2](images/synology-02.png) -## Installing Plex Meta Manager +## Installing Kometa 1. Open the Docker app. @@ -21,7 +21,7 @@ This is a quick walkthrough of setting up the Plex-Meta-Manager Docker container 2. Search and Download the Image. 1. Click Registry. - 2. Search for `meisnate12/plex-meta-manager`. + 2. Search for `kometateam/kometa`. 3. Select the Repository. 4. Click Download. @@ -40,7 +40,7 @@ This is a quick walkthrough of setting up the Plex-Meta-Manager Docker container 4. Select the Image and Create a Container. 1. Click Image. - 2. Select the `meisnate12/plex-meta-manager` Image. + 2. Select the `kometateam/kometa` Image. 3. Click Launch. ![Step 4](images/synology-06.png) @@ -71,7 +71,7 @@ This is a quick walkthrough of setting up the Plex-Meta-Manager Docker container Click "Save" to save the settings and go back to the General Settings Screen. - 8. Click "Next" from the General Settings Screen to get to the Port Settings Screen where you just want to click "Next" as PMM has no Ports. + 8. Click "Next" from the General Settings Screen to get to the Port Settings Screen where you just want to click "Next" as Kometa has no Ports. ![](images/dsm7-05.png) @@ -79,7 +79,7 @@ This is a quick walkthrough of setting up the Plex-Meta-Manager Docker container ![](images/dsm7-06.png) - 10. Select from your Synology File System where you want to store your PMM config files and then enter `/config` as the "Mount path". Then click "Next" to go to the Summary Page. + 10. Select from your Synology File System where you want to store your Kometa config files and then enter `/config` as the "Mount path". Then click "Next" to go to the Summary Page. ![](images/dsm7-07.png) @@ -93,7 +93,7 @@ This is a quick walkthrough of setting up the Plex-Meta-Manager Docker container ![](images/dsm6-01.png) - 6. Next we need to add your config folder to the container. Select the "Volume" Tab, click "Add Folder," and select from your Synology File System where you want to store your PMM config files. + 6. Next we need to add your config folder to the container. Select the "Volume" Tab, click "Add Folder," and select from your Synology File System where you want to store your Kometa config files. ![](images/dsm6-02.png) diff --git a/docs/pmm/install/unraid.md b/docs/kometa/install/unraid.md similarity index 69% rename from docs/pmm/install/unraid.md rename to docs/kometa/install/unraid.md index af05f9e8..5e2ac9e1 100644 --- a/docs/pmm/install/unraid.md +++ b/docs/kometa/install/unraid.md @@ -1,8 +1,8 @@ # unRAID Walkthrough -This article will walk you through getting Plex-Meta-Manager [PMM] set up and running via Docker. It will cover: +This article will walk you through getting Kometa set up and running via Docker. It will cover: -1. Installing Plex Meta Manager unRAID app +1. Installing Kometa unRAID app 2. Retrieving the image 3. Setting up the initial config file 4. Setting up a collection file and creating a couple sample collections @@ -10,8 +10,8 @@ This article will walk you through getting Plex-Meta-Manager [PMM] set up and ru The specific steps you will be taking: -1. Verify that Plex Meta Manager unRAID app is installed and install it if not -2. Use `unRAID APPS` to retrieve the PMM Docker image +1. Verify that Kometa unRAID app is installed and install it if not +2. Use `unRAID APPS` to retrieve the Kometa Docker image 3. Create a directory for your config files and learn how to tell app to use it 4. Gather two things that the script requires: @@ -23,9 +23,9 @@ The specific steps you will be taking: 1. use `unRAID >_Console` to run the commands 2. use a text editor to modify a couple of text files until you have a working config file and a single working collection file. -If the idea of editing YAML files by hand is daunting, this may not be the tool for you. All the configuration of PMM is done via YAML text files, so if you are unable or unwilling to learn how those work, you should stop here. +If the idea of editing YAML files by hand is daunting, this may not be the tool for you. All the configuration of Kometa is done via YAML text files, so if you are unable or unwilling to learn how those work, you should stop here. -Finally, this walkthrough is intended to give you a basic grounding in how to get the script running. It doesn't cover how to create your own collections, or how to add overlays, or any of the myriad other things PMM is capable of. It provides a simple "Getting Started" guide for those for whom the standard install instructions make no sense; presumably because you've never run a unRAID app (Docker container) before. +Finally, this walkthrough is intended to give you a basic grounding in how to get the script running. It doesn't cover how to create your own collections, or how to add overlays, or any of the myriad other things Kometa is capable of. It provides a simple "Getting Started" guide for those for whom the standard install instructions make no sense; presumably because you've never run a unRAID app (Docker container) before. ## Prerequisites. @@ -35,7 +35,7 @@ Anywhere you see something like this ``` -That’s a command you’re going to type or paste into your unRAID Plex Meta Manager `>_Console` terminal (Linux). +That’s a command you’re going to type or paste into your unRAID Kometa `>_Console` terminal (Linux). **IMPORTANT NOTES:** @@ -53,12 +53,12 @@ That’s a command you’re going to type or paste into your unRAID Plex Meta Ma ### Installing Community Applications in unRAID -Thankfully, getting Plex Meta Manager working on unRAID is a fairly simple task. unRAID works mostly with docker containers, so the pre-built container available on docker hub works perfectly with a little configuration. +Thankfully, getting Kometa working on unRAID is a fairly simple task. unRAID works mostly with docker containers, so the pre-built container available on docker hub works perfectly with a little configuration. To install a container from docker hub, you will need community applications - a very popular plugin for unRAID servers. If you don't already have this installed, you can install it [here](https://forums.unraid.net/topic/38582-plug-in-community-applications/) -### Installing Plex Meta Manager in unRAID +### Installing Kometa in unRAID -1. Head to the `Apps` tab of unRAID (Community Applications), and search `plex meta manager` in the upper right search box. There will be a couple of results shown, but you should ignore them ([Why?](images.md)) and use the official image. +1. Head to the `Apps` tab of unRAID (Community Applications), and search `kometa` in the upper right search box. There will be a couple of results shown, but you should ignore them ([Why?](images.md)) and use the official image. 2. Click the `Install` button on the Template from Sohjiro's Repository Tools. @@ -66,15 +66,15 @@ To install a container from docker hub, you will need community applications - a 4. Set the `Console shell command:` to `Bash` -5. Click `Show more settings...` to set any [Environmental Variables](../environmental.md) you wish to use. **For the purposes of this walkthrough, the** `Container Path: /config` **path for the unRAID app is** `/mnt/user/appdata/plex-meta-manager/config` (_**Note the case is ALL lower case**_). Other than this, set the `PMM_TIME` variable to `5:00` under the `Show more settings...` +5. Click `Show more settings...` to set any [Environmental Variables](../environmental.md) you wish to use. **For the purposes of this walkthrough, the** `Container Path: /config` **path for the unRAID app is** `/mnt/user/appdata/kometa/config` (_**Note the case is ALL lower case**_). Other than this, set the `KOMETA_TIME` variable to `5:00` under the `Show more settings...` 6. Hit `Apply`, and allow unRAID to download the container. #### Important note on Docker images -This tutorial uses the official image, and you should, too. Don't change `meisnate12/plex-meta-manager` to the `linuxserver.io` image or any other. Other images may have [idiosyncracies](images.md) that will prevent this walkthrough from working. The official image *will* behave exactly as documented below. Others very possibly won't. +This tutorial uses the official image, and you should, too. Don't change `kometateam/kometa` to the `linuxserver.io` image or any other. Other images may have [idiosyncracies](images.md) that will prevent this walkthrough from working. The official image *will* behave exactly as documented below. Others very possibly won't. -The great thing about Docker is that all the setup you'd have to do to run PMM is already done inside the docker image. +The great thing about Docker is that all the setup you'd have to do to run Kometa is already done inside the docker image. First let's start the container. Oops! The container won't start? This is going to fail with an error. That's expected. @@ -84,21 +84,21 @@ You should see something like this in the unRAID logs for the container: ``` Config Error: config not found at //config ``` -We need to have a file called `config.yml` in the correct directory for PMM to start. Open up an unRAID terminal session by clicking on the terminal icon `>_` in the top right of unRAID. +We need to have a file called `config.yml` in the correct directory for Kometa to start. Open up an unRAID terminal session by clicking on the terminal icon `>_` in the top right of unRAID. === ":fontawesome-brands-linux: Linux" [type this into your terminal] ``` - mkdir /mnt/user/appdata/plex-meta-manager/config - touch /mnt/user/appdata/plex-meta-manager/config/config.yml + mkdir /mnt/user/appdata/kometa/config + touch /mnt/user/appdata/kometa/config/config.yml ``` -You can now close the unRAID terminal and start the PMM container. +You can now close the unRAID terminal and start the Kometa container. **_From this point forward, you can Console `>_Console` into the running container as it will stay running_** -Open a Console by left-clicking on the running Plex-Meta-Manager container and selecting `>_Console`. This will open up an interactive session within the container to be able to run the commands we want. +Open a Console by left-clicking on the running Kometcontainer and selecting `>_Console`. This will open up an interactive session within the container to be able to run the commands we want. ### Create a directory to quiet an error later @@ -127,10 +127,10 @@ First, make a copy of the template: Get a copy of the template to edit [type this into your terminal]: ``` - curl -fLvo config/config.yml https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/master/config/config.yml.template + curl -fLvo config/config.yml https://raw.githubusercontent.com/Kometa-Team/Kometa/master/config/config.yml.template ``` -Now open the copy in an editor on the machine of your choice (Use Linux tab below for the Unraid PMM `_>Console`): +Now open the copy in an editor on the machine of your choice (Use Linux tab below for the Unraid Kometa `_>Console`): {% include-markdown "./wt/wt-editor.md" @@ -142,7 +142,7 @@ Now open the copy in an editor on the machine of your choice (Use Linux tab belo #### Testing the config file -Save the file (Use Linux tab below for the Unraid PMM `_>Console`): +Save the file (Use Linux tab below for the Unraid Kometa `_>Console`): {% include-markdown "./wt/wt-save.md" @@ -178,13 +178,13 @@ So let's run the script and see this happen: ### Setting up a collection file and creating a sample collection. -(Use Linux tab below for the Unraid PMM `_>Console`): +(Use Linux tab below for the Unraid Kometa `_>Console`): {% include-markdown "./wt/wt-05-local-file.md" %} -Save the file (Use Linux tab below for the Unraid PMM `_>Console`): +Save the file (Use Linux tab below for the Unraid Kometa `_>Console`): {% include-markdown "./wt/wt-save.md" @@ -206,7 +206,7 @@ Then run the script again: include-markdown "./wt/wt-07-overlay-add.md" %} -Save the file (Use Linux tab below for the Unraid PMM `_>Console`): +Save the file (Use Linux tab below for the Unraid Kometa `_>Console`): {% include-markdown "./wt/wt-save.md" @@ -235,10 +235,10 @@ Then run the script again: %} ### I want to use the develop branch -Add the `develop` tag to the image name in your `Repository:` setting for the Plex Meta Manager unRAID app: [meisnate12/plex-meta-manager:develop] +Add the `develop` tag to the image name in your `Repository:` setting for the Kometa unRAID app: [kometateam/kometa:develop] ``` -meisnate12/plex-meta-manager:develop +kometateam/kometa:develop ^^^^^^^ ``` @@ -246,10 +246,10 @@ This may not work if you are not using the official image; for example, it does ### I want to use the nightly branch -Add the `nightly` tag to the image name in your `Repository:` setting for the Plex Meta Manager unRAID app: [meisnate12/plex-meta-manager:nightly] +Add the `nightly` tag to the image name in your `Repository:` setting for the Kometa unRAID app: [kometateam/kometa:nightly] ``` -meisnate12/plex-meta-manager:nightly +kometateam/kometa:nightly ^^^^^^^ ``` @@ -257,10 +257,10 @@ This may not work if you are not using the official image; for example, it does ### I want to ensure I am using the master branch -Add the `latest` tag to the image name in your `Repository:` setting for the Plex Meta Manager unRAID app: [meisnate12/plex-meta-manager:latest] +Add the `latest` tag to the image name in your `Repository:` setting for the Kometa unRAID app: [kometateam/kometa:latest] ``` -meisnate12/plex-meta-manager:latest +kometateam/kometa:latest ^^^^^^ ``` diff --git a/docs/pmm/install/wt/wt-01-basic-config.md b/docs/kometa/install/wt/wt-01-basic-config.md similarity index 92% rename from docs/pmm/install/wt/wt-01-basic-config.md rename to docs/kometa/install/wt/wt-01-basic-config.md index 79e9f0c1..081c83e4 100644 --- a/docs/pmm/install/wt/wt-01-basic-config.md +++ b/docs/kometa/install/wt/wt-01-basic-config.md @@ -1,4 +1,4 @@ -Next you’ll set up the config file. This tells PMM how to connect to Plex and a variety of other services. +Next you’ll set up the config file. This tells Kometa how to connect to Plex and a variety of other services. Before you do this you’ll need: diff --git a/docs/pmm/install/wt/wt-02-config-bad-library.md b/docs/kometa/install/wt/wt-02-config-bad-library.md similarity index 66% rename from docs/pmm/install/wt/wt-02-config-bad-library.md rename to docs/kometa/install/wt/wt-02-config-bad-library.md index 6afc7466..6dec7ca1 100644 --- a/docs/pmm/install/wt/wt-02-config-bad-library.md +++ b/docs/kometa/install/wt/wt-02-config-bad-library.md @@ -25,36 +25,36 @@ Now scroll up and look at the top section: libraries: # This is called out once within the config.yml file Movies: # Each library must match the Plex library name collection_files: - - pmm: basic # This is a file within the defaults folder in the Repository - - pmm: imdb # This is a file within the defaults folder in the Repository + - default: basic # This is a file within the defaults folder in the Repository + - default: imdb # This is a file within the defaults folder in the Repository # see the wiki for how to use local files, folders, URLs, or files from git remove_overlays: false # Set this to true to remove all overlays overlay_files: - - pmm: ribbon # This is a file within the defaults folder in the Repository + - default: ribbon # This is a file within the defaults folder in the Repository # see the wiki for how to use local files, folders, URLs, or files from git TV Shows: collection_files: - - pmm: basic # This is a file within the defaults folder in the Repository - - pmm: imdb # This is a file within the defaults folder in the Repository + - default: basic # This is a file within the defaults folder in the Repository + - default: imdb # This is a file within the defaults folder in the Repository # see the wiki for how to use local files, folders, URLs, or files from git remove_overlays: false # Set this to true to remove all overlays overlay_files: - - pmm: ribbon # This is a file within the defaults folder in the Repository + - default: ribbon # This is a file within the defaults folder in the Repository # see the wiki for how to use local files, folders, URLs, or files from git Anime: collection_files: - - pmm: basic # This is a file within the defaults folder in the Repository - - pmm: anilist # This is a file within the defaults folder in the Repository + - default: basic # This is a file within the defaults folder in the Repository + - default: anilist # This is a file within the defaults folder in the Repository # see the wiki for how to use local files, folders, URLs, or files from git Music: collection_files: - file: config/Music.yml # This is a local file THAT YOU MIGHT CREATE playlist_files: - - pmm: playlist # This is a file within PMM's defaults folder + - default: playlist # This is a file within Kometa's defaults folder # see the wiki for how to use local files, folders, URLs, or files from git ``` -You will ultimately need an entry here for each of the libraries on which you want PMM to act. Those top-level elements [Movies, TV Shows, Anime, Music] are names of libraries on your Plex server. +You will ultimately need an entry here for each of the libraries on which you want Kometa to act. Those top-level elements [Movies, TV Shows, Anime, Music] are names of libraries on your Plex server. For now, delete the “TV Shows”, “Anime”, and "Music" sections from the config file and change the name of the “Movies” section to “Movies-NOSUCHLIBRARY": @@ -64,11 +64,11 @@ The top bit of your config file should now looke like this: libraries: Movies-NOSUCHLIBRARY: ## <<< CHANGE THIS LINE collection_files: - - pmm: basic # This is a file within the defaults folder in the Repository - - pmm: imdb # This is a file within the defaults folder in the Repository + - default: basic # This is a file within the defaults folder in the Repository + - default: imdb # This is a file within the defaults folder in the Repository # see the wiki for how to use local files, folders, URLs, or files from git playlist_files: - - pmm: playlist # This is a file within PMM's defaults folder + - default: playlist # This is a file within Kometa's defaults folder # see the wiki for how to use local files, folders, URLs, or files from git ``` diff --git a/docs/pmm/install/wt/wt-03-lib-err-and-fix.md b/docs/kometa/install/wt/wt-03-lib-err-and-fix.md similarity index 69% rename from docs/pmm/install/wt/wt-03-lib-err-and-fix.md rename to docs/kometa/install/wt/wt-03-lib-err-and-fix.md index 92ae65a1..1388e92b 100644 --- a/docs/pmm/install/wt/wt-03-lib-err-and-fix.md +++ b/docs/kometa/install/wt/wt-03-lib-err-and-fix.md @@ -6,7 +6,7 @@ I’ve removed some of the lines for space, but have left the important bits: ... | Locating config... | -| Using /Users/mroche/Plex-Meta-Manager/config/config.yml as config +| Using /Users/mroche/Kometa/config/config.yml as config ... | Connecting to TMDb... | TMDb Connection Successful @@ -22,7 +22,7 @@ I’ve removed some of the lines for space, but have left the important bits: ... ``` -You can see there that PMM found its config file, was able to connect to TMDb, was able to connect to Plex, and then failed trying to read the “Movies-NOSUCHLIBRARY" library, which of course doesn’t exist. +You can see there that Kometa found its config file, was able to connect to TMDb, was able to connect to Plex, and then failed trying to read the “Movies-NOSUCHLIBRARY" library, which of course doesn’t exist. Open the config file again and change "Movies-NOSUCHLIBRARY" to reflect *your own* Movie library in Plex. @@ -32,8 +32,8 @@ Say my Movies library is called “All The Movies", so mine looks like this: libraries: All The Movies: ## <<< CHANGE THIS LINE collection_files: - - pmm: basic # This is a file within the defaults folder in the Repository - - pmm: imdb # This is a file within the defaults folder in the Repository + - default: basic # This is a file within the defaults folder in the Repository + - default: imdb # This is a file within the defaults folder in the Repository # see the wiki for how to use local files, folders, URLs, or files from git ``` @@ -43,11 +43,11 @@ At this point, the top bit of your config file should look like this: libraries: THE_NAME_OF_YOUR_MOVIE_LIBRARY: ## <<< CHANGE THIS LINE collection_files: - - pmm: basic # This is a file within the defaults folder in the Repository - - pmm: imdb # This is a file within the defaults folder in the Repository + - default: basic # This is a file within the defaults folder in the Repository + - default: imdb # This is a file within the defaults folder in the Repository # see the wiki for how to use local files, folders, URLs, or files from git playlist_files: - - pmm: playlist # This is a file within PMM's defaults folder + - default: playlist # This is a file within Kometa's defaults folder # see the wiki for how to use local files, folders, URLs, or files from git ``` diff --git a/docs/pmm/install/wt/wt-04-default-intro.md b/docs/kometa/install/wt/wt-04-default-intro.md similarity index 69% rename from docs/pmm/install/wt/wt-04-default-intro.md rename to docs/kometa/install/wt/wt-04-default-intro.md index 25ac886f..89e57923 100644 --- a/docs/pmm/install/wt/wt-04-default-intro.md +++ b/docs/kometa/install/wt/wt-04-default-intro.md @@ -1,4 +1,4 @@ -Plex-Meta-Manager provides an extensive collection of "default" collection files. +Kometa provides an extensive collection of "default" collection files. These files provide a simple way for you to create collections based on franchises or awards or actors, etc. @@ -8,10 +8,10 @@ The default config links to two of them, thse two lines in your config file: libraries: THE_NAME_OF_YOUR_MOVIE_LIBRARY: collection_files: - - pmm: basic # <<< THIS LINE - - pmm: imdb # <<< THIS LINE + - default: basic # <<< THIS LINE + - default: imdb # <<< THIS LINE playlist_files: - - pmm: playlist + - default: playlist ``` The first will create: diff --git a/docs/pmm/install/wt/wt-04b-default-after.md b/docs/kometa/install/wt/wt-04b-default-after.md similarity index 100% rename from docs/pmm/install/wt/wt-04b-default-after.md rename to docs/kometa/install/wt/wt-04b-default-after.md diff --git a/docs/pmm/install/wt/wt-05-local-file.md b/docs/kometa/install/wt/wt-05-local-file.md similarity index 90% rename from docs/pmm/install/wt/wt-05-local-file.md rename to docs/kometa/install/wt/wt-05-local-file.md index 3858dc10..92a24cbd 100644 --- a/docs/pmm/install/wt/wt-05-local-file.md +++ b/docs/kometa/install/wt/wt-05-local-file.md @@ -1,4 +1,4 @@ -If the default collection files do not allow you to create the collections you want, you can define your own collections in your own collection files to do whatever you like within the capabilities of PMM. We will create a simple collection that will contain 20 comedy movies released since 2012. +If the default collection files do not allow you to create the collections you want, you can define your own collections in your own collection files to do whatever you like within the capabilities of Kometa. We will create a simple collection that will contain 20 comedy movies released since 2012. First, open the collection file [this will create the file if it doesn't already exist]: @@ -53,8 +53,8 @@ Open the config file again and add the last line shown below: libraries: All The Movies: collection_files: - - pmm: basic - - pmm: imdb + - default: basic + - default: imdb # see the wiki for how to use local files, folders, URLs, or files from git - file: config/Movies.yml ## <<< ADD THIS LINE ``` diff --git a/docs/pmm/install/wt/wt-06-local-after.md b/docs/kometa/install/wt/wt-06-local-after.md similarity index 81% rename from docs/pmm/install/wt/wt-06-local-after.md rename to docs/kometa/install/wt/wt-06-local-after.md index d07d93fe..1e0eaf44 100644 --- a/docs/pmm/install/wt/wt-06-local-after.md +++ b/docs/kometa/install/wt/wt-06-local-after.md @@ -11,6 +11,6 @@ You should see the new collection: ![Finished Collections](../images/wt-finished.png) -When you click into each, you’ll see the movies that PMM added to each collection. +When you click into each, you’ll see the movies that Kometa added to each collection. -Each time you run the script, new movies that match the collection definitions will be added. For example, if you don’t have “The ShawShank Redemption” now, when you download it and run PMM again it will be added to the IMDB 250 collection. +Each time you run the script, new movies that match the collection definitions will be added. For example, if you don’t have “The ShawShank Redemption” now, when you download it and run Kometa again it will be added to the IMDB 250 collection. diff --git a/docs/pmm/install/wt/wt-07-overlay-add.md b/docs/kometa/install/wt/wt-07-overlay-add.md similarity index 66% rename from docs/pmm/install/wt/wt-07-overlay-add.md rename to docs/kometa/install/wt/wt-07-overlay-add.md index 130da34d..f7dee1c3 100644 --- a/docs/pmm/install/wt/wt-07-overlay-add.md +++ b/docs/kometa/install/wt/wt-07-overlay-add.md @@ -8,11 +8,11 @@ Open the config file again and add the last three lines shown below: libraries: All The Movies: collection_files: - - pmm: basic # This is a file within the defaults folder in the Repository - - pmm: imdb # This is a file within the defaults folder in the Repository + - default: basic # This is a file within the defaults folder in the Repository + - default: imdb # This is a file within the defaults folder in the Repository # see the wiki for how to use local files, folders, URLs, or files from git - file: config/Movies.yml remove_overlays: false ## <<< ADD THIS LINE overlay_files: ## <<< ADD THIS LINE - - pmm: resolution ## <<< ADD THIS LINE + - default: resolution ## <<< ADD THIS LINE ``` diff --git a/docs/pmm/install/wt/wt-08-overlay-after.md b/docs/kometa/install/wt/wt-08-overlay-after.md similarity index 93% rename from docs/pmm/install/wt/wt-08-overlay-after.md rename to docs/kometa/install/wt/wt-08-overlay-after.md index 0c4eaf98..42596f10 100644 --- a/docs/pmm/install/wt/wt-08-overlay-after.md +++ b/docs/kometa/install/wt/wt-08-overlay-after.md @@ -1,4 +1,4 @@ -While it runs this time you should see the previous collections go by pretty quickly, since they aren't changing, and then a lot of logging as PMM decides which overlays apply to which movies. +While it runs this time you should see the previous collections go by pretty quickly, since they aren't changing, and then a lot of logging as Kometa decides which overlays apply to which movies. This may take quite a while depending on the size of this library. diff --git a/docs/pmm/install/wt/wt-09-next-steps.md b/docs/kometa/install/wt/wt-09-next-steps.md similarity index 73% rename from docs/pmm/install/wt/wt-09-next-steps.md rename to docs/kometa/install/wt/wt-09-next-steps.md index 9da7e1c2..d5902100 100644 --- a/docs/pmm/install/wt/wt-09-next-steps.md +++ b/docs/kometa/install/wt/wt-09-next-steps.md @@ -1,11 +1,11 @@ ### What comes next: -If you want to remove those overlays, open the config file, change the value of `remove_overlays` to `true`, and rerun PMM. +If you want to remove those overlays, open the config file, change the value of `remove_overlays` to `true`, and rerun Kometa. ``` remove_overlays: true overlay_files: - - pmm: resolution + - default: resolution ``` If you want to remove those collections, open the config file, remove or comment out [add `#` to the beginning] any or all of those lines under `collection_files`, and delete the collections manually from Plex. @@ -14,20 +14,20 @@ If you want to remove those collections, open the config file, remove or comment libraries: All The Movies: collection_files: - # - pmm: basic # This is a file within the defaults folder in the Repository - # - pmm: imdb # This is a file within the defaults folder in the Repository + # - default: basic # This is a file within the defaults folder in the Repository + # - default: imdb # This is a file within the defaults folder in the Repository # see the wiki for how to use local files, folders, URLs, or files from git # - file: config/Movies.yml remove_overlays: false overlay_files: - - pmm: resolution + - default: resolution ``` -Edit `Movies.yml` to reflect the actions you want PMM to perform on *your* libraries. +Edit `Movies.yml` to reflect the actions you want Kometa to perform on *your* libraries. TV Shows and other libraries work the same way as you've seen above. Create a section under `libraries:` in the config.yml, refer to default files or create a collection file, define collections, run the script. -Investigate the rest of the wiki to learn about everything Plex-Meta-Manager can do for you. +Investigate the rest of the wiki to learn about everything Kometa can do for you. ### Runtime and Environment Flags diff --git a/docs/kometa/install/wt/wt-10-scheduling.md b/docs/kometa/install/wt/wt-10-scheduling.md new file mode 100644 index 00000000..7c35b52b --- /dev/null +++ b/docs/kometa/install/wt/wt-10-scheduling.md @@ -0,0 +1,15 @@ +The commands you've been using in this walkthrough run Kometa immediately then quit. + +Kometa also features multiple layers of scheduling, which you can leverage to control when various activities take place. + + - You can run Kometa in the background, telling it to wake up and process your libraries at fixed times during the day. The default behavior in this regard is to wake up at 5AM and process the config. If you leave the `-r` off the commands you have been using in this walkthrough, that's what will happen. + + You can control when Kometa wakes up with the [time-to-run](../../environmental.md) env-var/runtime flag. + + - You can skip using that internal schedule and just do manual runs as you have been doing throughout this walkthrough using standard tools available in your OS. + + Details on setting this up are found [here](../../guides/scheduling.md). + + - In addition, individual items *within* the configuration can be scheduled to take place at certain times *provided Kometa is running at that time*. For example, you can tell Kometa only to apply overlays on Tuesdays or the like. You can then schedule manual runs every day at noon and overlays will only get processed when it runs on Tuesday. This sort of schedule *will not* make Kometa start up if it is not already running. If you don't arrange for Kometa to be run on Tuesday, your overlays would never be processed in this example. + + Details on this level of scheduling are found [here](../../../config/schedule.md) diff --git a/docs/pmm/install/wt/wt-editor.md b/docs/kometa/install/wt/wt-editor.md similarity index 100% rename from docs/pmm/install/wt/wt-editor.md rename to docs/kometa/install/wt/wt-editor.md diff --git a/docs/kometa/install/wt/wt-run-docker.md b/docs/kometa/install/wt/wt-run-docker.md new file mode 100644 index 00000000..117af62f --- /dev/null +++ b/docs/kometa/install/wt/wt-run-docker.md @@ -0,0 +1,5 @@ +[type this into your terminal] + +``` +docker run --rm -it -v "KOMETA_PATH_GOES_HERE:/config:rw" kometateam/kometa --run +``` diff --git a/docs/pmm/install/wt/wt-run-shell.md b/docs/kometa/install/wt/wt-run-shell.md similarity index 59% rename from docs/pmm/install/wt/wt-run-shell.md rename to docs/kometa/install/wt/wt-run-shell.md index 766cf152..8af2fb14 100644 --- a/docs/pmm/install/wt/wt-run-shell.md +++ b/docs/kometa/install/wt/wt-run-shell.md @@ -1,5 +1,5 @@ [type this into your terminal] ```shell -python plex_meta_manager.py -r +python kometa.py -r ``` diff --git a/docs/pmm/install/wt/wt-save.md b/docs/kometa/install/wt/wt-save.md similarity index 100% rename from docs/pmm/install/wt/wt-save.md rename to docs/kometa/install/wt/wt-save.md diff --git a/docs/pmm/install/wt/wt-test-library.md b/docs/kometa/install/wt/wt-test-library.md similarity index 84% rename from docs/pmm/install/wt/wt-test-library.md rename to docs/kometa/install/wt/wt-test-library.md index dc01374d..efa9fcd0 100644 --- a/docs/pmm/install/wt/wt-test-library.md +++ b/docs/kometa/install/wt/wt-test-library.md @@ -1,4 +1,4 @@ -While going through this process, Plex-Meta-Manager is going to load the movies in your library, create some collections, and apply some overlays. If you have a large library, this will be very time-consuming. +While going through this process, Kometa is going to load the movies in your library, create some collections, and apply some overlays. If you have a large library, this will be very time-consuming. For learning and testing, you would be well-advised to create a small test library of a reasonable size, where reasonable it probably below a thousand. diff --git a/docs/pmm/logs.md b/docs/kometa/logs.md similarity index 81% rename from docs/pmm/logs.md rename to docs/kometa/logs.md index 3c46b78b..3dca0098 100644 --- a/docs/pmm/logs.md +++ b/docs/kometa/logs.md @@ -6,33 +6,33 @@ search: ### Locating Log Files -The meta.log file can be found within the `logs` folder of your Plex Meta Manager config folder [right next to `config.yml`]. +The kometa.log file can be found within the `logs` folder of your Kometa config folder [right next to `config.yml`]. -`meta.log` is the most recent run of Plex Meta Manager, `meta.log.1` is the previous run, `meta.log.2` is the run before that, so on and so forth. +`kometa.log` is the most recent run of Kometa, `kometa.log.1` is the previous run, `kometa.log.2` is the run before that, so on and so forth. -As new log files are created, the old ones get a numeric suffix added: `meta.log.1`. **The most recent is always the one without a number at the end.** +As new log files are created, the old ones get a numeric suffix added: `kometa.log.1`. **The most recent is always the one without a number at the end.** ### Providing Log Files on Discord -You can drag-and-drop your meta.log file directly into [Discord](https://metamanager.wiki/en/latest/discord/), you do not need to upload it to a third-party site unless it exceeds the 50mb size limit. +You can drag-and-drop your kometa.log file directly into [Discord](https://kometa.wiki/en/latest/discord/), you do not need to upload it to a third-party site unless it exceeds the 50mb size limit. Please DO NOT manually extract, copy and paste text from your log files directly into Discord as the formatting can be difficult to read and can often redact parts of the log file that are important for full context. ### Basic Log File Troubleshooting -Wondering how to troubleshoot Plex Meta Manager and how to read through the meta.log? +Wondering how to troubleshoot Kometa and how to read through the kometa.log? **Using a text editor like [Visual Studio Code](https://code.visualstudio.com/) or [Sublime Text](https://www.sublimetext.com/) is recommended** -In all cases, the first step is to open the [`meta.log`](#locating-log-files) with your text editor and perform these steps: +In all cases, the first step is to open the [`kometa.log`](#locating-log-files) with your text editor and perform these steps: -1. Check that you are running the latest [`version`](#checking-plex-meta-manager-version) of your branch. Your current version can be found in the `meta.log` file either below the Plex Meta Manager ASCII art, or at the end of the run. If you are not on the latest version of your branch, you will see `Newest Version: X.X.X` below this. Ensure you [`upgrade`](install/local.md#i-want-to-update-to-the-latest-version-of-pmm) to the latest version of Plex Meta Manager. -2. When scanning your meta.log file, search for `[CRITICAL]` items first as these will definitely need to be fixed -3. Scan your meta.log file for `[ERROR]` and make a note of the content of the full line to start your search below on how to resolve +1. Check that you are running the latest [`version`](#checking-Kometa-version) of your branch. Your current version can be found in the `kometa.log` file either below the Kometa ASCII art, or at the end of the run. If you are not on the latest version of your branch, you will see `Newest Version: X.X.X` below this. Ensure you [`upgrade`](install/local.md#i-want-to-update-to-the-latest-version-of-kometa) to the latest version of Kometa. +2. When scanning your kometa.log file, search for `[CRITICAL]` items first as these will definitely need to be fixed +3. Scan your kometa.log file for `[ERROR]` and make a note of the content of the full line to start your search below on how to resolve -### Checking Plex Meta Manager Version +### Checking Kometa Version -Checking the version: You will find that in your [`meta.log`](#locating-log-files) around the 8th-10th line and will look something like this: +Checking the version: You will find that in your [`kometa.log`](#locating-log-files) around the 8th-10th line and will look something like this: ``` | | @@ -40,7 +40,7 @@ Checking the version: You will find that in your [`meta.log`](#locating-log-file |=================================| ``` -If you are not on the latest version of your branch, you will see Newest Version: X.X.X below this. Ensure you upgrade to the latest version of Plex Meta Manager. +If you are not on the latest version of your branch, you will see Newest Version: X.X.X below this. Ensure you upgrade to the latest version of Kometa. ``` | | @@ -59,7 +59,7 @@ There are five main event types that you need to be aware of when understanding | `DEBUG` | Debug Log | Debug log message that does not require much attention | No action required | | `WARNING` | Warning Log | Warning message that may require your attention | Read the warning and determine if this is something you need to take action on or not | | `ERROR` | Error Log | Error message that in MOST cases requires action on your part to resolve | Read the error message, look for the message below and try recommendations | -| `CRITICAL` | Critical Log | Critical message requiring you to fix it for PMM to run properly | Read the critical message and take appropriate action. look for message below and try recommendations | +| `CRITICAL` | Critical Log | Critical message requiring you to fix it for Kometa to run properly | Read the critical message and take appropriate action. look for message below and try recommendations | ### Common Log File Messages @@ -71,7 +71,7 @@ This table details examples of the most commonly-seen `[CRITICAL]` events and wh | Type | Short Info | Description | Recommendation | |:-----------|:----------------------------------------------------|:------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------| -| `CRITICAL` | `Failed to Connect to https://api.themoviedb.org/3` | Current step PMM was on made an API call to TMDb, but it aborted and moved on | Determine if TMDb was offline and not replying to api requests. Try again and see if it fails again or not. | +| `CRITICAL` | `Failed to Connect to https://api.themoviedb.org/3` | Current step Kometa was on made an API call to TMDb, but it aborted and moved on | Determine if TMDb was offline and not replying to api requests. Try again and see if it fails again or not. | #### ERROR @@ -81,13 +81,13 @@ This table details examples of the most commonly-seen `[ERROR]` events and what |:--------|:------------------------------------------------------------------|:---------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `ERROR` | `Playlist Error: Library: XYZ not defined` | Plex library XYZ is not found | Ensure that your config file has defined the proper library name as found in Plex | | `ERROR` | `Plex Error: resolution: No matches found with regex pattern XYZ` | While looking for a pattern in Plex, this one was not found | This may be normal and require 0 actions. However, if you expect that Plex should have returned records, check the pattern to ensure it is working properly | -| `ERROR` | `Plex Error: No Items found in Plex` | While using the PMM builder, no items with that criteria were returned from Plex | This may be normal and require 0 actions. However, if you expect that Plex should have returned records, check the builder to ensure it is working properly | -| `ERROR` | `IMDb Error: Failed to parse URL:` | While using the PMM builder, url does not exist | This may be normal and require 0 actions. However, if you expect that the URL should have returned records, check the url in your browser to ensure it is working properly | +| `ERROR` | `Plex Error: No Items found in Plex` | While using the Kometa builder, no items with that criteria were returned from Plex | This may be normal and require 0 actions. However, if you expect that Plex should have returned records, check the builder to ensure it is working properly | +| `ERROR` | `IMDb Error: Failed to parse URL:` | While using the Kometa builder, url does not exist | This may be normal and require 0 actions. However, if you expect that the URL should have returned records, check the url in your browser to ensure it is working properly | | `ERROR` | `Trakt Error: No TVDb ID found for Nightfall (2022)` | Online sources are missing information | These sorts of errors indicate that the thing can't be cross-referenced between sites.</br>For example, at the time of that error, the Trakt record for "Nightfall (2022)" didn't contain a TVDb ID.</br>This could be because the record just hasn't been updated, or because "Nightfall (2022)" is not listed on TVDb.</br>The fix is for someone [like you, perhaps] to go to the relevant site and fill in the missing data. | | `ERROR` | `MdbList Error: Not Found` | Online sources are missing information | These sorts of errors indicate that the thing can't be cross-referenced between sites. For example, at the time of that error, the MDBlist record was trying to get a rating for a media item and could not find it. | -| `ERROR` | `Plex Error: actor: Mel B not found` | Actor not found and hence unable to create the collection | Report error in #pmm-help channel and see if there is a fix. | -| `ERROR` | `Input Failed` | A token or password is no longer valid for an online source of information | Review the meta.log for more information | -| `ERROR` | `Collection Error: trakt_list requires Trakt to be configured` | You are using a builder that has not been configured yet. | Review the meta.log for more information on what went wrong. Refer to the wiki for details on how to set this up (in this case Trakt) | +| `ERROR` | `Plex Error: actor: Mel B not found` | Actor not found and hence unable to create the collection | Report error in #kometa-help channel and see if there is a fix. | +| `ERROR` | `Input Failed` | A token or password is no longer valid for an online source of information | Review the kometa.log for more information | +| `ERROR` | `Collection Error: trakt_list requires Trakt to be configured` | You are using a builder that has not been configured yet. | Review the kometa.log for more information on what went wrong. Refer to the wiki for details on how to set this up (in this case Trakt) | #### WARNING @@ -106,11 +106,11 @@ This table details examples of the most commonly-seen `[INFO]` events and what t | Type | Short Info | Description | Recommendation | |:-------|:----------------------------------------------|:--------------------------------------|:------------------------------------------------------------------------------------------------------------------------------| -| `INFO` | `Detail: TMDb_person updated poster to [URL]` | Person image was downloaded from TMDb | May require you to update the people poster image to your style or request it in the style of the PMM defaults people posters | +| `INFO` | `Detail: TMDb_person updated poster to [URL]` | Person image was downloaded from TMDb | May require you to update the people poster image to your style or request it in the style of the Kometa defaults people posters | ### Other Troubleshooting Examples -The Log files will contain a great deal of detail about what exactly is happening and why. Generally speaking, if you're having a problem with PMM the answer will be found here. These logs can of course be quite technical, but often the error can be relatively clear: +The Log files will contain a great deal of detail about what exactly is happening and why. Generally speaking, if you're having a problem with Kometa the answer will be found here. These logs can of course be quite technical, but often the error can be relatively clear: Something's missing from the format of the file: @@ -171,9 +171,9 @@ collections: <<< THIS LINE WAS MISSING - https://trakt.tv/users/kesleyalfa/lists/year-2011 ``` -File is not where PMM expects it: +File is not where Kometa expects it: ``` | Loading Collection File: config/Movies.yml | -| YAML Error: File Error: File does not exist /Users/Lucky/Plex-Meta-Manager/config/Movies.yml | +| YAML Error: File Error: File does not exist /Users/Lucky/Kometa/config/Movies.yml | ``` diff --git a/docs/kometa/scripts/imagemaid.md b/docs/kometa/scripts/imagemaid.md new file mode 100644 index 00000000..aa70dba0 --- /dev/null +++ b/docs/kometa/scripts/imagemaid.md @@ -0,0 +1,13 @@ +{% + include-markdown "https://raw.githubusercontent.com/Kometa-Team/ImageMaid/develop/README.md" + rewrite-relative-urls=true + comments=false + end="![](cleanup.png)" +%} +![](images/cleanup.png) +{% + include-markdown "https://raw.githubusercontent.com/Kometa-Team/ImageMaid/develop/README.md" + rewrite-relative-urls=true + comments=false + start="![](cleanup.png)" +%} \ No newline at end of file diff --git a/docs/pmm/scripts/images/cleanup.png b/docs/kometa/scripts/images/cleanup.png similarity index 100% rename from docs/pmm/scripts/images/cleanup.png rename to docs/kometa/scripts/images/cleanup.png diff --git a/docs/kometa/scripts/overlay-reset.md b/docs/kometa/scripts/overlay-reset.md new file mode 100644 index 00000000..f10e887a --- /dev/null +++ b/docs/kometa/scripts/overlay-reset.md @@ -0,0 +1,5 @@ +{% + include-markdown "https://raw.githubusercontent.com/Kometa-Team/Overlay-Reset/develop/README.md" + rewrite-relative-urls=true + comments=false +%} \ No newline at end of file diff --git a/docs/kometa/scripts/overview.md b/docs/kometa/scripts/overview.md new file mode 100644 index 00000000..eff5d9b3 --- /dev/null +++ b/docs/kometa/scripts/overview.md @@ -0,0 +1,8 @@ +# Companion Scripts + +Each Companion Script is a separate project that has its own Docker container and GitHub Repository. + +| Name | Description | Readme | +|:-----------------------|:---------------------------------------------------------|:--------------------------------------------------------------------------------| +| `Kometa Overlay Reset` | Script to completely remove all Kometa applied Overlays. | [Wiki](overlay-reset.md)/[GitHub](https://github.com/Kometa-Team/Overlay-Reset) | +| `ImageMaid` | Script to clean up Plex's Image Cache. | [Wiki](imagemaid.md)/[GitHub](https://github.com/Kometa-Team/ImageMaid) | diff --git a/docs/pmm/yaml.md b/docs/kometa/yaml.md similarity index 82% rename from docs/pmm/yaml.md rename to docs/kometa/yaml.md index d523ee3d..1e494fc9 100644 --- a/docs/pmm/yaml.md +++ b/docs/kometa/yaml.md @@ -1,6 +1,6 @@ # YAML Files Explained -All of Plex Meta Manager's Config, Metadata, Overlay, and Playlist Files are written in the YAML data structure. +All of Kometa's Config, Metadata, Overlay, and Playlist Files are written in the YAML data structure. This tutorial will help you understand the specific parts of the files. @@ -10,19 +10,19 @@ This tutorial will help you understand the specific parts of the files. libraries: Movies: collection_files: - - pmm: basic - - pmm: imdb + - default: basic + - default: imdb overlay_files: - - pmm: ribbon + - default: ribbon template_variables: use_metacritic: false use_common: false TV Shows: collection_files: - - pmm: basic - - pmm: imdb + - default: basic + - default: imdb overlay_files: - - pmm: ribbon + - default: ribbon settings: cache: true cache_expiration: 60 @@ -51,19 +51,19 @@ Let us try and identify where these appear in the sample YAML file we saw earlie libraries: # Value is a Dictionary with keys `Movies` and `TV Shows` Movies: # Value is a Dictionary with keys `collection_files` and `overlay_files` collection_files: # Value is a List with two Items - - pmm: basic # List Item is a Dictionary with one key pair whose value is a String Literal - - pmm: imdb # List Item is a Dictionary with one key pair whose value is a String Literal + - default: basic # List Item is a Dictionary with one key pair whose value is a String Literal + - default: imdb # List Item is a Dictionary with one key pair whose value is a String Literal overlay_files: # Value is a List with one Item - - pmm: ribbon # List Item is a Dictionary with keys `pmm` and `template_variables` with `pmm`'s value a String Literal + - default: ribbon # List Item is a Dictionary with keys `default` and `template_variables` with `default`'s value a String Literal template_variables: # Value is a Dictionary with keys `use_metacritic` and `use_common` use_metacritic: false # Value is a Boolean Literal use_common: false # Value is a Boolean Literal TV Shows: # Value is a Dictionary with keys `collection_files` and `overlay_files` collection_files: # Value is a List with two Items - - pmm: basic # List Item is a Dictionary with one key pair whose value is a String Literal - - pmm: imdb # List Item is a Dictionary with one key pair whose value is a String Literal + - default: basic # List Item is a Dictionary with one key pair whose value is a String Literal + - default: imdb # List Item is a Dictionary with one key pair whose value is a String Literal overlay_files: # Value is a List with one Item - - pmm: ribbon # List Item is a Dictionary with one key pair whose value is a String Literal + - default: ribbon # List Item is a Dictionary with one key pair whose value is a String Literal settings: # Value is a Dictionary with keys `cache` and `cache_expiration` cache: true # Value is a Boolean Literal cache_expiration: 60 # Value is a Number Literal @@ -82,19 +82,19 @@ A YAML file relies on whitespace and indentation to indicate nesting. The number libraries: # Nesting Level 1 Movies: # Nesting Level 2 collection_files: # Nesting Level 3 - - pmm: basic # Nesting Level 4 - - pmm: imdb # Nesting Level 4 + - default: basic # Nesting Level 4 + - default: imdb # Nesting Level 4 overlay_files: # Nesting Level 3 - - pmm: ribbon # Nesting Level 4 + - default: ribbon # Nesting Level 4 template_variables: # Nesting Level 5 use_metacritic: false # Nesting Level 6 use_common: false # Nesting Level 6 TV Shows: # Nesting Level 2 collection_files: # Nesting Level 3 - - pmm: basic # Nesting Level 4 - - pmm: imdb # Nesting Level 4 + - default: basic # Nesting Level 4 + - default: imdb # Nesting Level 4 overlay_files: # Nesting Level 3 - - pmm: ribbon # Nesting Level 4 + - default: ribbon # Nesting Level 4 settings: # Nesting Level 1 cache: true # Nesting Level 2 cache_expiration: 60 # Nesting Level 2 @@ -218,19 +218,19 @@ In YAML files, anchors (`&`) and aliases (`*`) are used to avoid duplication. Wh libraries: Movies: collection_files: - - pmm: basic - - pmm: imdb + - default: basic + - default: imdb overlay_files: - - pmm: ribbon + - default: ribbon template_variables: use_metacritic: false use_common: false TV Shows: collection_files: - - pmm: basic - - pmm: imdb + - default: basic + - default: imdb overlay_files: - - pmm: ribbon + - default: ribbon ``` As more and more things are repeated for large configuration files, this becomes tedious. @@ -243,15 +243,15 @@ Anchors (`&`) are used to define a chunk of configuration, and aliases (`*`) are libraries: Movies: collection_files: &paths # Anchor called `paths` - - pmm: basic - - pmm: imdb + - default: basic + - default: imdb overlay_files: - - pmm: ribbon + - default: ribbon template_variables: use_metacritic: false use_common: false TV Shows: collection_files: *paths # Alias to call the above `paths` section overlay_files: - - pmm: ribbon + - default: ribbon ``` \ No newline at end of file diff --git a/docs/notused/contributor.md b/docs/notused/contributor.md index 8db04fb9..a3cdbc9a 100644 --- a/docs/notused/contributor.md +++ b/docs/notused/contributor.md @@ -3,6 +3,6 @@ ## How to set up a local Wiki Server 1. In addition to your normal `python -m pip install -r requirements.txt` to install requirements you'll also need to install the docs `requirements.txt` by running `python -m pip install -r docs/requirements.txt`. -2. Run `docs\make.bat html` from the main PMM directory to build the html wiki files. +2. Run `docs\make.bat html` from the main Kometa directory to build the html wiki files. 3. Run `sphinx-reload docs` to boot up the Reloading Server at `http://localhost:5500` 4. Now you can make changes inside the docs folder to update the Wiki and when you want to see the changes just run `docs\make.bat html` again and then refresh that page. \ No newline at end of file diff --git a/docs/notused/initial.md b/docs/notused/initial.md index 44b720f4..0782ba79 100644 --- a/docs/notused/initial.md +++ b/docs/notused/initial.md @@ -1,7 +1,7 @@ # Initial Setup Guide -**Before using this guide you should already have installed Plex Meta Manager.** +**Before using this guide you should already have installed Kometa.** -See the [Installation Page](../pmm/install/overview.md) for info on how to install Plex Meta Manager. +See the [Installation Page](../kometa/install/overview.md) for info on how to install Kometa. -This guide is assuming you know how to run pmm with the `--run` run command or the `PMM_RUN` environment variable to perform immediate runs \ No newline at end of file +This guide is assuming you know how to run Kometwith the `--run` run command or the `KOMETA_RUN` environment variable to perform immediate runs \ No newline at end of file diff --git a/docs/notused/playlists.md b/docs/notused/playlists.md index 4972396e..210f4907 100644 --- a/docs/notused/playlists.md +++ b/docs/notused/playlists.md @@ -2,14 +2,14 @@ As playlists are not tied to one specific library and can combine media from multiple libraries, they require their own special [Playlist Files](../files/playlists.md) to work. -Within the [Config File](overview.md), the `playlist_files` attribute specifies the [path type](../files/files.md#paths) and path of the [Playlist Files](../files/playlists.md) that the user wants Plex Meta Manager to act on. +Within the [Config File](overview.md), the `playlist_files` attribute specifies the [path type](../files/files.md#paths) and path of the [Playlist Files](../files/playlists.md) that the user wants Kometa to act on. **The libraries used in the playlist attribute `libraries` must be defined under the `libraries` attribute of the [Config File](overview.md).** ```yaml playlist_files: - file: config/playlists.yml - - pmm: playlist + - default: playlist ``` ## Example @@ -21,22 +21,22 @@ libraries: Movies: collection_files: - file: config/Movies.yml - - pmm: imdb - - pmm: studio - - pmm: genre - - pmm: actor + - default: imdb + - default: studio + - default: genre + - default: actor operations: mass_critic_rating_update: tmdb split_duplicates: true TV Shows: collection_files: - file: config/TV Shows.yml - - pmm: tmdb - - pmm: network + - default: tmdb + - default: network remove_overlays: false overlay_files: - file: config/Overlays.yml playlist_files: - file: config/playlists.yml - - pmm: playlist + - default: playlist ``` diff --git a/docs/overrides/404.html b/docs/overrides/404.html index eaf051c7..cdbc76e5 100644 --- a/docs/overrides/404.html +++ b/docs/overrides/404.html @@ -4,7 +4,7 @@ <center> <h1>This is not the page you're looking for.</h1> - <img src="https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/master/docs/404.gif" alt="" style="display: block; margin-left: auto; margin-right: auto;"> + <img src="https://raw.githubusercontent.com/Kometa-Team/Kometa/master/docs/404.gif" alt="" style="display: block; margin-left: auto; margin-right: auto;"> </center> {% endblock %} diff --git a/docs/pmm/guides/images/sorts.jpg b/docs/pmm/guides/images/sorts.jpg new file mode 100644 index 00000000..c5862379 Binary files /dev/null and b/docs/pmm/guides/images/sorts.jpg differ diff --git a/docs/pmm/guides/images/sorts_example1.png b/docs/pmm/guides/images/sorts_example1.png new file mode 100644 index 00000000..e47e4f33 Binary files /dev/null and b/docs/pmm/guides/images/sorts_example1.png differ diff --git a/docs/pmm/guides/images/sorts_example2.png b/docs/pmm/guides/images/sorts_example2.png new file mode 100644 index 00000000..3c8f5a66 Binary files /dev/null and b/docs/pmm/guides/images/sorts_example2.png differ diff --git a/docs/pmm/guides/images/sorts_example3.jpg b/docs/pmm/guides/images/sorts_example3.jpg new file mode 100644 index 00000000..2fd4c72f Binary files /dev/null and b/docs/pmm/guides/images/sorts_example3.jpg differ diff --git a/docs/pmm/guides/images/sorts_example4.jpg b/docs/pmm/guides/images/sorts_example4.jpg new file mode 100644 index 00000000..b5651a54 Binary files /dev/null and b/docs/pmm/guides/images/sorts_example4.jpg differ diff --git a/docs/pmm/guides/order.md b/docs/pmm/guides/order.md new file mode 100644 index 00000000..c31d2819 --- /dev/null +++ b/docs/pmm/guides/order.md @@ -0,0 +1,242 @@ +# Sorting Guide + +There are various sort options available depending on what you want to sort. + +## ASCII Sort Order + +The first thing to note is that Kometa utilizes the ASCII sort order, which defines which priority a character gets. + +![](images/sorts.jpg) + +## Collection Sorting + +Collections can be sorted so that they appear in a specific order in the `Collections` and `Library` tab of your library. This is done using the `sort_title` attribute. + +When using the above [ASCII Sort Order](#ascii-sort-order), a collection with a sort title of `!!!My Collection` would appear before a sort title of `!My Collection`, which would be placed before a sort title of `My Collection` + +Let's start with an unmodified set of collections which do **not** specify a custom sort order: + +???+ example "Example 1 - No Sorting" + + ```yaml + collections: + Collection 1: + plex_all: true + Collection 2: + plex_all: true + Collection 3: + plex_all: true + ``` + + ![](images\sorts_example1.png) + + +Now let's use the `sort_title` attribute to reorder these collections slightly + +???+ example "Example 2 - Basic Reorder Sorting" + + ```yaml + collections: + Collection 1: + plex_all: true + sort_title: Collection 3 + Collection 2: + plex_all: true + sort_title: Collection 1 + Collection 3: + plex_all: true + sort_title: Collection 2 + ``` + + ![](images\sorts_example2.png) + + The above could also be achieved using any form of ASCII sort order. This example will produce the same outcome, but uses a (perhaps) illogical set of ASCII characters to define the sort title. + + ```yaml + collections: + Collection 1: + plex_all: true + sort_title: "()*Collection 3" + Collection 2: + plex_all: true + sort_title: "!#$Collection 1" + Collection 3: + plex_all: true + sort_title: "%&'Collection 2" + ``` + +You will often see users using sort titles such as `+++++++_My Collection` or `!010_My Collection` in order to force a specific order of collections. Whilst it may not seem logical at a glance, the ASCII sort order allows a lot of fleixibility for power users to be able to tailor the ordering of collections. + +### Kometa Default Collection Sorting + +When utilizing the [Kometa Defaults](../../defaults/files.md), they are all built on the same format for their sort titles: + +`<<sort_prefix>><<collection_section>><<pre>><<order_<<key>>>><<sort>>` + +Users aren't expected to understand what this does, but users can use the `collection_section` template variable to amend the order of categories of collections. + +???+ example "Example 3 - Reordering Kometa Defaults" + + ```yaml + libraries: + Movies: + collection_files: + - default: tmdb + - default: trakt + template_variables: + collection_section: "!000" #(1)! + ``` + + 1. Because the `!` character is a higher priority ASCII character, that will place ahead of the `000` for the seasonal collections. + + ![](images\sorts_example3.jpg) + +You can also re-order collections within each Defaults file using the `order_<<key>>` template variable. <<key>> refers to the identifier that Kometa uses for each collection, which you can find on the relative default's wiki page. + +???+ example "Example 4 - Reordering Collections within a Kometa Defaults file" + + ```yaml + libraries: + Movies: + collection_files: + - default: trakt + template_variables: + collection_section: "!000" #(1)! + - default: tmdb + template_variables: #(2)! + order_top: 1 + order_popular: 2 + order_airing: 3 + order_air: 4 + order_trending: 5 + ``` + + 1. Because the `!` character is a higher priority ASCII character, that will place ahead of the `000` for the seasonal collections. + 2. file has 5 collections, each with a defined key. I have reordered each of the collections to appear in the order that I specified. + + ![](images\sorts_example4.jpg) + +## Builder Sorting + +When using a collection [Builder](../../files/builders/overview.md), it is possible to sort the items within the collection in a number of ways. + +### Collection Order + +Within Plex, the attribute that controls the top-level sorting is called the `collection_order` and there are three options presented within the Plex UI for this: + +- Alpha (sorted alphabetically) +- Release (sorted by release date, this is the default order if you do not specify one) +- Custom (sorted in a custom order) + +When using Kometa builders, the majority of builders will require `collection_order: custom` to be set, which allows you to sort either by a sort order that the builder source allows for (such as sorting an MDBList by revenue), or by the default order that Kometa receives the items from the builder (such as sorting the IMDb Top 250 in the order that they appear on the list). + +???+ example "Example 5 - Custom Collection Order" + + If I failed to set `collection_order: custom` in this builder, the Collection Order would be the default Plex order, which is release date. + + ```yaml + collections: + IMDb Top 250: + imdb_chart: top_movies + collection_order: custom + ``` + +## Dumb and Smart Collection Sorting + +Plex has two types of collections, "Dumb" and "Smart". + +When using Kometa, a "Dumb" collection is one which is static - the collection will only update when you run Kometa. + +A "Smart" collection is one which is a living/breathing collection, as you add new media or the data about your media changes, the collection will update in real-time to reflect those changes. + +Dumb collections can utilize the `sort_by` attribute to define the sorting. + +???+ example "Example 6 - Dumb Collection Sorting" + + ```yaml + collections: + Top Action Movies: + collection_order: custom + plex_search: + all: + genre: Action + sort_by: audience_rating.desc + limit: 50 + ``` + + to reduce line count, you can replace the `custom` collection order with your desired `sort_by` value. This will still set the collection order to `custom` within Plex, but will reorder the items within the collection as it would if you were using the `sort_by` attribute. + + ```yaml + collections: + Top Action Movies: + collection_order: audience_rating.desc + plex_search: + all: + genre: Action + limit: 50 + ``` + +The Sort Orders available for "Dumb" collections are outlined on the **[Dumb Plex Builder](../../files/builders/plex.md)** page. + +??? tip + + Although the Sort Options are listed on the Dumb Plex Builder page, the options are available to mostly any builder if you use the `collection_order` attribute to define a `sort_by` value + + ```yaml + collections: + IMDb Top 250: + imdb_chart: top_movies + collection_order: audience_rating.desc + ``` + + ```yaml + collections: + Marvel Cinematic Universe: + trakt_list: https://trakt.tv/users/jawann2002/lists/marvel-cinematic-universe-movies?sort=rank,asc + collection_order: added.desc + ``` + +Smart collections can only utilize `sort_by` if it is part of a Smart Filter. + +???+ example "Example 7 - Smart Filter Sorting" + + ```yaml + collections: + Best 2010+ Movies: + smart_filter: + all: + year.gte: 2010 + sort_by: audience_rating.desc + limit: 20 + ``` + +if you have a Smart Label collection, you can pass the `sort_by` value you want as part of the `smart_label` attribute. + +???+ example "Example 8 - Smart Label Sorting" + + ```yaml + collections: + Marvel Cinematic Universe: + trakt_list: https://trakt.tv/users/jawann2002/lists/marvel-cinematic-universe-movies?sort=rank,asc + smart_label: audience_rating.desc + ``` + +The Sort Orders available for "Smart" collections are outlined on the **[Smart Plex Builder](../../files/builders/smart.md)** page. + +??? tip + + Although the Sort Options are listed on the Smart Plex Builder page, the options are available to mostly any builder when you use a smart Label builder. + + ```yaml + collections: + Marvel Cinematic Universe: + trakt_list: https://trakt.tv/users/jawann2002/lists/marvel-cinematic-universe-movies?sort=rank,asc + smart_label: audience_rating.desc + ``` + + ```yaml + collections: + Marvel Cinematic Universe: + trakt_list: https://trakt.tv/users/jawann2002/lists/marvel-cinematic-universe-movies?sort=rank,asc + collection_order: added.desc + ``` \ No newline at end of file diff --git a/docs/pmm/guides/overview.md b/docs/pmm/guides/overview.md deleted file mode 100644 index 90a9f1f7..00000000 --- a/docs/pmm/guides/overview.md +++ /dev/null @@ -1,87 +0,0 @@ -# PMM Explanations, Guides & Recipes - -This page outlines the explanations, guides and recipes that will help you understand certain aspects of PMM that may not be easily understood without expanded context or examples that would be difficult to provide in the standard wiki pages. - -Special credit to [Chazlarson](https://github.com/chazlarson) for the time and effort he has spent developing a lot of these guides. - -## Explanations - -The below guides and recipes have been created to assist users with various aspects of Plex Meta Managers and its companion scripts. - -- [Plex Ratings Explained](ratings.md) -- [Scheduling PMM Runs Guide](scheduling.md) -- [Image Asset Directory Guide](assets.md) -- [Log Files](../logs.md) -- [Understanding YAML File Syntax](../yaml.md) -- [Formula 1 Metadata Edit Guide](formula.md) - -## Guides - -A lot of these guides are stored on Google Drive as using the traditional wiki pages would make the formatting difficult to understand. - -{% - include-markdown "https://raw.githubusercontent.com/chazlarson/Plex-Meta-Manager-Cookbook/main/guides/README.md" -%} - -## Recipes - -A lot of these guides are stored on Google Drive as using the traditional wiki pages would make the formatting difficult to understand. - -{% - include-markdown "https://raw.githubusercontent.com/chazlarson/Plex-Meta-Manager-Cookbook/main/cookbook/README.md" -%} - -## Associated Git Repos - -- [Plex Meta Manager User Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs) - - PMM's User submitted Config Repo - -<br> - -- [Plex Image Cleanup](https://github.com/meisnate12/Plex-Image-Cleanup) - - Removes Image bloat from your Plex -- [PMM Overlay Reset](https://github.com/meisnate12/PMM-Overlay-Reset) - - Resets your Library back to default images removing all overlays -- [Plex Meta Manager Anime IDs](https://github.com/meisnate12/Plex-Meta-Manager-Anime-IDs) - - How PMM translates Anime IDs to TVDB IDs -- [PMM IMDb Awards](https://github.com/meisnate12/PMM-IMDb-Awards) - - How PMM stores the IMDB Award Lists -- [PMM Mediastingers](https://github.com/meisnate12/PMM-Mediastingers) - - How PMM stores the Mediastingers List - -<br> - -- [ArrAPI](https://github.com/meisnate12/ArrAPI) - - Module to interface with Radarr/Sonarr -- [TMDbAPIs](https://github.com/meisnate12/TMDbAPIs) - - Module to interface with TMDb -- [pmmutils](https://github.com/meisnate12/pmmutils) - - Module for various common files among PMM Repos - -<br> - -- [Plex-Meta-Manager-Images](https://github.com/meisnate12/Plex-Meta-Manager-Images) - - Repo to store PMM's various Images -- [Plex-Meta-Manager-People](https://github.com/meisnate12/Plex-Meta-Manager-People) - - Stores the original image for all our actor posters -- [Plex-Meta-Manager-People-Auto-Readme](https://github.com/meisnate12/Plex-Meta-Manager-People-Auto-Readme) - - Stores the File that generates the Readme file for the other Actor repos -- [Black & White (bw)](https://github.com/meisnate12/Plex-Meta-Manager-People-bw) - - Stores the Black & White actor posters -- [Rainier (rainier)](https://github.com/meisnate12/Plex-Meta-Manager-People-rainier) - - Stores the Rainier actor posters -- [Signature (signature)](https://github.com/meisnate12/Plex-Meta-Manager-People-signature) - - Stores the Signature actor posters -- [DIIVOY (diiivoy)](https://github.com/meisnate12/Plex-Meta-Manager-People-diiivoy) - - Stores the DIIVOY actor posters -- [DIIVOY Color (diiivoycolor)](https://github.com/meisnate12/Plex-Meta-Manager-People-diiivoycolor) - - Stores the DIIVOY Color actor posters -- [Transparent (transparent)](https://github.com/meisnate12/Plex-Meta-Manager-People-transparent) - - Stores the Transparent actor posters - -<br> - -- [Plex-Meta-Manager-Unraid-Templates](https://github.com/meisnate12/Plex-Meta-Manager-Unraid-Templates) - - Stores the PMM Unraid Templates -- [PMM-Translations ](https://github.com/meisnate12/PMM-Translations) - - Stores the data for PMM Translations \ No newline at end of file diff --git a/docs/pmm/install/wt/wt-10-scheduling.md b/docs/pmm/install/wt/wt-10-scheduling.md deleted file mode 100644 index 2df776f2..00000000 --- a/docs/pmm/install/wt/wt-10-scheduling.md +++ /dev/null @@ -1,15 +0,0 @@ -The commands you've been using in this walkthrough run Plex-Meta-Manager immediately then quit. - -Plex Meta Manager also features multiple layers of scheduling, which you can leverage to control when various activities take place. - - - You can run PMM in the background, telling it to wake up and process your libraries at fixed times during the day. The default behavior in this regard is to wake up at 5AM and process the config. If you leave the `-r` off the commands you have been using in this walkthrough, that's what will happen. - - You can control when PMM wakes up with the [time-to-run](../../environmental.md) env-var/runtime flag. - - - You can skip using that internal schedule and just do manual runs as you have been doing throughout this walkthrough using standard tools available in your OS. - - Details on setting this up are found [here](../../guides/scheduling.md). - - - In addition, individual items *within* the configuration can be scheduled to take place at certain times *provided PMM is running at that time*. For example, you can tell PMM only to apply overlays on Tuesdays or the like. You can then schedule manual runs every day at noon and overlays will only get processed when it runs on Tuesday. This sort of schedule *will not* make PMM start up if it is not already running. If you don't arrange for PMM to be run on Tuesday, your overlays would never be processed in this example. - - Details on this level of scheduling are found [here](../../../config/schedule.md) diff --git a/docs/pmm/install/wt/wt-run-docker.md b/docs/pmm/install/wt/wt-run-docker.md deleted file mode 100644 index 688882fb..00000000 --- a/docs/pmm/install/wt/wt-run-docker.md +++ /dev/null @@ -1,5 +0,0 @@ -[type this into your terminal] - -``` -docker run --rm -it -v "PMM_PATH_GOES_HERE:/config:rw" meisnate12/plex-meta-manager --run -``` diff --git a/docs/pmm/scripts/image-cleanup.md b/docs/pmm/scripts/image-cleanup.md deleted file mode 100644 index 5940e618..00000000 --- a/docs/pmm/scripts/image-cleanup.md +++ /dev/null @@ -1,13 +0,0 @@ -{% - include-markdown "https://raw.githubusercontent.com/meisnate12/Plex-Image-Cleanup/develop/README.md" - rewrite-relative-urls=true - comments=false - end="![](cleanup.png)" -%} -![](images/cleanup.png) -{% - include-markdown "https://raw.githubusercontent.com/meisnate12/Plex-Image-Cleanup/develop/README.md" - rewrite-relative-urls=true - comments=false - start="![](cleanup.png)" -%} \ No newline at end of file diff --git a/docs/pmm/scripts/overlay-reset.md b/docs/pmm/scripts/overlay-reset.md deleted file mode 100644 index 352b3748..00000000 --- a/docs/pmm/scripts/overlay-reset.md +++ /dev/null @@ -1,5 +0,0 @@ -{% - include-markdown "https://raw.githubusercontent.com/meisnate12/PMM-Overlay-Reset/develop/README.md" - rewrite-relative-urls=true - comments=false -%} \ No newline at end of file diff --git a/docs/pmm/scripts/overview.md b/docs/pmm/scripts/overview.md deleted file mode 100644 index b00b86d7..00000000 --- a/docs/pmm/scripts/overview.md +++ /dev/null @@ -1,8 +0,0 @@ -# Companion Scripts - -Each Companion Script is a separate project that has its own Docker container and GitHub Repository. - -| Name | Description | Readme | -|:---------------------|:------------------------------------------------------|:--------------------------------------------------------------------------------------| -| `PMM Overlay Reset` | Script to completely remove all PMM applied Overlays. | [Wiki](overlay-reset.md)/[GitHub](https://github.com/meisnate12/PMM-overlay-reset.md) | -| `Plex Image Cleanup` | Script to clean up Plex's Image Cache. | [Wiki](image-cleanup.md)/[GitHub](https://github.com/meisnate12/Plex-Image-Cleanup) | diff --git a/docs/showcase/overlays.md b/docs/showcase/overlays.md index 40bf0e6a..6fd5a1a4 100644 --- a/docs/showcase/overlays.md +++ b/docs/showcase/overlays.md @@ -1,8 +1,8 @@ # Overlays Showcase -This page is designed to show the art of the possible when using Overlays within Plex Meta Manager. +This page is designed to show the art of the possible when using Overlays within Kometa. -Each showcased photo has been confirmed to be fully functional with Plex Meta Manager v1.19.0. We cannot guarantee functionality beyond that version. +Each showcased photo has been confirmed to be fully functional with Kometa v1.19.0. We cannot guarantee functionality beyond that version. ## Example 1 @@ -12,7 +12,7 @@ Each showcased photo has been confirmed to be fully functional with Plex Meta Ma This example shows a minimalistic Overlay application with the resolution, audio codec and video format on display. - This example uses three PMM Default Overlay files: [Resolution](../defaults/overlays/resolution.md), [Audio Codec](../defaults/overlays/audio_codec.md) and [Video Format](../defaults/overlays/video_format.md). + This example uses three Kometa Default Overlay files: [Resolution](../defaults/overlays/resolution.md), [Audio Codec](../defaults/overlays/audio_codec.md) and [Video Format](../defaults/overlays/video_format.md). Resolution is used to identify if the movie is 4K for example, and also highlights if a movie is Dolby Vision or HDR. @@ -30,9 +30,9 @@ Each showcased photo has been confirmed to be fully functional with Plex Meta Ma libraries: Movies: overlay_files: - - pmm: resolution - - pmm: audio_codec - - pmm: video_format + - default: resolution + - default: audio_codec + - default: video_format ``` **Replace `Movies` with the name of your library** @@ -45,11 +45,11 @@ Each showcased photo has been confirmed to be fully functional with Plex Meta Ma This example shows a minimalistic Overlay application with the ratings and ribbon of the movie. - This example uses two PMM Default Overlay files: [Ratings](../defaults/overlays/ratings.md) and [Ribbon](../defaults/overlays/ribbon.md). + This example uses two Kometa Default Overlay files: [Ratings](../defaults/overlays/ratings.md) and [Ribbon](../defaults/overlays/ribbon.md). Ratings are set to show the Rotten Tomatoes Audience & Critic scores, as well as the IMDb score. - Custom fonts have been used for the ratings which can be sourced in [bullmoose20's repository](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/bullmoose20) within `fonts.zip` + Custom fonts have been used for the ratings which can be sourced in [bullmoose20's repository](https://github.com/Kometa-Team/Community-Configs/tree/master/bullmoose20) within `fonts.zip` A [Library Operation](../config/operations.md#mass--rating-update) is used to place the IMDb rating into the user rating slot, as can be seen in the code example. @@ -63,7 +63,7 @@ Each showcased photo has been confirmed to be fully functional with Plex Meta Ma libraries: Movies: overlay_files: - - pmm: ratings + - default: ratings template_variables: rating1: critic rating1_image: rt_tomato @@ -85,7 +85,7 @@ Each showcased photo has been confirmed to be fully functional with Plex Meta Ma rating1_horizontal_offset: 30 rating2_horizontal_offset: 250 rating3_horizontal_offset: 470 - - pmm: ribbon + - default: ribbon operations: mass_user_rating_update: imdb ``` @@ -101,7 +101,7 @@ Each showcased photo has been confirmed to be fully functional with Plex Meta Ma This example shows a minimalistic Overlay application with the ratings applied at the bottom of the poster - This example uses two PMM Default Overlay files: [Ratings](../defaults/overlays/ratings.md) and [Runtimes](../defaults/overlays/runtimes.md). + This example uses two Kometa Default Overlay files: [Ratings](../defaults/overlays/ratings.md) and [Runtimes](../defaults/overlays/runtimes.md). Ratings are set to show the TMDb, Trakt and IMDb ratings, which have been set using [Library Operations](../config/operations.md#mass--rating-update) @@ -117,7 +117,7 @@ Each showcased photo has been confirmed to be fully functional with Plex Meta Ma libraries: Movies: overlay_files: - - pmm: runtimes + - default: runtimes template_variables: text: "" horizontal_position: center @@ -128,7 +128,7 @@ Each showcased photo has been confirmed to be fully functional with Plex Meta Ma back_color: "#000000" horizontal_offset: 0 vertical_offset: 0 - - pmm: ratings + - default: ratings template_variables: rating1: critic rating1_image: tmdb diff --git a/docs/stylesheets/branch.js b/docs/stylesheets/branch.js index e0458f7f..21469c00 100644 --- a/docs/stylesheets/branch.js +++ b/docs/stylesheets/branch.js @@ -22,9 +22,9 @@ function checkURLForBranch() { // Change theme based on URL segment if (currentURL.includes("en/nightly")) { - updateTheme("#262dbd", "#262dbd", "PMM Nightly Wiki"); + updateTheme("#262dbd", "#262dbd", "Kometa Nightly Wiki"); } else if (currentURL.includes("en/develop")) { - updateTheme("#ffa724", "#ffa724", "PMM Develop Wiki"); + updateTheme("#ffa724", "#ffa724", "Kometa Develop Wiki"); } } diff --git a/docs/stylesheets/custom.css b/docs/stylesheets/custom.css index 9d46cdfa..ce25ae0e 100644 --- a/docs/stylesheets/custom.css +++ b/docs/stylesheets/custom.css @@ -143,4 +143,9 @@ code { .illustration { margin-top: 2em; margin-bottom: 2em; +} + +.md-typeset img[alt="Logo"] { + height: auto; + max-width: 45%; } \ No newline at end of file diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 8c72e4e3..d5abf082 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -2,9 +2,13 @@ --md-primary-fg-color: #00bc8c; --md-primary-fg-color--light: #00bc8c; --md-primary-fg-color--dark: #00bc8c; - --md-primary-bg-color--light: rgba(0,0,0,.54); + --md-primary-bg-color--light: #ffffffb3; --pg-light-border: rgb(47, 47, 47); - + --md-typeset-a-color: #00bc8c; + --md-accent-fg-color: #1281c0; + --md-code-hl-keyword-color: #7ee787; + --md-code-hl-string-color: #a5d6ff; + --md-code-hl-comment-color: #8b949e; } :root, [data-md-color-scheme="slate"] { --md-primary-fg-color: #00bc8c; @@ -12,16 +16,24 @@ --md-primary-fg-color--dark: #00bc8c; --md-default-bg-color: #252525; --md-footer-bg-color--dark: var(--md-default-bg-color); + --md-primary-bg-color--light: #ffffffb3; --pg-light-border: rgb(47, 47, 47); -} -strong { - color: #00bc8c; + --md-typeset-a-color: #00bc8c; + --md-accent-fg-color: #1281c0; + --md-code-hl-keyword-color: #7ee787; + --md-code-hl-string-color: #a5d6ff; + --md-code-hl-comment-color: #8b949e; } table tr td code { white-space: pre; } +.md-header, .md-tabs { + background-image: url(../assets/background.jpg); + background-size: cover; +} + .md-banner { background-color: #252525; color: var(--md-footer-fg-color); @@ -45,28 +57,32 @@ table tr td code { padding: 1px; } +[data-md-color-scheme="default"] .md-typeset h1, [data-md-color-scheme="slate"] .md-typeset h2, [data-md-color-scheme="slate"] .md-typeset h3, [data-md-color-scheme="slate"] .md-typeset h4 { + color: #2f2f2f; +} + +[data-md-color-scheme="slate"] .md-typeset h1, [data-md-color-scheme="slate"] .md-typeset h2, [data-md-color-scheme="slate"] .md-typeset h3, [data-md-color-scheme="slate"] .md-typeset h4 { + color: #f0f0f0; +} + .md-typeset h1, .md-typeset h2 { font-weight: bold; - color: #0e8a6a; text-transform: uppercase; } .md-typeset h2 { font-weight: bold; - color: #0e8a6a; text-transform: uppercase; } .md-typeset h3 { font-weight: bold; - color: #0e8a6a; text-transform: uppercase; } .md-typeset h4 { font-weight: bold; - color: #0e8a6a; text-transform: uppercase; } @@ -194,12 +210,17 @@ table.dualTable td, table.dualTable th { } .md-typeset mark { - background-color: #ac0ce3; + background-color: initial; -webkit-box-decoration-break: clone; box-decoration-break: clone; - color: #ffffff; + color: #00bc8c; word-break: break-word; } + +.md-search-result .md-typeset h2 mark { + text-decoration: underline; +} + :root { --md-admonition-icon--blank: url() } @@ -271,6 +292,45 @@ table.dualTable td, table.dualTable th { position: relative; } +[data-md-color-scheme="default"] .md-typeset .grid.cards > :is(ul, ol) > li, .md-typeset .grid > .card { /* Firefox */ + color: var(--md-typeset-color); + background: #f6f6f6; + border: 1px solid var(--pg-light-border); + border-radius: 6px; + box-shadow: rgba(0, 0, 0, 0) 0px 0px 0px 0px, rgba(0, 0, 0, 0) 0px 0px 0px 0px, rgba(0, 0, 0, 0.05) 0px 1px 3px 0px, rgba(0, 0, 0, 0.05) 0px 1px 2px -1px; + transition: none; + position: relative; +} + +[data-md-color-scheme="default"] .md-typeset .grid.cards>:-webkit-any(ul,ol)>li, .md-typeset .grid>.card { /* Webkit */ + color: var(--md-typeset-color); + background: #f6f6f6; + border: 1px solid var(--pg-light-border); + border-radius: 6px; + box-shadow: rgba(0, 0, 0, 0) 0px 0px 0px 0px, rgba(0, 0, 0, 0) 0px 0px 0px 0px, rgba(0, 0, 0, 0.05) 0px 1px 3px 0px, rgba(0, 0, 0, 0.05) 0px 1px 2px -1px; + transition: none; + position: relative; +} + +[data-md-color-scheme="slate"] .md-typeset .grid.cards > :is(ul, ol) > li, .md-typeset .grid > .card { /* Firefox */ + color: var(--md-typeset-color); + background: #1b1b1b; + border: 1px solid var(--pg-light-border); + border-radius: 6px; + box-shadow: rgba(0, 0, 0, 0) 0px 0px 0px 0px, rgba(0, 0, 0, 0) 0px 0px 0px 0px, rgba(0, 0, 0, 0.05) 0px 1px 3px 0px, rgba(0, 0, 0, 0.05) 0px 1px 2px -1px; + transition: none; + position: relative; +} + +[data-md-color-scheme="slate"] .md-typeset .grid.cards>:-webkit-any(ul,ol)>li, .md-typeset .grid>.card { /* Webkit */ + color: var(--md-typeset-color); + background: #1b1b1b; + border: 1px solid var(--pg-light-border); + border-radius: 6px; + box-shadow: rgba(0, 0, 0, 0) 0px 0px 0px 0px, rgba(0, 0, 0, 0) 0px 0px 0px 0px, rgba(0, 0, 0, 0.05) 0px 1px 3px 0px, rgba(0, 0, 0, 0.05) 0px 1px 2px -1px; + transition: none; + position: relative; +} .md-typeset .grid.cards > :is(ul, ol) > li:is(:focus-within, :hover), .md-typeset .grid > .card:is(:focus-within, :hover) { /* Firefox */ box-shadow: rgba(0, 0, 0, 0) 0px 0px 0px 0px, rgba(0, 0, 0, 0) 0px 0px 0px 0px, rgba(0, 0, 0, 0.05) 0px 1px 3px 0px, rgba(0, 0, 0, 0.05) 0px 1px 2px -1px; border-color: var(--md-accent-fg-color); diff --git a/json-schema/README.md b/json-schema/README.md index d296d62c..eca32915 100644 --- a/json-schema/README.md +++ b/json-schema/README.md @@ -1,4 +1,4 @@ -JSON schemas for PMM YAML files +JSON schemas for Kometa YAML files limitations: diff --git a/json-schema/config-schema.json b/json-schema/config-schema.json index 912beb92..768627f0 100644 --- a/json-schema/config-schema.json +++ b/json-schema/config-schema.json @@ -938,11 +938,11 @@ ], "title": "trakt" }, - "pmm-collection-path": { + "lib-collection-path": { "type": "object", "additionalProperties": false, "properties": { - "pmm": { + "default": { "type": "string", "enum": ["actor", "anilist","aspect","audio_language","bafta","based","basic","berlinale","cannes","cesar","choice","collectionless","content_rating_au","content_rating_cs","content_rating_de","content_rating_nz","content_rating_mal","content_rating_uk","content_rating_us","continent","country","decade","director","emmy","flixpatrol","franchise","genre","golden","imdb","myanimelist","network","nfr","oscars","other_chart","pca","producer","razzie","region","resolution","sag","seasonal","separator_award","separator_chart","spirit","streaming","studio","subtitle_language","sundance","tautulli","tiff","tmdb","trakt","universe","venice","writer","year"] }, @@ -960,14 +960,14 @@ } }, "required": [ - "pmm" + "default" ] }, - "pmm-overlay-path": { + "lib-overlay-path": { "type": "object", "additionalProperties": false, "properties": { - "pmm": { + "default": { "type": "string", "enum": ["aspect","audio_codec","commonsense","content_rating_au","content_rating_de","content_rating_nz","content_rating_uk","content_rating_us_movie","content_rating_us_show","direct_play","episode_info","language_count","flixpatrol","languages","mediastinger","network","ratings","resolution","ribbon","runtimes","status","streaming","studio","versions","video_format"] }, @@ -1000,11 +1000,11 @@ "required": [ ] }, - "pmm-playlist-path": { + "lib-playlist-path": { "type": "object", "additionalProperties": false, "properties": { - "pmm": { + "default": { "type": "string", "enum": ["playlist"] }, @@ -1022,7 +1022,7 @@ } }, "required": [ - "pmm" + "default" ] }, "file-path": { @@ -1243,7 +1243,7 @@ "items": { "anyOf": [ { - "$ref": "#/definitions/pmm-collection-path" + "$ref": "#/definitions/lib-collection-path" }, { "$ref": "#/definitions/file-path" }, { @@ -1265,7 +1265,7 @@ "items": { "anyOf": [ { - "$ref": "#/definitions/pmm-overlay-path" + "$ref": "#/definitions/lib-overlay-path" }, { "$ref": "#/definitions/file-path" }, { @@ -1287,7 +1287,7 @@ "items": { "anyOf": [ { - "$ref": "#/definitions/pmm-collection-path" + "$ref": "#/definitions/lib-collection-path" }, { "$ref": "#/definitions/file-path" }, { @@ -1310,7 +1310,7 @@ "items": { "anyOf": [ { - "$ref": "#/definitions/pmm-overlay-path" + "$ref": "#/definitions/lib-overlay-path" }, { "$ref": "#/definitions/file-path" }, { @@ -1332,7 +1332,7 @@ "items": { "anyOf": [ { - "$ref": "#/definitions/pmm-playlist-path" + "$ref": "#/definitions/lib-playlist-path" }, { "$ref": "#/definitions/file-path" }, { diff --git a/json-schema/prototype_config.yml b/json-schema/prototype_config.yml index 695d8f6c..c912eb69 100644 --- a/json-schema/prototype_config.yml +++ b/json-schema/prototype_config.yml @@ -17,78 +17,77 @@ libraries: - 6780 ignore_imdb_ids: tt1234, tt5678, tt7890 - metadata_path: + collection_files: - file: some/path/to/a/file.yml - folder: some/path/to/a/folder/ - url: https://foo.bar.com/something.yml - git: bing/bang/boing - repo: bing - - pmm: cannes - - pmm: choice - - pmm: emmy - - pmm: spirit - - pmm: sundance - - pmm: other_award - - pmm: tautulli - - pmm: imdb - - pmm: trakt - - pmm: anilist - - pmm: myanimelist - - pmm: other_chart - - pmm: genre - - pmm: franchise - - pmm: based - - pmm: content_rating_us - - pmm: content_rating_uk - - pmm: content_rating_mal - - pmm: content_rating_cs - - pmm: country - - pmm: region - - pmm: continent - - pmm: aspect - - pmm: subtitle_language - - pmm: actor - - pmm: director - - pmm: producer - - pmm: writer - - pmm: year - - pmm: decade - - pmm: collectionless - - pmm: separator_award # An "index card" - - pmm: bafta # BAFTA Awards + - default: cannes + - default: choice + - default: emmy + - default: spirit + - default: sundance + - default: tautulli + - default: imdb + - default: trakt + - default: anilist + - default: myanimelist + - default: other_chart + - default: genre + - default: franchise + - default: based + - default: content_rating_us + - default: content_rating_uk + - default: content_rating_mal + - default: content_rating_cs + - default: country + - default: region + - default: continent + - default: aspect + - default: subtitle_language + - default: actor + - default: director + - default: producer + - default: writer + - default: year + - default: decade + - default: collectionless + - default: separator_award # An "index card" + - default: bafta # BAFTA Awards template_variables: # Show collections from current_year-10 onwards. horizontal_offset: 99 data: starting: current_year-10 ending: current_year - - pmm: golden # Golden Globes Awards + - default: golden # Golden Globes Awards # template_variables: # Show collections from current_year-10 onwards. # data: # starting: current_year-10 # ending: current_year - - pmm: oscars # The Oscars + - default: oscars # The Oscars # template_variables: # Show collections from current_year-10 onwards. # data: # starting: current_year-10 # ending: current_year - - pmm: separator_chart # An "index card" - - pmm: basic # Some basic chart collections - - pmm: tmdb # TMDb Charts (Popular, Trending, etc.) - - pmm: audio_language # English, French, Arabic, German, etc. audio language - - pmm: resolution # 4K HDR, 1080P FHD, etc. with the standards style + - default: separator_chart # An "index card" + - default: basic # Some basic chart collections + - default: tmdb # TMDb Charts (Popular, Trending, etc.) + - default: audio_language # English, French, Arabic, German, etc. audio language + - default: resolution # 4K HDR, 1080P FHD, etc. with the standards style # template_variables: # style: standards - - pmm: studio # DreamWorks Studios, Lucasfilm Ltd, etc. - - pmm: seasonal # Christmas, Halloween, etc. + - default: studio # DreamWorks Studios, Lucasfilm Ltd, etc. + - default: seasonal # Christmas, Halloween, etc. template_variables: # Disable any US-specific seasonal collections schedule_independence: never schedule_thanksgiving: never schedule_memorial: never schedule_labor: never - - pmm: streaming # Streaming on Disney+, Netflix, etc. + - default: streaming # Streaming on Disney+, Netflix, etc. # template_variables: # originals_only: true # Only create collections for Original Content (i.e. Netflix Originals) - - pmm: universe # Marvel Cinematic Universe, Wizarding World, etc. + - default: universe # Marvel Cinematic Universe, Wizarding World, etc. overlay_path: - remove_overlays: false # Set to true if you want to remove overlays - reapply_overlays: false # If you are doing a lot of testing and changes like me, keep this to true to always reapply overlays - can cause image bloat @@ -98,23 +97,23 @@ libraries: - url: https://foo.bar.com/something.yml - git: bing/bang/boing - repo: bing - - pmm: episode_info - - pmm: mediastinger - - pmm: ratings - - pmm: status - - pmm: aspect - - pmm: language_count - - pmm: languages - - pmm: runtimes - - pmm: versions - - pmm: network - - pmm: studio - - pmm: direct_play - - pmm: audio_codec # FLAC, DTS-X, TrueHD, etc. style: standard/compact. compact is default - - pmm: resolution # 4K HDR, 1080P FHD, etc. - - pmm: ribbon # Used for ribbon in bottom right - - pmm: streaming # Streaming on Disney+, Netflix, etc. - - pmm: video_format # Remux, DVD, Blu-Ray, etc. in bottom left + - default: episode_info + - default: mediastinger + - default: ratings + - default: status + - default: aspect + - default: language_count + - default: languages + - default: runtimes + - default: versions + - default: network + - default: studio + - default: direct_play + - default: audio_codec # FLAC, DTS-X, TrueHD, etc. style: standard/compact. compact is default + - default: resolution # 4K HDR, 1080P FHD, etc. + - default: ribbon # Used for ribbon in bottom right + - default: streaming # Streaming on Disney+, Netflix, etc. + - default: video_format # Remux, DVD, Blu-Ray, etc. in bottom left settings: asset_directory: config/assets @@ -164,72 +163,71 @@ libraries: - url: https://foo.bar.com/something.yml - git: bing/bang/boing - repo: bing - - pmm: cannes - - pmm: choice - - pmm: emmy - - pmm: spirit - - pmm: sundance - - pmm: other_award - - pmm: tautulli - - pmm: imdb - - pmm: trakt - - pmm: anilist - - pmm: myanimelist - - pmm: other_chart - - pmm: genre - - pmm: franchise - - pmm: based - - pmm: content_rating_us - - pmm: content_rating_uk - - pmm: content_rating_mal - - pmm: content_rating_cs - - pmm: country - - pmm: region - - pmm: continent - - pmm: aspect - - pmm: subtitle_language - - pmm: actor - - pmm: director - - pmm: producer - - pmm: writer - - pmm: year - - pmm: decade - - pmm: collectionless - - pmm: separator_award # An "index card" - - pmm: bafta # BAFTA Awards + - default: cannes + - default: choice + - default: emmy + - default: spirit + - default: sundance + - default: tautulli + - default: imdb + - default: trakt + - default: anilist + - default: myanimelist + - default: other_chart + - default: genre + - default: franchise + - default: based + - default: content_rating_us + - default: content_rating_uk + - default: content_rating_mal + - default: content_rating_cs + - default: country + - default: region + - default: continent + - default: aspect + - default: subtitle_language + - default: actor + - default: director + - default: producer + - default: writer + - default: year + - default: decade + - default: collectionless + - default: separator_award # An "index card" + - default: bafta # BAFTA Awards template_variables: # Show collections from current_year-10 onwards. horizontal_offset: 99 data: starting: current_year-10 ending: current_year - - pmm: golden # Golden Globes Awards + - default: golden # Golden Globes Awards # template_variables: # Show collections from current_year-10 onwards. # data: # starting: current_year-10 # ending: current_year - - pmm: oscars # The Oscars + - default: oscars # The Oscars # template_variables: # Show collections from current_year-10 onwards. # data: # starting: current_year-10 # ending: current_year - - pmm: separator_chart # An "index card" - - pmm: basic # Some basic chart collections - - pmm: tmdb # TMDb Charts (Popular, Trending, etc.) - - pmm: audio_language # English, French, Arabic, German, etc. audio language - - pmm: resolution # 4K HDR, 1080P FHD, etc. with the standards style + - default: separator_chart # An "index card" + - default: basic # Some basic chart collections + - default: tmdb # TMDb Charts (Popular, Trending, etc.) + - default: audio_language # English, French, Arabic, German, etc. audio language + - default: resolution # 4K HDR, 1080P FHD, etc. with the standards style # template_variables: # style: standards - - pmm: studio # DreamWorks Studios, Lucasfilm Ltd, etc. - - pmm: seasonal # Christmas, Halloween, etc. + - default: studio # DreamWorks Studios, Lucasfilm Ltd, etc. + - default: seasonal # Christmas, Halloween, etc. template_variables: # Disable any US-specific seasonal collections schedule_independence: never schedule_thanksgiving: never schedule_memorial: never schedule_labor: never - - pmm: streaming # Streaming on Disney+, Netflix, etc. + - default: streaming # Streaming on Disney+, Netflix, etc. # template_variables: # originals_only: true # Only create collections for Original Content (i.e. Netflix Originals) - - pmm: universe # Marvel Cinematic Universe, Wizarding World, etc. + - default: universe # Marvel Cinematic Universe, Wizarding World, etc. metadata_files: - file: some/path/to/a/file.yml @@ -245,23 +243,23 @@ libraries: - url: https://foo.bar.com/something.yml - git: bing/bang/boing - repo: bing - - pmm: episode_info - - pmm: mediastinger - - pmm: ratings - - pmm: status - - pmm: aspect - - pmm: language_count - - pmm: languages - - pmm: runtimes - - pmm: versions - - pmm: network - - pmm: studio - - pmm: direct_play - - pmm: audio_codec # FLAC, DTS-X, TrueHD, etc. style: standard/compact. compact is default - - pmm: resolution # 4K HDR, 1080P FHD, etc. - - pmm: ribbon # Used for ribbon in bottom right - - pmm: streaming # Streaming on Disney+, Netflix, etc. - - pmm: video_format # Remux, DVD, Blu-Ray, etc. in bottom left + - default: episode_info + - default: mediastinger + - default: ratings + - default: status + - default: aspect + - default: language_count + - default: languages + - default: runtimes + - default: versions + - default: network + - default: studio + - default: direct_play + - default: audio_codec # FLAC, DTS-X, TrueHD, etc. style: standard/compact. compact is default + - default: resolution # 4K HDR, 1080P FHD, etc. + - default: ribbon # Used for ribbon in bottom right + - default: streaming # Streaming on Disney+, Netflix, etc. + - default: video_format # Remux, DVD, Blu-Ray, etc. in bottom left settings: asset_directory: config/assets @@ -275,101 +273,100 @@ libraries: # sep_style: plum # use the plum separators globally for this library # collection_mode: hide # hide the collections within the "library" tab in Plex. # placeholder_imdb_id: tt1190634 # The Boys (2019) placeholder id for the separators, avoids a plex bug. - metadata_path: - - pmm: cannes - - pmm: choice - - pmm: emmy - - pmm: spirit - - pmm: sundance - - pmm: other_award - - pmm: tautulli - - pmm: imdb - - pmm: trakt - - pmm: anilist - - pmm: myanimelist - - pmm: other_chart - - pmm: genre - - pmm: franchise - - pmm: based - - pmm: content_rating_us - - pmm: content_rating_uk - - pmm: content_rating_mal - - pmm: content_rating_cs - - pmm: country - - pmm: region - - pmm: continent - - pmm: aspect - - pmm: subtitle_language - - pmm: actor - - pmm: director - - pmm: producer - - pmm: writer - - pmm: year - - pmm: decade - - pmm: collectionless - - pmm: separator_award # An "index card" - - pmm: bafta # BAFTA Awards + collection_files: + - default: cannes + - default: choice + - default: emmy + - default: spirit + - default: sundance + - default: tautulli + - default: imdb + - default: trakt + - default: anilist + - default: myanimelist + - default: other_chart + - default: genre + - default: franchise + - default: based + - default: content_rating_us + - default: content_rating_uk + - default: content_rating_mal + - default: content_rating_cs + - default: country + - default: region + - default: continent + - default: aspect + - default: subtitle_language + - default: actor + - default: director + - default: producer + - default: writer + - default: year + - default: decade + - default: collectionless + - default: separator_award # An "index card" + - default: bafta # BAFTA Awards # template_variables: # Show collections from current_year-10 onwards. # data: # starting: current_year-10 # ending: current_year - - pmm: golden # Golden Globes Awards + - default: golden # Golden Globes Awards # template_variables: # Show collections from current_year-10 onwards. # data: # starting: current_year-10 # ending: current_year - - pmm: oscars # The Oscars + - default: oscars # The Oscars # template_variables: # Show collections from current_year-10 onwards. # data: # starting: current_year-10 # ending: current_year - - pmm: separator_chart # An "index card" - - pmm: basic # Some basic chart collections - - pmm: tmdb # TMDb Charts (Popular, Trending, etc.) - - pmm: audio_language # English, French, Arabic, German, etc. audio language - - pmm: resolution # 4K HDR, 1080P FHD, etc. with the standards style + - default: separator_chart # An "index card" + - default: basic # Some basic chart collections + - default: tmdb # TMDb Charts (Popular, Trending, etc.) + - default: audio_language # English, French, Arabic, German, etc. audio language + - default: resolution # 4K HDR, 1080P FHD, etc. with the standards style # template_variables: # style: standards - - pmm: network # ABC, CBC, NBC, FOX, etc. - - pmm: streaming # Streaming on Disney+, Netflix, etc. + - default: network # ABC, CBC, NBC, FOX, etc. + - default: streaming # Streaming on Disney+, Netflix, etc. # template_variables: # originals_only: true # Only create collections for Original Content (i.e. Netflix Originals) overlay_path: - remove_overlays: false # Set to true if you want to remove overlays # - reapply_overlay: false # If you are doing a lot of testing and changes like me, keep this to true to always reapply overlays - can cause image bloat # - reset_overlays: tmdb # if you want to reset the poster to default poster from tmdb - can cause image bloat - - pmm: mediastinger - - pmm: ratings - - pmm: status - - pmm: aspect - - pmm: language_count - - pmm: languages - - pmm: runtimes - - pmm: network - - pmm: studio - - pmm: direct_play - - pmm: audio_codec # FLAC, DTS-X, TrueHD, etc. on show and episode - - pmm: audio_codec + - default: mediastinger + - default: ratings + - default: status + - default: aspect + - default: language_count + - default: languages + - default: runtimes + - default: network + - default: studio + - default: direct_play + - default: audio_codec # FLAC, DTS-X, TrueHD, etc. on show and episode + - default: audio_codec # template_variables: # overlay_level: episode - - pmm: episode_info # S##E## information in bottom right on episode + - default: episode_info # S##E## information in bottom right on episode # template_variables: # overlay_level: episode - - pmm: resolution # 4K HDR, 1080P FHD, etc. on show, episode, and season - - pmm: resolution + - default: resolution # 4K HDR, 1080P FHD, etc. on show, episode, and season + - default: resolution # template_variables: # overlay_level: episode - - pmm: resolution + - default: resolution # template_variables: # overlay_level: season - - pmm: ribbon # Used for ribbon in bottom right on show - - pmm: status # Airing, Returning, Ended, Canceled on show - - pmm: versions # Will show duplicates for that media item on show and episode - - pmm: versions + - default: ribbon # Used for ribbon in bottom right on show + - default: status # Airing, Returning, Ended, Canceled on show + - default: versions # Will show duplicates for that media item on show and episode + - default: versions # template_variables: # overlay_level: episode - - pmm: video_format # Remux, DVD, Blu-Ray, etc. in bottom left on show, episode, and season - - pmm: video_format + - default: video_format # Remux, DVD, Blu-Ray, etc. in bottom left on show, episode, and season + - default: video_format # template_variables: # overlay_level: episode settings: @@ -385,15 +382,15 @@ libraries: less: 123 Anime: - metadata_path: - - pmm: basic # This is a file within PMM's defaults folder - - pmm: anilist # This is a file within PMM's defaults folder + collection_files: + - default: basic # This is a file within PMM's defaults folder + - default: anilist # This is a file within PMM's defaults folder # see the wiki for how to use local files, folders, URLs, or files from git Music: - metadata_path: + collection_files: - file: config/Music.yml # This is a local file THAT YOU MIGHT CREATE playlist_files: - - pmm: playlist # This is a file within PMM's defaults folder + - default: playlist # This is a file within PMM's defaults folder template_variables: libraries: Movies, TV Shows # list of libraries that you want the PMM Defaults playlists to look at # see the wiki for how to use local files, folders, URLs, or files from git @@ -413,7 +410,7 @@ settings: show_asset_not_needed: true sync_mode: append minimum_items: 1 - default_collection_order: asdf + default_collection_order: release delete_below_minimum: true delete_not_scheduled: false run_again_delay: 2 diff --git a/plex_meta_manager.py b/kometa.py similarity index 95% rename from plex_meta_manager.py rename to kometa.py index 7574fedf..21f775f2 100644 --- a/plex_meta_manager.py +++ b/kometa.py @@ -30,7 +30,7 @@ arguments = { "debug": {"args": "db", "type": "bool", "help": "Run with Debug Logs Reporting to the Command Window"}, "trace": {"args": "tr", "type": "bool", "help": "Run with extra Trace Debug Logs"}, "log-requests": {"args": ["lr", "log-request"], "type": "bool", "help": "Run with all Requests printed"}, - "timeout": {"args": "ti", "type": "int", "default": 180, "help": "PMM Global Timeout (Default: 180)"}, + "timeout": {"args": "ti", "type": "int", "default": 180, "help": "Kometa Global Timeout (Default: 180)"}, "collections-only": {"args": ["co", "collection-only"], "type": "bool", "help": "Run only collection files"}, "metadata-only": {"args": ["mo", "metadatas-only"], "type": "bool", "help": "Run only metadata files"}, "playlists-only": {"args": ["po", "playlist-only"], "type": "bool", "help": "Run only playlist files"}, @@ -80,6 +80,13 @@ def get_env(env_str, default, arg_bool=False, arg_int=False): if env_value is not None: final_value = env_value break + if not final_value: + for env_var in env_vars: + if env_var.startswith("KOMETA"): + env_value = os.environ.get(env_var.replace("KOMETA", "PMM")) + if env_value is not None: + final_value = env_value + break if final_value or (arg_int and final_value == 0): if arg_bool: if final_value is True or final_value is False: @@ -103,13 +110,13 @@ static_envs = [] run_args = {} for arg_key, arg_data in arguments.items(): temp_args = arg_data["args"] if isinstance(arg_data["args"], list) else [arg_data["args"]] - final_vars = [f"PMM_{arg_key.replace('-', '_').upper()}"] + [f"PMM_{a.replace('-', '_').upper()}" for a in temp_args if len(a) > 2] + final_vars = [f"KOMETA_{arg_key.replace('-', '_').upper()}"] + [f"KOMETA_{a.replace('-', '_').upper()}" for a in temp_args if len(a) > 2] run_args[arg_key] = get_env(final_vars, getattr(args, arg_key.replace("-", "_")), arg_bool=arg_data["type"] == "bool", arg_int=arg_data["type"] == "int") env_version = get_env("BRANCH_NAME", "master") -is_docker = get_env("PMM_DOCKER", False, arg_bool=True) -is_linuxserver = get_env("PMM_LINUXSERVER", False, arg_bool=True) -is_lxml = get_env("PMM_LXML", False, arg_bool=True) +is_docker = get_env("KOMETA_DOCKER", False, arg_bool=True) +is_linuxserver = get_env("KOMETA_LINUXSERVER", False, arg_bool=True) +is_lxml = get_env("KOMETA_LXML", False, arg_bool=True) secret_args = {} plex_url = None @@ -117,24 +124,27 @@ plex_token = None i = 0 while i < len(unknown): test_var = str(unknown[i]).lower().replace("_", "-") - if test_var.startswith("--pmm-") or test_var in ["-pu", "--plex-url", "-pt", "--plex-token"]: + if test_var.startswith(("--pmm-", "--kometa-")) or test_var in ["-pu", "--plex-url", "-pt", "--plex-token"]: if test_var in ["-pu", "--plex-url"]: plex_url = str(unknown[i + 1]) elif test_var in ["-pt", "--plex-token"]: plex_token = str(unknown[i + 1]) - else: + elif test_var.startswith("--kometa-"): + secret_args[test_var[9:]] = str(unknown[i + 1]) + elif test_var.startswith("--pmm-"): secret_args[test_var[6:]] = str(unknown[i + 1]) i += 1 i += 1 -plex_url = get_env("PMM_PLEX_URL", plex_url) -plex_token = get_env("PMM_PLEX_TOKEN", plex_token) +plex_url = get_env("KOMETA_PLEX_URL", plex_url) +plex_token = get_env("KOMETA_PLEX_TOKEN", plex_token) env_secrets = [] for env_name, env_data in os.environ.items(): - if str(env_name).upper().startswith("PMM_") and str(env_name).upper() not in static_envs: + if str(env_name).upper().startswith("KOMETA_") and str(env_name).upper() not in static_envs: + secret_args[str(env_name).lower()[7:].replace("_", "-")] = env_data + elif str(env_name).upper().startswith("PMM_") and str(env_name).upper() not in static_envs: secret_args[str(env_name).lower()[4:].replace("_", "-")] = env_data - run_arg = " ".join([f'"{s}"' if " " in s else s for s in sys.argv[:]]) for _, sv in secret_args.items(): if sv in run_arg: @@ -165,7 +175,7 @@ elif not os.path.exists(os.path.join(default_dir, "config.yml")): print(f"Config Error: config not found at {os.path.abspath(default_dir)}") sys.exit(0) -logger = MyLogger("Plex Meta Manager", default_dir, run_args["width"], run_args["divider"][0], run_args["ignore-ghost"], +logger = MyLogger("Kometa", default_dir, run_args["width"], run_args["divider"][0], run_args["ignore-ghost"], run_args["tests"] or run_args["debug"], run_args["trace"], run_args["log-requests"]) from modules import util @@ -226,12 +236,13 @@ def start(attrs): logger.add_main_handler() logger.separator() logger.info("") - logger.info_center(" ____ _ __ __ _ __ __ ") - logger.info_center("| _ \\| | _____ __ | \\/ | ___| |_ __ _ | \\/ | __ _ _ __ __ _ __ _ ___ _ __ ") - logger.info_center("| |_) | |/ _ \\ \\/ / | |\\/| |/ _ \\ __/ _` | | |\\/| |/ _` | '_ \\ / _` |/ _` |/ _ \\ '__|") - logger.info_center("| __/| | __/> < | | | | __/ || (_| | | | | | (_| | | | | (_| | (_| | __/ | ") - logger.info_center("|_| |_|\\___/_/\\_\\ |_| |_|\\___|\\__\\__,_| |_| |_|\\__,_|_| |_|\\__,_|\\__, |\\___|_| ") - logger.info_center(" |___/ ") + logger.info_center(" __ ___ ______ .___ ___. _______ .___________. ___ ") + logger.info_center("| |/ / / __ \\ | \\/ | | ____|| | / \\ ") + logger.info_center("| ' / | | | | | \\ / | | |__ `---| |----` / ^ \\ ") + logger.info_center("| < | | | | | |\\/| | | __| | | / /_\\ \\ ") + logger.info_center("| . \\ | `--' | | | | | | |____ | | / _____ \\ ") + logger.info_center("|__|\\__\\ \\______/ |__| |__| |_______| |__| /__/ \\__\\ ") + logger.info("") if is_lxml: system_ver = "lxml Docker" elif is_linuxserver: @@ -285,12 +296,12 @@ def start(attrs): for akey, adata in arguments.items(): if isinstance(adata["help"], str): ext = '"' if adata["type"] == "str" and run_args[akey] not in [None, "None"] else "" - logger.debug(f"--{akey} (PMM_{akey.replace('-', '_').upper()}): {ext}{run_args[akey]}{ext}") + logger.debug(f"--{akey} (KOMETA_{akey.replace('-', '_').upper()}): {ext}{run_args[akey]}{ext}") logger.debug("") if secret_args: - logger.debug("PMM Secrets Read:") + logger.debug("Kometa Secrets Read:") for sec in secret_args: - logger.debug(f"--pmm-{sec} (PMM_{sec.upper().replace('-', '_')}): (redacted)") + logger.debug(f"--kometa-{sec} (KOMETA_{sec.upper().replace('-', '_')}): (redacted)") logger.debug("") logger.separator(f"Starting {start_type}Run") config = None @@ -890,7 +901,7 @@ def run_collection(config, library, metadata, requested_collections): library.notify(e, collection=mapping_name) logger.stacktrace() logger.error(e) - library.status[str(mapping_name)]["status"] = "PMM Failure" + library.status[str(mapping_name)]["status"] = "Kometa Failure" library.status[str(mapping_name)]["errors"].append(e) except Exception as e: library.notify(f"Unknown Error: {e}", collection=mapping_name) @@ -1071,7 +1082,7 @@ def run_playlists(config): config.notify(e, server=server_name, playlist=mapping_name) logger.stacktrace() logger.error(e) - status[mapping_name]["status"] = "PMM Failure" + status[mapping_name]["status"] = "Kometa Failure" status[mapping_name]["errors"].append(e) except Exception as e: config.notify(f"Unknown Error: {e}", server=server_name, playlist=mapping_name) @@ -1129,4 +1140,4 @@ if __name__ == "__main__": logger.error(f"Time Error: {valid_times}") time.sleep(60) except KeyboardInterrupt: - logger.separator("Exiting Plex Meta Manager") + logger.separator("Exiting Kometa") diff --git a/mkdocs.yml b/mkdocs.yml index 7daf5d13..cbd3f730 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,15 +1,18 @@ -site_name: Plex Meta Manager Wiki +site_name: Kometa Wiki site_author: meisnate12 -site_description: Plex Meta Manager is an open-source python project allowing you to unlock the potential of your media server. -site_url: https://<slug>.metamanager.wiki/en/latest/ -repo_name: Plex Meta Manager -repo_url: https://github.com/meisnate12/Plex-Meta-Manager +site_description: Kometa is an open-source python project allowing you to unlock the potential of your media server. +site_url: https://<slug>.kometa.wiki/en/latest/ +repo_name: Kometa +repo_url: https://github.com/Kometa-Team/Kometa theme: name: material logo: assets/icon.png favicon: assets/favicon.png custom_dir: docs/overrides + font: + text: Open Sans + code: Fira Code features: - content.code.annotate - content.tabs.link @@ -32,7 +35,6 @@ theme: - media: "(prefers-color-scheme: dark)" scheme: slate primary: custom - accent: deep purple toggle: icon: material/weather-night name: Switch to light mode @@ -41,7 +43,6 @@ theme: - media: "(prefers-color-scheme: light)" scheme: default primary: custom - accent: deep purple toggle: icon: material/weather-sunny name: Switch to dark mode @@ -55,7 +56,7 @@ plugins: - include-markdown - redirects: redirect_maps: - 'discord.md': 'https://metamanager.wiki/en/nightly/link/' + 'discord.md': 'https://kometa.wiki/en/nightly/link/' 'redact.md': 'https://regex101.com/r/DMo1DQ/latest' 'link.md': 'https://discord.gg/FNqqw5jRSz' 'malauth.md': 'https://replit.com/@chazlarson/MALAuth' @@ -79,16 +80,16 @@ extra: name: Donate - icon: fontawesome/brands/discord class: md-social__link - link: 'https://metamanager.wiki/en/latest/discord/' + link: 'https://kometa.wiki/en/latest/discord/' name: Discord - icon: fontawesome/brands/github class: md-social__link - link: 'https://github.com/meisnate12/Plex-Meta-Manager' + link: 'https://github.com/Kometa-Team/Kometa' name: GitHub analytics: provider: plausible - domain: metamanager.wiki/en/latest - src: "https://analytics.metamanager.wiki/js/script.js" + domain: kometa.wiki/en/latest + src: "https://analytics.kometa.wiki/js/script.js" copyright: Copyright © 2024 meisnate12 markdown_extensions: - pymdownx.tasklist: @@ -127,40 +128,41 @@ extra_javascript: - stylesheets/branch.js nav: - - PLEX META MANAGER: + - KOMETA: - Home: index.md - INSTALLATION: - - Installing PMM: pmm/install/overview.md - - Docker Images: pmm/install/images.md - - Walkthroughs: - - Local Walkthrough (Win/Mac/Linux): pmm/install/local.md - - Docker Walkhrough: pmm/install/docker.md - - unRAID Walkthrough: pmm/install/unraid.md - - Kubernetes Walkthrough: pmm/install/kubernetes.md - - QNAP Walkthrough: pmm/install/qnap.md - - Synology Walkthrough: pmm/install/synology.md + - Installing Kometa: kometa/install/overview.md + - Docker Images: kometa/install/images.md + - Walkthroughs: &walkthroughs + - Local (Win/Mac/Linux): kometa/install/local.md + - Docker: kometa/install/docker.md + - unRAID: kometa/install/unraid.md + - Kubernetes: kometa/install/kubernetes.md + - QNAP: kometa/install/qnap.md + - Synology: kometa/install/synology.md - POST-INSTALL: - - Run Commands & Env Variables: pmm/environmental.md - - YAML Files Explained: pmm/yaml.md - - Log Files & Common Errors: pmm/logs.md - - Frequently Asked Questions: pmm/faqs.md + - Run Commands & Env Variables: kometa/environmental.md + - YAML Files Explained: kometa/yaml.md + - Log Files & Common Errors: kometa/logs.md + - Frequently Asked Questions: kometa/faqs.md - Explanation Guides: &guides - - Overview: pmm/guides/overview.md - - Plex Ratings Explained: pmm/guides/ratings.md - - Scheduling PMM Runs Guide: pmm/guides/scheduling.md - - Image Asset Directory Guide: pmm/guides/assets.md - - Formula 1 Metadata Guide: pmm/guides/formula.md + - Overview: kometa/guides/overview.md + - Plex Ratings Explained: kometa/guides/ratings.md + - Scheduling Kometa Runs Guide: kometa/guides/scheduling.md + - Image Asset Directory Guide: kometa/guides/assets.md + - Formula 1 Metadata Guide: kometa/guides/formula.md + - MediUX Assets Guide: kometa/guides/mediux.md - Companion Scripts: &scripts - - Overview: pmm/scripts/overview.md - - Plex Image Cleanup: pmm/scripts/image-cleanup.md - - PMM Overlay Reset: pmm/scripts/overlay-reset.md + - Overview: kometa/scripts/overview.md + - ImageMaid: kometa/scripts/imagemaid.md + - Kometa Overlay Reset: kometa/scripts/overlay-reset.md - USEFUL LINKS: &links - - Feature Requests: https://features.metamanager.wiki/ - - Bugs & Issues: https://github.com/meisnate12/Plex-Meta-Manager/issues - - User Configs Repository: https://github.com/meisnate12/Plex-Meta-Manager-Configs - - Discord Server: https://metamanager.wiki/en/latest/discord/ - - Donate/Sponsor PMM: https://github.com/sponsors/meisnate12 - - Acknowledgements: pmm/acknowledgements.md + - Feature Requests: https://features.kometa.wiki/ + - Bugs & Issues: https://github.com/Kometa-Team/Kometa/issues + - Community Configs: https://github.com/Kometa-Team/Community-Configs + - Discord Server: https://kometa.wiki/en/latest/discord/ + - Donate/Sponsor Kometa: https://github.com/sponsors/meisnate12 + - Acknowledgements: kometa/acknowledgements.md - CONFIGURATION FILE: - Overview: config/overview.md - STRUCTURE: @@ -186,7 +188,7 @@ nav: - AniDB: config/anidb.md - MyAnimeList: config/myanimelist.md - Trakt and MyAnimeList Authentication: config/auth.md - - PMM DEFAULTS: + - KOMETA DEFAULTS: - Defaults Usage Guide: defaults/guide.md - Defaults Files: defaults/files.md - COLLECTIONS DEFAULTS: diff --git a/modules/builder.py b/modules/builder.py index 7305c450..93cd5e87 100644 --- a/modules/builder.py +++ b/modules/builder.py @@ -5,7 +5,7 @@ from dateutil.relativedelta import relativedelta from modules import anidb, anilist, icheckmovies, imdb, letterboxd, mal, mojo, plex, radarr, reciperr, sonarr, tautulli, tmdb, trakt, tvdb, mdblist, util from modules.util import Failed, FilterFailed, NonExisting, NotScheduled, NotScheduledRange, Deleted from modules.overlay import Overlay -from modules.poster import PMMImage +from modules.poster import KometaImage from plexapi.audio import Artist, Album, Track from plexapi.exceptions import NotFound from plexapi.video import Movie, Show, Season, Episode @@ -44,7 +44,7 @@ scheduled_boolean = ["visible_library", "visible_home", "visible_shared"] string_details = ["sort_title", "content_rating", "name_mapping"] ignored_details = [ "smart_filter", "smart_label", "smart_url", "run_again", "schedule", "sync_mode", "template", "variables", "test", "suppress_overlays", - "delete_not_scheduled", "tmdb_person", "build_collection", "collection_order", "builder_level", "overlay", "pmm_poster", + "delete_not_scheduled", "tmdb_person", "build_collection", "collection_order", "builder_level", "overlay", "kometa_poster", "validate_builders", "libraries", "sync_to_users", "exclude_users", "collection_name", "playlist_name", "name", "limit", "blank_collection", "allowed_library_types", "run_definition", "delete_playlist", "ignore_blank_results", "only_run_on_create", "delete_collections_named", "tmdb_person_offset", "append_label", "key_name", "translation_key", "translation_prefix", "tmdb_birthday" @@ -479,14 +479,14 @@ class CollectionBuilder: self.posters = {} self.backgrounds = {} - if not self.overlay and "pmm_poster" in methods: + if not self.overlay and "kometa_poster" in methods: logger.debug("") - logger.debug("Validating Method: pmm_poster") - if self.data[methods["pmm_poster"]] is None: - logger.error(f"{self.Type} Error: pmm_poster attribute is blank") - logger.debug(f"Value: {data[methods['pmm_poster']]}") + logger.debug("Validating Method: kometa_poster") + if self.data[methods["kometa_poster"]] is None: + logger.error(f"{self.Type} Error: kometa_poster attribute is blank") + logger.debug(f"Value: {data[methods['kometa_poster']]}") try: - self.posters["pmm_poster"] = PMMImage(self.config, self.data[methods["pmm_poster"]], "pmm_poster", playlist=self.playlist) + self.posters["kometa_poster"] = KometaImage(self.config, self.data[methods["kometa_poster"]], "kometa_poster", playlist=self.playlist) except Failed as e: logger.error(e) @@ -957,7 +957,7 @@ class CollectionBuilder: raise Failed(f"{self.Type} Error: collection_order: {ts} is invalid. Options: {', '.join(sorts)}") self.custom_sort.append(ts) if test_sort not in plex.collection_order_options + ["custom.asc", "custom.desc"] and not self.custom_sort: - raise Failed(f"{self.Type} Error: {test_sort} collection_order invalid\n\trelease (Order Collection by release dates)\n\talpha (Order Collection Alphabetically)\n\tcustom.asc/custom.desc (Custom Order Collection)\n\tOther sorting options can be found at https://github.com/meisnate12/Plex-Meta-Manager/wiki/Smart-Builders#sort-options") + raise Failed(f"{self.Type} Error: {test_sort} collection_order invalid\n\trelease (Order Collection by release dates)\n\talpha (Order Collection Alphabetically)\n\tcustom.asc/custom.desc (Custom Order Collection)\n\tOther sorting options can be found at https://github.com/Kometa-Team/Kometa/wiki/Smart-Builders#sort-options") if self.smart: self.custom_sort = None @@ -3356,9 +3356,9 @@ class CollectionBuilder: remove_tags = self.details["label.remove"] if "label.remove" in self.details else None sync_tags = self.details["label.sync"] if "label.sync" in self.details else None if sync_tags: - sync_tags.append("PMM") + sync_tags.append("Kometa") else: - add_tags.append("PMM") + add_tags.append("Kometa") tag_results = self.library.edit_tags('label', self.obj, add_tags=add_tags, remove_tags=remove_tags, sync_tags=sync_tags, do_print=False) if tag_results: batch_display += f"\n{tag_results}" @@ -3453,7 +3453,7 @@ class CollectionBuilder: self.collection_background = util.pick_image(self.obj.title, self.backgrounds, self.library.prioritize_assets, self.library.download_url_assets, asset_location, is_poster=False) clean_temp = False - if isinstance(self.collection_poster, PMMImage): + if isinstance(self.collection_poster, KometaImage): clean_temp = True item_vars = {"title": self.name, "titleU": self.name.upper(), "titleL": self.name.lower()} self.collection_poster = self.collection_poster.save(item_vars) diff --git a/modules/config.py b/modules/config.py index 3b09bae2..4702a3f6 100644 --- a/modules/config.py +++ b/modules/config.py @@ -33,7 +33,7 @@ from retrying import retry logger = util.logger -mediastingers_url = "https://raw.githubusercontent.com/meisnate12/PMM-Mediastingers/master/stingers.yml" +mediastingers_url = "https://raw.githubusercontent.com/Kometa-Team/Mediastingers/master/stingers.yml" run_order_options = { "collections": "Represents Collection Updates", "metadata": "Represents Metadata Updates", diff --git a/modules/convert.py b/modules/convert.py index 065c0875..84594c95 100644 --- a/modules/convert.py +++ b/modules/convert.py @@ -5,7 +5,7 @@ from plexapi.exceptions import BadRequest logger = util.logger -anime_lists_url = "https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager-Anime-IDs/master/pmm_anime_ids.json" +anime_lists_url = "https://raw.githubusercontent.com/Kometa-Team/Anime-IDs/master/anime_ids.json" class Convert: def __init__(self, config): diff --git a/modules/github.py b/modules/github.py index a14995c6..72da6494 100644 --- a/modules/github.py +++ b/modules/github.py @@ -6,8 +6,8 @@ logger = util.logger raw_url = "https://raw.githubusercontent.com" base_url = "https://api.github.com" -pmm_base = f"{base_url}/repos/meisnate12/Plex-Meta-Manager" -configs_raw_url = f"{raw_url}/meisnate12/Plex-Meta-Manager-Configs" +kometa_base = f"{base_url}/repos/Kometa-Team/Kometa" +configs_raw_url = f"{raw_url}/Kometa-Team/Community-Configs" class GitHub: def __init__(self, config, params): @@ -15,8 +15,8 @@ class GitHub: self.token = params["token"] logger.secret(self.token) self.headers = {"Authorization": f"token {self.token}"} if self.token else None - self.images_raw_url = f"{raw_url}/meisnate12/PMM-Image-Sets/master/sets/" - self.translation_url = f"{raw_url}/meisnate12/PMM-Translations/master/defaults/" + self.images_raw_url = f"{raw_url}/Kometa-Team/Image-Sets/master/sets/" + self.translation_url = f"{raw_url}/Kometa-Team/Translations/master/defaults/" self._configs_url = None self._config_tags = [] self._translation_keys = [] @@ -48,11 +48,11 @@ class GitHub: return {i["path"]: i for i in self._requests(tree_url, f"No tree found at {tree_url}")["tree"]} def latest_release_notes(self): - return self._requests(f"{pmm_base}/releases/latest")["body"] + return self._requests(f"{kometa_base}/releases/latest")["body"] def get_commits(self, dev_version, nightly=False): - master_sha = self._requests(f"{pmm_base}/commits/master")["sha"] - response = self._requests(f"{pmm_base}/commits", params={"sha": "nightly" if nightly else "develop"}) + master_sha = self._requests(f"{kometa_base}/commits/master")["sha"] + response = self._requests(f"{kometa_base}/commits", params={"sha": "nightly" if nightly else "develop"}) commits = [] for commit in response: if commit["sha"] == master_sha: @@ -68,7 +68,7 @@ class GitHub: def config_tags(self): if not self._config_tags: try: - self._config_tags = [r["ref"][11:] for r in self._requests(f"{pmm_base}-Configs/git/refs/tags")] + self._config_tags = [r["ref"][11:] for r in self._requests(f"{kometa_base}-Configs/git/refs/tags")] except TypeError: pass return self._config_tags @@ -84,7 +84,7 @@ class GitHub: @property def translation_keys(self): if not self._translation_keys: - tree, repo = self.get_top_tree("meisnate12/PMM-Translations") + tree, repo = self.get_top_tree("Kometa-Team/Translations") self._translation_keys = [tk[:-4] for tk in self.get_tree(tree["defaults"]["url"])] return self._translation_keys diff --git a/modules/imdb.py b/modules/imdb.py index 642a23c6..b78e7c0a 100644 --- a/modules/imdb.py +++ b/modules/imdb.py @@ -88,8 +88,8 @@ event_options = { "razzie": {"eventId": "ev0000558"}, } base_url = "https://www.imdb.com" -git_base = "https://raw.githubusercontent.com/meisnate12/PMM-IMDb-Awards/master" -hash_url = "https://raw.githubusercontent.com/meisnate12/IMDb-Hash/master/HASH" +git_base = "https://raw.githubusercontent.com/Kometa-Team/IMDb-Awards/master" +hash_url = "https://raw.githubusercontent.com/Kometa-Team/IMDb-Hash/master/HASH" graphql_url = "https://api.graphql.imdb.com/" list_url = f"{base_url}/list/ls" diff --git a/modules/library.py b/modules/library.py index 30da97fa..bc07266d 100644 --- a/modules/library.py +++ b/modules/library.py @@ -293,7 +293,7 @@ class Library(ABC): exif_tags = image.getexif() if 0x04bc in exif_tags and exif_tags[0x04bc] == "overlay": os.remove(image_path) - raise Failed("This item's poster already has an Overlay. There is no PMM setting to change; manual attention required.") + raise Failed("This item's poster already has an Overlay. There is no Kometa setting to change; manual attention required.") if remove: os.remove(image_path) else: diff --git a/modules/mdblist.py b/modules/mdblist.py index a2c69482..325e20fc 100644 --- a/modules/mdblist.py +++ b/modules/mdblist.py @@ -17,7 +17,7 @@ list_sorts = [f"{s}.asc" for s in sort_names] + [f"{s}.desc" for s in sort_names base_url = "https://mdblist.com/lists" api_url = "https://mdblist.com/api/" -headers = {"User-Agent": "Plex-Meta-Manager"} +headers = {"User-Agent": "Kometa"} class MDbObj: def __init__(self, data): diff --git a/modules/meta.py b/modules/meta.py index b860fe2d..8f70cc3f 100644 --- a/modules/meta.py +++ b/modules/meta.py @@ -114,14 +114,14 @@ class DataFile: file_path = file_path[:-5] if not translation and not file_path.endswith((".yml", ".yaml")): file_path = f"{file_path}.yml" - if file_type in ["URL", "Git", "Repo"] or (images and file_type == "PMM Default"): + if file_type in ["URL", "Git", "Repo"] or (images and file_type == "Default"): if file_type == "Repo" and not self.config.custom_repo: raise Failed("Config Error: No custom_repo defined") if file_type == "URL": content_path = file_path elif file_type == "Repo": content_path = f"{self.config.custom_repo}{file_path}" - elif file_type == "PMM Default": + elif file_type == "Default": content_path = f"{self.config.GitHub.images_raw_url}{folder}{file_path}" else: content_path = f"{self.config.GitHub.configs_url}{file_path}" @@ -133,7 +133,7 @@ class DataFile: raise Failed(f"URL Error: No file found at {content_path}") yaml = YAML(input_data=response.content, check_empty=True) else: - if file_type == "PMM Default": + if file_type == "Default": if not overlay and file_path.startswith(("movie/", "chart/", "award/")): file_path = file_path[6:] elif not overlay and file_path.startswith(("show/", "both/")): @@ -153,7 +153,7 @@ class DataFile: content_path = os.path.abspath(os.path.join(file_path, "default.yml") if translation else file_path) dir_path = file_path if not os.path.exists(content_path): - if file_type == "PMM Default": + if file_type == "Default": raise Failed(f"File Error: Default does not exist {file_path}") else: raise Failed(f"File Error: File does not exist {content_path}") @@ -623,7 +623,7 @@ class MetadataFile(DataFile): self.style_priority = [] if self.file_style == "image": self.metadata = {} - if self.type == "PMM Default": + if self.type == "Default": if self.path.endswith(".yml"): self.path = self.path[:-4] elif self.path.endswith(".yaml"): @@ -2169,7 +2169,7 @@ class MetadataFile(DataFile): if str(meta[methods["f1_language"]]).lower() in ergast.translations: f1_language = str(meta[methods["f1_language"]]).lower() else: - logger.error(f"{self.type_str} Error: f1_language must be a language code PMM has a translation for. Options: {ergast.translations}") + logger.error(f"{self.type_str} Error: f1_language must be a language code Kometa has a translation for. Options: {ergast.translations}") logger.info(f"Setting {item.title} of {self.type_str} to F1 Season {f1_season}") races = self.config.Ergast.get_races(f1_season, f1_language) race_lookup = {r.round: r for r in races} diff --git a/modules/operations.py b/modules/operations.py index 16d7f2e6..87a8ab60 100644 --- a/modules/operations.py +++ b/modules/operations.py @@ -1044,7 +1044,9 @@ class Operations: and (less is None or col.childCount < less) \ and (managed is None or (managed is True and "PMM" in labels) - or (managed is False and "PMM" not in labels)) \ + or (managed is True and "Kometa" in labels) + or (managed is False and "PMM" not in labels) + or (managed is False and "Kometa" not in labels)) \ and (configured is None or (configured is True and col.title in self.library.collections) or (configured is False and col.title not in self.library.collections)): @@ -1054,7 +1056,7 @@ class Operations: except Failed as e: logger.error(e) else: - if "PMM" not in labels: + if "PMM" not in labels and "Kometa" not in labels: unmanaged_collections.append(col) if col.title not in self.library.collection_names: unconfigured_collections.append(col) diff --git a/modules/overlay.py b/modules/overlay.py index 4c9bf46c..74a97c4d 100644 --- a/modules/overlay.py +++ b/modules/overlay.py @@ -180,8 +180,13 @@ class Overlay: return image_path if not self.name.startswith(("blur", "backdrop")): - if ("pmm" in self.data and self.data["pmm"]) or ("git" in self.data and self.data["git"] and self.data["git"].startswith("PMM/")): - temp_path = self.data["pmm"] if "pmm" in self.data and self.data["pmm"] else self.data["git"][4:] + if ("kometa" in self.data and self.data["kometa"]) or ("pmm" in self.data and self.data["pmm"]) or ("git" in self.data and self.data["git"] and self.data["git"].startswith("PMM/")): + if "kometa" in self.data and self.data["kometa"]: + temp_path = self.data["kometa"] + elif "pmm" in self.data and self.data["pmm"]: + temp_path = self.data["pmm"] + else: + temp_path = self.data["git"][4:] if temp_path.startswith("overlays/images/"): temp_path = temp_path[16:] if not temp_path.endswith(".png"): @@ -244,11 +249,11 @@ class Overlay: if not os.path.exists(font) and os.path.exists(os.path.join(code_base, font)): font = os.path.join(code_base, font) if not os.path.exists(font): - pmm_fonts = os.listdir(font_base) - fonts = util.get_system_fonts() + pmm_fonts + kometa_fonts = os.listdir(font_base) + fonts = util.get_system_fonts() + kometa_fonts if font not in fonts: raise Failed(f"Overlay Error: font: {os.path.abspath(font)} not found. Options: {', '.join(fonts)}") - if font in pmm_fonts: + if font in kometa_fonts: font = os.path.join(font_base, font) self.font_name = font self.font = ImageFont.truetype(self.font_name, self.font_size) diff --git a/modules/plex.py b/modules/plex.py index fc627b9e..c8341071 100644 --- a/modules/plex.py +++ b/modules/plex.py @@ -1571,8 +1571,8 @@ class Plex(Library): if match_dict: attrs["match"] = match_dict - def check_field(plex_key, pmm_key, var_key=None): - if plex_key in fields and pmm_key not in self.metadata_backup["exclude"]: + def check_field(plex_key, kometa_key, var_key=None): + if plex_key in fields and kometa_key not in self.metadata_backup["exclude"]: if not var_key: var_key = plex_key if hasattr(item, var_key): @@ -1580,11 +1580,11 @@ class Plex(Library): if isinstance(plex_value, list): plex_tags = [t.tag for t in plex_value] if len(plex_tags) > 0 or self.metadata_backup["sync_tags"]: - attrs[f"{pmm_key}.sync" if self.metadata_backup["sync_tags"] else pmm_key] = None if not plex_tags else plex_tags[0] if len(plex_tags) == 1 else plex_tags + attrs[f"{kometa_key}.sync" if self.metadata_backup["sync_tags"] else kometa_key] = None if not plex_tags else plex_tags[0] if len(plex_tags) == 1 else plex_tags elif isinstance(plex_value, datetime): - attrs[pmm_key] = datetime.strftime(plex_value, "%Y-%m-%d") + attrs[kometa_key] = datetime.strftime(plex_value, "%Y-%m-%d") else: - attrs[pmm_key] = plex_value + attrs[kometa_key] = plex_value check_field("titleSort", "sort_title") check_field("editionTitle", "edition") diff --git a/modules/poster.py b/modules/poster.py index 47676830..7b52d14e 100644 --- a/modules/poster.py +++ b/modules/poster.py @@ -123,9 +123,9 @@ class Component(ImageBase): self.addon_offset = util.parse("Posters", "addon_offset", self.data, datatype="int", methods=self.methods, default=0, minimum=0) if "stroke_width" in self.methods else 0 if "text" in self.methods: font_base = os.path.join(self.code_base, "fonts") - pmm_fonts = os.listdir(font_base) + kometa_fonts = os.listdir(font_base) all_fonts = {s: s for s in util.get_system_fonts()} - for font_name in pmm_fonts: + for font_name in kometa_fonts: all_fonts[font_name] = os.path.join(font_base, font_name) self.text = util.parse("Posters", "text", self.data, methods=self.methods, default="<<title>>") self.font_name, self.font_compare = self.check_file("font", all_fonts, local=True) @@ -321,7 +321,7 @@ class Component(ImageBase): return generated_layer, main_point, image -class PMMImage(ImageBase): +class KometaImage(ImageBase): def __init__(self, config, data, image_attr, playlist=False): super().__init__(config, data) self.image_attr = image_attr diff --git a/modules/util.py b/modules/util.py index e9d4e7e1..a1aab1ec 100644 --- a/modules/util.py +++ b/modules/util.py @@ -158,7 +158,7 @@ def get_master(): def get_version(level): try: - url = f"https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/{level}/VERSION" + url = f"https://raw.githubusercontent.com/Kometa-Team/Kometa/{level}/VERSION" return parse_version(requests.get(url).content.decode().strip(), text=level) except requests.exceptions.ConnectionError: return "Unknown", "Unknown", 0 @@ -425,13 +425,13 @@ def load_files(files_to_load, method, err_type="Config", schedule=None, lib_vars if isinstance(file, dict): current = [] def check_dict(attr, name): - if attr in file and (method != "metadata_files" or attr != "pmm"): + if attr in file and (method != "metadata_files" or attr not in ["pmm", "default"]): logger.info(f"Reading {attr}: {file[attr]}") if file[attr]: - if attr == "pmm" and file[attr] == "other_award": - logger.error(f"{err_type} Error: The PMM Default other_award has been deprecated. Please visit the wiki for the full list of available award files") + if attr in ["pmm", "default"] and file[attr] == "other_award": + logger.error(f"{err_type} Error: The Kometa Default other_award has been deprecated. Please visit the wiki for the full list of available award files") elif attr == "git" and file[attr].startswith("PMM/"): - current.append(("PMM Default", file[attr][4:])) + current.append(("Default", file[attr][4:])) else: current.append((name, file[attr])) else: @@ -440,7 +440,8 @@ def load_files(files_to_load, method, err_type="Config", schedule=None, lib_vars check_dict("url", "URL") check_dict("git", "Git") - check_dict("pmm", "PMM Default") + check_dict("pmm", "Default") + check_dict("default", "Default") check_dict("repo", "Repo") check_dict("file", "File") if not single and "folder" in file: diff --git a/modules/webhooks.py b/modules/webhooks.py index 0edf3171..092de625 100644 --- a/modules/webhooks.py +++ b/modules/webhooks.py @@ -58,13 +58,13 @@ class Webhooks: yaml.data["webhooks"][hook_cat] = None if changed: yaml.save() - remove_from_config("PMM updated trigger is not enabled", "changes") - remove_from_config("PMM created trigger is not enabled", "changes") - remove_from_config("PMM deleted trigger is not enabled", "changes") - remove_from_config("PMM failure trigger is not enabled", "error") - remove_from_config("PMM start/complete trigger is not enabled", "run_start") - remove_from_config("PMM start/complete trigger is not enabled", "run_end") - remove_from_config("PMM app updates trigger is not enabled", "version") + remove_from_config("Kometa updated trigger is not enabled", "changes") + remove_from_config("Kometa created trigger is not enabled", "changes") + remove_from_config("Kometa deleted trigger is not enabled", "changes") + remove_from_config("Kometa failure trigger is not enabled", "error") + remove_from_config("Kometa start/complete trigger is not enabled", "run_start") + remove_from_config("Kometa start/complete trigger is not enabled", "run_end") + remove_from_config("Kometa app updates trigger is not enabled", "version") if "result" in response_json and response_json["result"] == "error" and "details" in response_json and "response" in response_json["details"]: raise Failed(f"Notifiarr Error: {response_json['details']['response']}") if response.status_code >= 400 or ("result" in response_json and response_json["result"] == "error"): @@ -146,7 +146,7 @@ class Webhooks: def slack(self, json): if json["event"] == "run_end": - title = ":white_check_mark: Plex Meta Manager Has Finished a Run" + title = ":white_check_mark: Kometa Has Finished a Run" rows = [ [("*Start Time*", json["start_time"]), ("*End Time*", json["end_time"]), ("*Run Time*", json["run_time"])], [], @@ -164,10 +164,10 @@ class Webhooks: rows.append([("*Added To Sonarr*", json['added_to_sonarr'])]) elif json["event"] == "run_start": - title = ":information_source: Plex Meta Manager Has Started!" + title = ":information_source: Kometa Has Started!" rows = [[("*Start Time*", json["start_time"])]] elif json["event"] == "version": - title = "Plex Meta Manager Has a New Version Available" + title = "Kometa Has a New Version Available" rows = [ [("*Current Version*", json["current"]), ("*Latest Version*", json["latest"])], [(json["notes"], )] @@ -191,7 +191,7 @@ class Webhooks: if json["event"] == "delete": title = json["message"] elif "error" in json: - title = f":warning: Plex Meta Manager Encountered {'a Critical' if json['critical'] else 'an'} Error" + title = f":warning: Kometa Encountered {'a Critical' if json['critical'] else 'an'} Error" rows.append([]) rows.append([(json["error"], )]) else: @@ -313,8 +313,8 @@ class Webhooks: "color": 0x00bc8c } ], - "username": "Metabot", - "avatar_url": "https://github.com/meisnate12/Plex-Meta-Manager/raw/master/.github/pmm.png" + "username": "Kobota", + "avatar_url": "https://github.com/Kometa-Team/Kometa/raw/master/.github/logo.png" } if description: new_json["embeds"][0]["description"] = description diff --git a/requirements.txt b/requirements.txt index ebbfd75b..6fdee4f5 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,10 +1,10 @@ -arrapi==1.4.7 +arrapi==1.4.11 GitPython==3.1.43 lxml==5.2.1 num2words==0.5.13 pathvalidate==3.2.0 pillow==10.3.0 -PlexAPI==4.15.11 +PlexAPI==4.15.12 psutil==5.9.8 python-dotenv==1.0.1 python-dateutil==2.9.0.post0 @@ -12,5 +12,5 @@ requests==2.31.0 retrying==1.3.4 ruamel.yaml==0.18.6 schedule==1.2.1 -setuptools==69.2.0 -tmdbapis==1.2.9 \ No newline at end of file +setuptools==69.5.1 +tmdbapis==1.2.14 \ No newline at end of file