Skip to content

Commit

Permalink
More words about sync mode
Browse files Browse the repository at this point in the history
  • Loading branch information
chazlarson committed Jan 5, 2025
1 parent cd98768 commit 23c14a5
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
17 changes: 17 additions & 0 deletions docs/config/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,23 @@ The available setting attributes which can be set at each level are outlined bel
sync_mode: sync
```

???+ tip "What does this mean?"
You have a Trakt list of ten movies. You run Kometa and create a collection from the list. The collection contains those ten movies.

Tomorrow the list contains a different ten movies. You run Kometa.

`sync_mode: sync` - Kometa syncs the collection with the list, so the collection still has ten movies, but they are the ones that are in the Trakt list today. The original ten have been removed from the collection.

`sync_mode: append` - Kometa appends the ten new movies to the collection, which now has twenty movies in it.

The next day five movies change in the list. You run Kometa.

`sync_mode: sync` - Kometa syncs the collection with the list, so the collection still has ten movies, the ones that are in the Trakt list today. The five that are no longer in the Trakt list are removed from the collection.

`sync_mode: append` - Kometa appends the five new movies to the collection, which now has twenty-five movies in it.


??? 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 Kometa unless the
Expand Down
2 changes: 1 addition & 1 deletion docs/files/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ All the following attributes serve various functions as how the definition funct
| `template` | **Description:** Used to specify a template and template variables to use for this definition. See the [Templates Page](templates.md) for more information.<br>**Values:** Dictionary |
| `schedule` | **Description:** Used to specify the schedule when this definition will run.<br>**Default:** `daily`<br>**Values:** [Any Schedule Option](../config/schedule.md) |
| `run_again` | **Description:** Used to try and add all the missing items to the definition again after the daily run.<br>**Default:** `false`<br>**Values:** `true` or `false` |
| `sync_mode` | **Description:** Used to change how builders sync with this definition.<br>**Default:** `sync_mode` [settings value](../config/settings.md) in the Configuration File<br>**Values:**<table class="clearTable"><tr><td>`append`</td><td>Only Add Items to the Collection</td></tr><tr><td>`sync`</td><td>Add & Remove Items from the Collection</td></tr></table> |
| `sync_mode` | **Description:** Used to change how builders sync with this definition.<br>**Default:** `sync_mode` [settings value](../config/settings.md) in the Configuration File<br>**Values:** `sync` or `append`<br>See main [settings page](../config/settings.md#sync-mode) |
| `builder_level` | **Description:** Make season, episode, album or track collections/overlays from `plex_all`, `plex_search`, `trakt_list`, or `imdb_list` Builders and Filters<br>**Values:**<table class="clearTable"><tr><td>`season`</td><td>Collection contains seasons</td></tr><tr><td>`episode`</td><td>Collection contains episodes</td></tr><tr><td>`album`</td><td>Collection contains albums</td></tr><tr><td>`track`</td><td>Collection contains tracks</td></tr></table> |
| `minimum_items` | **Description:** Minimum items that must be found to add to a definition.<br>**Default:** `minimum_items` [settings value](../config/settings.md) in the Configuration File<br>**Values:** number greater than 0 |
| `delete_below_minimum` | **Description:** Deletes the definition if below the minimum.<br>**Default:** `delete_below_minimum` [settings value](../config/settings.md) in the Configuration File<br>**Values:** `true` or `false` |
Expand Down

0 comments on commit 23c14a5

Please sign in to comment.