Viren070/stremio-gdrive-addon
1
0
Fork 0
mirror of https://github.com/Viren070/stremio-gdrive-addon.git synced 2025-12-01 23:20:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: update config table

Browse Source
This commit is contained in:
Viren070
2024-12-14 18:12:17 +00:00
parent 653af7aae6
commit 3cd20a5f9c
1 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+11 -9
View File
@@ -218,12 +218,14 @@ configure some aspects of the addon.
This table explains the configuration options:
| Name | Type | Values | Description |
|:-------------------------------------: |:--------------: |---------------------------------------------------------------------------------------------------------------------------------------------------- |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `resolution` | String[] | "2160p", "1080p", "720p", "480p", "Unknown" | This setting allows you to configure which resolutions are shown in your results. You may also change the order of this to change the order that the resolutions would show in the addon (if you sort by resolutions) <br><br>You can remove certain resolutions to not have them show up in your results. The `Unknown` resolution occurs when the resolution could not be determined from the filename. <br><br>You cannot add new resolutions to this list unless you also add the corresponding regex in the `REGEX_PATTERNS` object. |
| `qualities` | String[] | "BluRay Remux", "BDRip", "BluRay", "HDRip", "WEB-DL", "WebRip", "Web", "CAM/TS", "Unknown" | This setting allows you to configure which qualities are shown in your results. You may also change the order of this list to change the priority of them when sorting by quality. (e.g. if you put CAM/TS at the top of the list and sorted by quality, then CAM/TS results would appear higher than other qualities) <br><br>Remove qualities from the list to remove them from your results. The `Unknown` quality occurs when one of the existing qualities could not be found in the filename. <br><br>You cannot add new qualities to this list unless you also add the corresponding regex in the `REGEX_PATTERNS` object. |
| `sortBy` | String[] | "resolution", "quality", "size", "hdrdv" | Change the order of this list to change the priority for which the results are sorted by. <br><br>Examples: <br><br>If you want all 2160p results to show first with those results being sorted by size, then do `resolution`, then `size`<br>If you want results to be sorted by size regardless of resolution, only have `size` in the list. |
| `addonName` | String | any | Change the value contained in this string to change the name of the addon that appears in Stremio in the addon list<br>and in the stream results. |
| `prioritiseLanguage` | string \| null | See the `languages` object in the `REGEX_PATTERNS` object for a full list. <br><br>Set to null to disable prioritising specific language results. | By setting a prioritised language, you are pushing any results that have that language to the top. <br><br>However, parsed information about languages may be incorrect and filenames do not contain the language<br>that is contained within the file sometimes. |
| `driveQueryTerms.`<br>`episodeFormat` | string | "name", "fullText" (see the Drive v3 API for more) | This setting changes the object that we perform the queries upon for the episode formats (s01e03). <br><br>I recommend leaving this to fullText. However, if you are getting incorrect matches, try switching to name |
| `driveQueryTerms.`<br>`movieYear` | string | "name", "fullText" | This setting changes the object that we perform queries upon for the release year of the movie. <br><br>I recommend leaving this to name. However, if you are getting incorrect matches, try switching to fullText. |
| Name | Type | Values | Description |
|:-------------------------------------: |:------------------: |---------------------------------------------------------------------------------------------------------------------------------------------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `resolution` | `String[]` | "2160p", "1080p", "720p", "480p", "Unknown" | This setting allows you to configure which resolutions are shown in your results. You may also change the order of this to change the order that the resolutions would show in the addon (if you sort by resolutions)<br><br>You can remove certain resolutions to not have them show up in your results. The Unknown resolution occurs when the resolution could not be determined from the filename.<br><br>You cannot add new resolutions to this list unless you also add the corresponding regex in the `REGEX_PATTERNS` object. |
| `qualities` | `String[]` | "BluRay REMUX", "BluRay", "WEB-DL", "WEBRip", "HDRip", "HC HD-Rip", "DVDRip", "HDTV", "CAM", "Telesync", "Telecine", "Screener", "CAM" | This setting allows you to configure which qualities are shown in your results. You may also change the order of this list to change the priority of them when sorting by quality. (e.g. if you put CAM/TS at the top of the list and sorted by quality, then CAM/TS results would appear higher than other qualities)<br><br>Remove qualities from the list to remove them from your results. The Unknown quality occurs when one of the existing qualities could not be found in the filename.<br><br>You cannot add new qualities to this list unless you also add the corresponding regex in the `REGEX_PATTERNS` object. |
| `visualTags` | `String[]` | "HDR10+", "HDR10", "HDR", "DV", "IMAX", "AI" | This setting allows you to configure which visualTags are shown in your results. You can also change the order of this to change the priority of each visual tag when sorting by `visualTag` (e.g. If you were sorting by visualTag and moved IMAX to the front, and removed AI, then any results with the AI tag will be removed and any results with the IMAX tag will be pushed to the front)<br><br>You cannot add new visual tags to this list unless you also add the corresponding regex in the `REGEX_PATTERNS` object. |
| `sortBy` | `String[]` | "resolution", "quality", "size", "visualTag" | Change the order of this list to change the priority for which the results are sorted by.<br><br>`resolution` - sort by the resolution of the file e.g. 1080p, 720p. The better the resolution (determined by the resolution's position in the `resolution` list) the higher the result.<br>`quality` - sort by the quality of the file, e.g. BluRay, WEBRip. The better the quality (determined by the quality's position in the `qualities` list) the higher the result.<br>`size` - sort by the size of file e.g. 12GB. The higher the size the higher they show in the results.<br>`visualTag` - sort by the priority of the visual tags. Files with a visual tag are sorted higher and between files that both have visual tags, the order of the visual tag in the `visualTags` list will determine their order.<br><br>Examples:<br><br>If you want all 2160p results to show first with those results being sorted by size, then do resolution, then size<br>If you want results to be sorted by size regardless of resolution, only have size in the list.<br>If you want to see all HDR results first, and sort those results and the rest by size, then put `visualTag` and `size` in the list. |
| `addonName` | `String` | any | Change the value contained in this string to change the name of the addon that appears in Stremio in the addon list<br>and in the stream results. |
| `prioritiseLanguage` | `String` \| `null` | See the languages object in the REGEX_PATTERNS object for a full list.<br><br>Set to null to disable prioritising specific language results. | By setting a prioritised language, you are pushing any results that have that language to the top.<br><br>However, parsed information about languages may be incorrect and filenames do not contain the language<br>that is contained within the file sometimes. |
| `proxiedPlayback` | `boolean` | `true`, `false` | With `proxiedPlayback` enabled, the file will be streamed through the addon. If it is disabled, Stremio will stream directly from Google Drive. <br><br>If this option is disabled, streaming will not work on Stremio Web or through external players on iOS. You are also exposing your access token in the addon responses. <br><br>However, this option is experimental and may cause issues. I recommend leaving it enabled. <br><br>Note, that even with this enabled, anyone with your addon URL can still view your Google Drive files. |
| `driveQueryTerms.`<br>`episodeFormat` | `String` | `"name"`, `"fullText"` (see the Drive v3 API for more) | This setting changes the object that we perform the queries upon for the episode formats (s01e03).<br><br>I recommend leaving this to fullText. However, if you are getting incorrect matches, try switching to name |
| `driveQueryTerms.`<br>`movieYear` | `String` | `"name"`, `"fullText"` | This setting changes the object that we perform queries upon for the release year of the movie.<br><br>I recommend leaving this to name. However, if you are getting incorrect matches, try switching to fullText. |