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: attempt to make table look better

Browse Source
This commit is contained in:
Viren070
2024-12-10 20:06:11 +00:00
parent 5c88ed548a
commit 682d65baea
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -9
View File
@@ -17,12 +17,12 @@ configure some aspects of the addon.
This table explains the configuration options:
| Setting Name | Type | Allowed 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) 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. 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. 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. You cannot add new qualities to this list unless you also add the corresponding regex in the `REGEX_PATTERNS` object. |
| `sortBy` | String[] | "resolution", "size" | Change the order of this list to change the priority for which the results are sorted by. Examples: If you want all 2160p results to show first with those results being sorted by size, then do `resolution`, then `size` 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 and in the stream results. |
| `prioritiseLanguage` | string \| null | See the `languages` object in the `REGEX_PATTERNS` object You can also set to null to disable | By setting a prioritised language, you are pushing any results that have that language to the top. However, parsed information about languages may be incorrect and filenames do not contain the language that is contained within the file sometimes. |
| `driveQueryTerms.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). I recommend leaving this to fullText. However, if you are getting incorrect matches, try switching to name |
| `driveQueryTerms.movieYear` | string | "name", "fullText" | This setting changes the object that we perform queries upon for the release year of the movie. I recommend leaving this to name. However, if you are getting incorrect matches, try switching to fullText. |
| Name | Type | Allowed Values | Description |
|:-----------------------------------: |:--------------: |-------------------------------------------------------------------------------------------------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `resolution` | String[] | "2160p", "1080p", "720p", "480p", "Unknown" | This setting allows you to configure which resolutions are shown in your results.<br>You may also change the order of this to change the order that the resolutions would show <br>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 <br>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", <br>"WEB-DL", "WebRip", "Web", "CAM/TS", "Unknown" | This setting allows you to configure which qualities are shown in your results. Remove qualities <br>from the list to remove them from your results. <br><br>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", "size" | 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<br>You can also set to null to disable | 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. | |