You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Plex-Meta-Manager/docs/kometa/guides/overview.md

106 lines
4.6 KiB

8 months ago
# 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 Kometa's and its companion scripts.
8 months ago
- [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 DIIIVOY (diiivoy)](https://github.com/Kometa-Team/People-Images-diiivoy)
- Stores the DIIIVOY actor posters
- [People Images DIIIVOY Color (diiivoycolor)](https://github.com/Kometa-Team/People-Images-diiivoycolor)
- Stores the DIIIVOY Color actor posters
8 months ago
- [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
## Demo Video
This YouTube video has been created by one of our community members to showcase some of the things that Kometa can do for you.
Caveat: it is very long, and the author has their own ideas as to what is "required". For example, this video begins with setting up a third-party script that is not required to use Kometa.
<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>