Skip to content

Commit ce810eb

Browse files
committed
Another pass at documentation!
1 parent 1012cb6 commit ce810eb

30 files changed

+271
-149
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -179,11 +179,11 @@ These are some scripts I have used for a while with JS injector, finally decided
179179
<th style="text-align:center">Theme Selector</th>
180180
</tr>
181181
<tr>
182-
<td><img src="images/colored-activity-icons.png" width="300" /></td>
183-
<td><img src="images/ratings.png" width="300" /></td>
184-
<td><img src="images/login-image.png" width="300" /></td>
185-
<td><img src="images/plugin-icons.png" width="130" /></td>
186-
<td><img src="images/theme-selector.png" width="300" /></td>
182+
<td><img src="docs/images/colored-activity-icons.png" width="300" /></td>
183+
<td><img src="docs/images/ratings.png" width="300" /></td>
184+
<td><img src="docs/images/login-image.png" width="300" /></td>
185+
<td><img src="docs/images/plugin-icons.png" width="130" /></td>
186+
<td><img src="docs/images/theme-selector.png" width="300" /></td>
187187
</tr>
188188
</table>
189189

@@ -216,17 +216,17 @@ To enable the Jellyseerr integration, you must first configure it in the plugin
216216
9. Click **Save**.
217217

218218
<p align="center">
219-
<img src="images/jellyseerr.png" width="600" style="border-radius:25px;" />
219+
<img src="docs/images/jellyseerr.png" width="600" style="border-radius:25px;" />
220220
</p>
221221

222222
> [!IMPORTANT]
223223
> For the integration to work, you must also enable **"Enable Jellyfin Sign-In"** in your Jellyseerr User Settings (`/settings/users`).
224224
> \
225-
> <img src="images/jellyfin-signin.png" width="500" style="border-radius:25px;" /> \
225+
> <img src="docs/images/jellyfin-signin.png" width="500" style="border-radius:25px;" /> \
226226
> \
227227
> All users who need access to request content must be imported into Jellyseerr as Jellyfin users.
228228
> <table align="center">
229-
> <tr><th style="text-align:center">Users that have access</th><th style="text-align:center">Users that don't have access (import them)</th> </tr> <tr> <td><img src="images/users-with-access.png" width="300"/></td> <td><img src="images/users-no-access.png" width="300"/></td> </tr> </table>
229+
> <tr><th style="text-align:center">Users that have access</th><th style="text-align:center">Users that don't have access (import them)</th> </tr> <tr> <td><img src="docs/images/users-with-access.png" width="300"/></td> <td><img src="docs/images/users-no-access.png" width="300"/></td> </tr> </table>
230230
231231
#### Icon States
232232

@@ -1837,16 +1837,16 @@ Here is a list of common errors you might see in your Jellyfin server logs or yo
18371837
<th style="text-align:center">Settings</th>
18381838
</tr>
18391839
<tr>
1840-
<td><img src="images/shortcuts.png" width="1000"/></td>
1841-
<td><img src="images/settings.png" width="1000"/></td>
1840+
<td><img src="docs/images/shortcuts.png" width="1000"/></td>
1841+
<td><img src="docs/images/settings.png" width="1000"/></td>
18421842
</tr>
18431843
<tr>
18441844
<th style="text-align:center">Pausescreen</th>
18451845
<th style="text-align:center">Elsewhere</th>
18461846
</tr>
18471847
<tr>
1848-
<td><img src="images/pausescreen.png" width="1000"/></td>
1849-
<td><img src="images/elsewhere.png" width="1000"/></td>
1848+
<td><img src="docs/images/pausescreen.png" width="1000"/></td>
1849+
<td><img src="docs/images/elsewhere.png" width="1000"/></td>
18501850
</tr>
18511851
</table>
18521852

docs/arr.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,8 @@ View upcoming releases from Sonarr and Radarr in a calendar interface.
164164
2. Navigate to ***arr Settings** tab
165165
3. Check **"Enable Calendar Page"**
166166
4. Choose integration method:
167-
- **Use Plugin Pages** - Adds sidebar link (requires Plugin Pages plugin)
168-
- **Use Custom Tabs** - Adds custom tab (requires Custom Tabs plugin)
167+
- **Use Plugin Pages** - Adds sidebar link (requires [Plugin Pages](https://github.com/IAmParadox27/jellyfin-plugin-pages) plugin)
168+
- **Use Custom Tabs** - Adds custom tab (requires [Custom Tabs](https://github.com/IAmParadox27/jellyfin-plugin-custom-tabs) plugin)
169169
5. Configure calendar settings (see below)
170170
6. Click **Save**
171171
7. Restart Jellyfin if using Plugin Pages
@@ -212,8 +212,8 @@ Monitor download queue and status from Sonarr and Radarr.
212212
2. Navigate to ***arr Settings** tab
213213
3. Check **"Enable Requests Page"**
214214
4. Choose integration method:
215-
- **Use Plugin Pages** - Adds sidebar link
216-
- **Use Custom Tabs** - Adds custom tab
215+
- **Use Plugin Pages** - Adds sidebar link (requires [Plugin Pages](https://github.com/IAmParadox27/jellyfin-plugin-pages) plugin)
216+
- **Use Custom Tabs** - Adds custom tab (requires [Custom Tabs](https://github.com/IAmParadox27/jellyfin-plugin-custom-tabs) plugin)
217217
5. Configure polling settings (see below)
218218
6. Click **Save**
219219
7. Restart Jellyfin if using Plugin Pages

docs/elsewhere.md

Lines changed: 53 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22

33
Discover where your media is available to stream across multiple regions and platforms.
44

5-
![Elsewhere](../images/elsewhere.png)
5+
![Elsewhere](images/elsewhere.png)
66

77
## Overview
88

9-
Jellyfin Elsewhere helps you find where movies and TV shows are available to stream, rent, or buy across different streaming services and regions. Powered by TMDB data, it provides comprehensive availability information directly on item detail pages.
9+
Jellyfin Elsewhere helps you find where movies and TV shows are available across different streaming services and regions. Powered by TMDB data, it provides comprehensive availability information directly on item detail pages.
1010

1111
## Features
1212

1313
- **Multi-region Support** - Check availability across different countries
14-
- **Buy, Rent, Stream** - See all options in one place
15-
- **Provider Logos** - Visual icons for each streaming service
16-
- **Direct Links** - Click to open provider pages
14+
- **Provider Icons** - Visual logos for each streaming service
15+
- **Customizable Filters** - Show or hide specific providers
16+
- **Regex Support** - Advanced filtering with pattern matching
1717
- **TMDB Integration** - Powered by The Movie Database
1818

1919
## Setup
@@ -45,44 +45,65 @@ Jellyfin Elsewhere helps you find where movies and TV shows are available to str
4545

4646
### Default Region
4747

48-
Select the primary region for streaming availability checks.
48+
Select the primary region for streaming availability checks. Empty defaults to US.
4949

50-
**Supported Regions:**
51-
- US - United States
52-
- GB - United Kingdom
53-
- DE - Germany
54-
- FR - France
55-
- ES - Spain
56-
- IT - Italy
57-
- And many more...
50+
**View full list:** [Available Regions](https://cdn.jsdelivr.net/gh/n00bcodr/Jellyfin-Elsewhere/resources/regions.txt)
51+
52+
**Examples:**
53+
- `US` - United States
54+
- `GB` - United Kingdom
55+
- `DE` - Germany
56+
- `FR` - France
57+
- `ES` - Spain
58+
- `IT` - Italy
5859

5960
### Default Providers
6061

61-
Comma-separated list of provider IDs to show by default.
62+
Comma-separated list of streaming provider names to show by default. Leave blank to show all.
63+
64+
**View full list:** [Available Providers](https://cdn.jsdelivr.net/gh/n00bcodr/Jellyfin-Elsewhere/resources/providers.txt)
6265

6366
**Example:**
6467
```
65-
8,9,337,384
68+
Netflix,Hulu,Disney Plus
6669
```
6770

68-
**Common Provider IDs:**
69-
- 8 - Netflix
70-
- 9 - Amazon Prime Video
71-
- 337 - Disney+
72-
- 384 - HBO Max
73-
- 15 - Hulu
74-
- 283 - Crunchyroll
71+
**Common Provider Names:**
72+
- Netflix
73+
- Amazon Prime Video
74+
- Disney Plus
75+
- HBO Max
76+
- Hulu
77+
- Crunchyroll
7578

7679
### Ignore Providers
7780

78-
Comma-separated list of provider IDs to hide from results.
81+
Comma-separated list of provider names to hide from results. **Supports regex patterns** for advanced filtering.
7982

80-
**Example:**
83+
**View full list:** [Available Providers](https://cdn.jsdelivr.net/gh/n00bcodr/Jellyfin-Elsewhere/resources/providers.txt)
84+
85+
**Examples:**
86+
87+
Basic (exact names):
88+
```
89+
Apple TV,Google Play Movies
90+
```
91+
92+
With regex (hide all "with Ads" providers):
8193
```
82-
10,11,12
94+
.*with Ads
8395
```
8496

85-
**Use Case:** Hide providers you don't have access to or aren't interested in.
97+
Multiple patterns:
98+
```
99+
.*with Ads,.*Free,Vudu
100+
```
101+
102+
**Use Cases:**
103+
- Hide providers you don't have access to / or have access to
104+
- Filter out ad-supported tiers
105+
- Remove free streaming options
106+
- Exclude rental/purchase-only services
86107

87108
### Custom Branding
88109

@@ -102,19 +123,12 @@ Comma-separated list of provider IDs to hide from results.
102123
1. Open any movie or TV show detail page
103124
2. Scroll to the "Jellyfin Elsewhere" section
104125
3. View available streaming options
105-
4. Click provider logos to open their pages
106126

107127
### Information Displayed
108128

109-
**For Each Provider:**
110-
- Provider logo and name
111-
- Availability type (Stream, Rent, Buy)
112-
- Direct link to provider page
113-
114-
**Availability Types:**
115-
- **Stream** - Available with subscription
116-
- **Rent** - Available to rent
117-
- **Buy** - Available to purchase
129+
- **Provider icons** - Visual logos of streaming services where content is available
130+
- **Provider names** - Name of each streaming service
131+
- **Multi-region support** - Shows availability across your selected regions
118132

119133
## Troubleshooting
120134

@@ -145,13 +159,6 @@ Comma-separated list of provider IDs to hide from results.
145159
- Verify item has TMDB ID
146160
- Wait and try again later
147161

148-
### Provider Links Not Working
149-
150-
**Check:**
151-
- Provider still operates in your region
152-
- Link format hasn't changed
153-
- Provider requires account/subscription
154-
155162
## Integration with Jellyseerr
156163

157164
Elsewhere can be displayed on Jellyseerr discovery pages.
@@ -184,12 +191,12 @@ Elsewhere can be displayed on Jellyseerr discovery pages.
184191
- Updated regularly by TMDB community
185192
- Accuracy depends on TMDB data quality
186193

194+
## Limitations
187195
## Limitations
188196

189197
- Availability data depends on TMDB accuracy
190198
- Some regions have limited provider data
191199
- Provider availability changes frequently
192-
- Links may become outdated
193200
- Requires internet connection
194201

195202
## Related Features
@@ -207,6 +214,4 @@ If you encounter issues:
207214
3. Check browser console for errors
208215
4. Report issues on [GitHub](https://github.com/n00bcodr/Jellyfin-Enhanced/issues)
209216

210-
---
211-
212-
**Note:** Jellyfin Elsewhere is also available as a [standalone JavaScript](https://github.com/n00bcodr/Jellyfin-Elsewhere) for use without the full plugin.
217+
---

0 commit comments

Comments
 (0)