@ -35,20 +35,47 @@ If you find steps 1-3 above daunting, there are some walkthroughs available that
2. The [Docker Walkthrough](home/guides/docker) covers the same thing, running the script via Docker.
3. The [unRAID Walkthrough](home/guides/unraid) gets you started configuring the script in UNRaid. It doesn't go through the same steps with regard to creating the config file and metadata file, so you may want to go through the [Docker Walkthrough](home/guides/docker) first on your computer to gain that understanding.
## Development & Nightly Builds
## Example Usage
Plex Meta Manager gives the user the power to curate a set of Collections to make discovering and organizing media easy. They can be built either using plex-based searches/filters, or by using popular builders such as TMDb, IMDb, Trakt, MDBList, MyAnimeList and many more.
Some example collections that can be created are:
* Trending/Popular (based on TMDb, IMDb, Trakt, etc.)
* Streaming Service (such as Netflix, Disney+, etc.)
* Networks
* Studios
* Genres
* Actors
* Decades
Development and Nightly builds are deemed as "beta" builds which are updated far more frequently than the master branch. Bug fixes, new features and and any other code added to Plex Meta Manager first goes to the nightly branch, followed by the develop branch, before finally being released to the master branch.
Below are some user-curated collections which have been created by Plex Meta Manager using the [PMM Defaults](defaults/guide).
The development builds (particularly the nightly branch) is only recommended for those who have a technical knowledge of Plex Meta Manager, and are happy with having to frequently update to receive the latest changes.
Develop and Nightly branches are deemed as "beta" branches which are updated far more frequently than the master branch. Bug fixes, new features and any other code added to Plex Meta Manager first goes to the nightly branch, followed by the develop branch, before finally being released to the master branch.
These branches (particularly the nightly branch) are only recommended for those who have a technical knowledge of Plex Meta Manager, and are happy with having to frequently update to receive the latest changes, and accept the risk that these branches may suffer breakages at any point.
<detailsclass="details-tabs">
<summary>Develop Branch - Click to Expand</summary>
[](https://github.com/meisnate12/Plex-Meta-Manager/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 development branch, so there may be rough edges.
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.
Switching to `develop`:
````{tab} Running in Docker
Add ":develop" to the image name in your run command or configuration:
```
@ -66,15 +93,20 @@ git checkout master
```
````
If switching to the develop build, 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 build.
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.
</details>
</br>
### Nightly
<detailsclass="details-tabs">
<summary>Nightly Branch - Click to Expand</summary>
[](https://github.com/meisnate12/Plex-Meta-Manager/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) build 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/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.
Switching to `nightly`:
@ -95,33 +127,10 @@ 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://discord.gg/NfH6mGFuAB).
</details>
As this build 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 build will be held within the [Plex Meta Manager Discord Server](https://discord.gg/NfH6mGFuAB).
## Example Usage
Plex Meta Manager gives the user the power to curate a set of Collections to make discovering and organizing media easy. They can be built either using plex-based searches/filters, or by using popular builders such as TMDb, IMDb, Trakt, MDBList, MyAnimeList and many more.
Some example collections that can be created are:
* Trending/Popular (based on TMDb, IMDb, Trakt, etc.)
* Streaming Service (such as Netflix, Disney+, etc.)
* Networks
* Studios
* Genres
* Actors
* Decades
Below are some user-curated collections which have been created by Plex Meta Manager.
The overlays and collection built in the images above can be easily added to any plex by using the [PMM Defaults](defaults/guide). These Files were created by the PMM team to make it easier than ever to have customized collections and overlays.
@ -146,7 +155,9 @@ If you are unable to use the [Plex Meta Manager Discord Server](https://discord.
## IBRACORP Video Walkthrough
[IBRACORP](https://ibracorp.io/) made a video walkthough for installing Plex Meta Manager on unRAID. While you might not be using unRAID the video goes over many key aspects of Plex Meta Manager and can be a great place to start learning how to use the script. Please note, since the making of the video, some significant changes have been made to Plex Meta Manager 1.17 and beyond so always reference the wiki for the latest details.
[IBRACORP](https://ibracorp.io/) made a video walkthough for installing Plex Meta Manager on unRAID. While you might not be using unRAID the video goes over many key aspects of Plex Meta Manager and can be a great place to start learning how to use the script.
**Please note, since the making of the video, significant changes have been made to Plex Meta Manager so always reference the wiki for the latest details.**
meisnate12
2 years ago