4 |
--------------------------------------------------------------------------------
/Jellyfin.Plugin.Streamyfin/Pages/Notifications/index.js:
--------------------------------------------------------------------------------
1 | const saveBtn = document.getElementById('save-notification-btn');
2 |
3 | const getValues = () => ({
4 | notifications: Array.from(document.querySelectorAll('[data-key-name][data-prop-name]')).reduce((acc, el) => {
5 | if (el.offsetParent === null) return acc;
6 |
7 | const notification = el.getAttribute('data-key-name');
8 | const property = el.getAttribute('data-prop-name');
9 |
10 |
11 | console.log("Notification", notification, el.offsetParent)
12 |
13 | const value = window.Streamyfin.shared.getElValue(el);
14 | acc[notification] = acc[notification] ?? {}
15 |
16 | if (value != null) {
17 | acc[notification][property] = value;
18 | }
19 | else delete acc[notification]
20 |
21 | return acc
22 | }, {})
23 | })
24 |
25 | // region helpers
26 | const updateNotificationConfig = (name, config, valueName, value) => ({
27 | ...(config ?? {}),
28 | notifications: {
29 | ...(config?.notifications ?? {}),
30 | [name]: {
31 | ...(config?.notifications?.[name] ?? {}),
32 | [valueName]: value,
33 | }
34 | }
35 | })
36 | // endregion helpers
37 |
38 | export default function (view, params) {
39 |
40 | // init code here
41 | view.addEventListener('viewshow', (e) => {
42 | import("/web/configurationpage?name=shared.js").then((shared) => {
43 | shared.setPage("Notifications");
44 |
45 | document.getElementById("notification-endpoint").innerText = shared.NOTIFICATION_URL
46 |
47 | shared.setDomValues(document, shared.getConfig()?.notifications)
48 | shared.setOnConfigUpdatedListener('notifications', (config) => {
49 | console.log("updating dom for notifications")
50 |
51 | const {notifications} = config;
52 | shared.setDomValues(document, notifications);
53 | })
54 |
55 | document.querySelectorAll('[data-key-name][data-prop-name]').forEach(el => {
56 | shared.keyedEventListener(el, 'change', function () {
57 | shared.setConfig(updateNotificationConfig(
58 | el.getAttribute('data-key-name'),
59 | shared.getConfig(),
60 | el.getAttribute('data-prop-name'),
61 | shared.getElValue(el)
62 | ));
63 | })
64 | })
65 |
66 | shared.keyedEventListener(saveBtn, 'click', function (e) {
67 | e.preventDefault();
68 | const config = shared.getConfig();
69 |
70 | shared.setConfig({
71 | ...config,
72 | ...getValues()
73 | });
74 | shared.saveConfig()
75 | })
76 | })
77 | });
78 | }
--------------------------------------------------------------------------------
/Jellyfin.Plugin.Streamyfin/Pages/Other/index.html:
--------------------------------------------------------------------------------
1 |
5 |
113 |
6 |
13 |
14 |
7 |
9 | Streamyfin
8 |
10 |
12 | Notifications
11 |
15 | These are jellyfin events as notifications for your android or ios device.
16 |
17 | If you need more extensibility,
18 | like consuming webhook from an external service,
19 | checkout the more advanced documentation
20 |
22 | NOTIFICATION.md
23 |
24 |
25 | Notification endpoint
26 |
27 |
28 |
108 |
111 |
112 |
4 |
--------------------------------------------------------------------------------
/Jellyfin.Plugin.Streamyfin/Pages/Other/index.js:
--------------------------------------------------------------------------------
1 | const homePage = () => document.getElementById('home-page');
2 | const saveBtn = () => document.getElementById('save-other-btn');
3 |
4 | const getValues = () => ({
5 | other: {
6 | homePage: homePage()?.value
7 | }
8 | })
9 |
10 | export default function (view, params) {
11 |
12 | // init code here
13 | view.addEventListener('viewshow', (e) => {
14 | import("/web/configurationpage?name=shared.js").then((shared) => {
15 | shared.setPage("Other");
16 |
17 | homePage().options.length = 0;
18 | shared.StreamyfinTabs().forEach(tab => homePage().add(new Option(tab.name, tab.resource)))
19 |
20 | homePage().value = shared.getConfig()?.other?.homePage;
21 |
22 | shared.setOnConfigUpdatedListener('other', (config) => {
23 | console.log("updating dom for other")
24 | const {other} = config;
25 |
26 | homePage().value = other.homePage
27 | })
28 |
29 | shared.keyedEventListener(saveBtn(), 'click', function (e) {
30 | e.preventDefault();
31 | const config = shared.getConfig();
32 |
33 | shared.setConfig({
34 | ...config,
35 | ...getValues()
36 | });
37 | shared.saveConfig()
38 | })
39 | })
40 | });
41 | }
--------------------------------------------------------------------------------
/Jellyfin.Plugin.Streamyfin/Pages/YamlEditor/index.html:
--------------------------------------------------------------------------------
1 |
5 |
28 |
6 |
13 |
14 |
7 |
9 | Streamyfin
8 |
10 |
12 | Other
11 |
15 |
21 |
22 |
16 |
17 |
18 |
20 | The plugin page you want to always load first.
19 |
23 |
26 |
27 |
4 |
--------------------------------------------------------------------------------
/Jellyfin.Plugin.Streamyfin/Pages/YamlEditor/index.js:
--------------------------------------------------------------------------------
1 | const yamlEditor = () => document.getElementById('yaml-editor');
2 | const exampleBtn = () => document.getElementById("example-btn")
3 | const saveBtn = () => document.getElementById("save-btn");
4 |
5 | export default function (view, params) {
6 |
7 | // init code here
8 | view.addEventListener('viewshow', (e) => {
9 | import("/web/configurationpage?name=shared.js").then((shared) => {
10 | shared.setPage("Yaml");
11 | return shared;
12 | }).then(async (shared) => {
13 | // Import monaco after shared resources and wait until its done before continuing
14 | if (!window.monaco) {
15 | Dashboard.showLoadingMsg();
16 | await import("/web/configurationpage?name=monaco-editor.bundle.js")
17 | }
18 |
19 | const Page = {
20 | editor: null,
21 | yaml: null,
22 | saveConfig: function (e) {
23 | e.preventDefault();
24 | shared.setYamlConfig(Page.editor.getModel().getValue())
25 | shared.saveConfig()
26 | },
27 | loadConfig: function (config) {
28 | Dashboard.hideLoadingMsg();
29 | const yamlModelUri = monaco.Uri.parse('streamyfin.yaml');
30 |
31 | Page.editor = monaco.editor.create(yamlEditor(), {
32 | automaticLayout: true,
33 | language: 'yaml',
34 | suggest: {
35 | showWords: false
36 | },
37 | model: monaco.editor.createModel(shared.tools.jsYaml.dump(config), 'yaml', yamlModelUri),
38 | });
39 |
40 | Page.editor.onDidChangeModelContent(function (e) {
41 | if (e.eol === '\n' && e.changes[0].text.endsWith(" ")) {
42 | // need timeout so it triggers after auto formatting
43 | setTimeout(() => {
44 | Page.editor.trigger('', 'editor.action.triggerSuggest', {});
45 | }, "100");
46 | }
47 | });
48 |
49 | },
50 | resetConfig: function () {
51 | const example = shared.getDefaultConfig();
52 | Page.editor.getModel().setValue(shared.tools.jsYaml.dump(example));
53 | },
54 | init: function () {
55 | console.log("init");
56 |
57 | // Yaml Editor
58 | monaco.editor.setTheme('vs-dark');
59 |
60 |
61 | Page.yaml = monacoYaml.configureMonacoYaml(monaco, {
62 | enableSchemaRequest: true,
63 | hover: true,
64 | completion: true,
65 | validate: true,
66 | format: true,
67 | titleHidden: true,
68 | schemas: [
69 | {
70 | uri: shared.SCHEMA_URL,
71 | fileMatch: ["**/*"]
72 | },
73 | ],
74 | });
75 |
76 | saveBtn().addEventListener("click", Page.saveConfig);
77 | exampleBtn().addEventListener("click", Page.resetConfig);
78 |
79 | if (shared.getConfig() && Page.editor == null) {
80 | Page.loadConfig(shared.getConfig());
81 | }
82 |
83 | shared.setOnConfigUpdatedListener('yaml-editor', (config) => {
84 | // only set if editor isn't instantiated
85 | if (Page.editor == null) {
86 | console.log("loading")
87 | Page.loadConfig(config)
88 | } else {
89 | Page.editor.getModel().setValue(shared.tools.jsYaml.dump(config))
90 | }
91 | })
92 | }
93 | };
94 |
95 | if (!Page.editor && monaco?.editor?.getModels?.()?.length === 0) {
96 | Page.init();
97 | } else {
98 | console.log("Monaco editor model already exists")
99 | }
100 |
101 | view.addEventListener('viewhide', function (e) {
102 | console.log("Hiding")
103 | Page?.editor?.dispose()
104 | Page?.yaml?.dispose()
105 | Page.editor = undefined;
106 | Page.yaml = undefined;
107 | monaco?.editor?.getModels?.()?.forEach(model => model.dispose())
108 | monaco?.editor?.getEditors?.()?.forEach(editor => editor.dispose());
109 | });
110 | })
111 | });
112 | }
--------------------------------------------------------------------------------
/Jellyfin.Plugin.Streamyfin/Pages/shared.js:
--------------------------------------------------------------------------------
1 | export const SCHEMA_URL = window.ApiClient.getUrl('streamyfin/config/schema');
2 | export const YAML_URL = window.ApiClient.getUrl('streamyfin/config/yaml');
3 | export const DEFAULT_URL = window.ApiClient.getUrl('streamyfin/config/default');
4 | export const NOTIFICATION_URL = window.ApiClient.getUrl('streamyfin/notification');
5 | export const tools = {jsYaml: undefined};
6 |
7 | // region private variables
8 | let schema = undefined;
9 | let config = undefined;
10 | let defaultConfig = undefined;
11 | // endregion private variables
12 |
13 | // region listeners
14 | const registeredEventListeners = {}
15 | const onSchemaLoadedListeners = {};
16 | const onConfigLoadedListeners = {};
17 |
18 | export const setOnSchemaUpdatedListener = (key, listener) => {
19 | onSchemaLoadedListeners[key] = listener;
20 | }
21 |
22 | export const setOnConfigUpdatedListener = (key, listener) => {
23 | onConfigLoadedListeners[key] = listener;
24 | }
25 |
26 | const triggerConfigListeners = (value, raw) => {
27 | Object.values(onConfigLoadedListeners).forEach(listener => listener?.(config, raw));
28 | }
29 | // endregion listeners
30 |
31 | // region getters/setters
32 | export const getJsonSchema = () => schema;
33 | const setSchema = (value) => {
34 | schema = value
35 | Object.values(onSchemaLoadedListeners).forEach(listener => listener?.(schema, value));
36 | }
37 |
38 | export const getDefaultConfig = () => defaultConfig;
39 | export const getConfig = () => config;
40 | export const setConfig = (value) => {
41 | config = value
42 | triggerConfigListeners(config)
43 | }
44 |
45 | export const setYamlConfig = (value) => {
46 | config = tools.jsYaml.load(value)
47 | triggerConfigListeners(config, value)
48 | }
49 | // endregion getters/setters
50 |
51 | // region helpers
52 | export const setPage = (resource) => {
53 | const tabs = StreamyfinTabs();
54 |
55 | const index = tabs.findIndex(tab => tab.resource === resource);
56 |
57 | if (index === -1) {
58 | console.error(`Failed to find tab for ${resource}`);
59 | return;
60 | }
61 |
62 | console.log(`${tabs[index].name} loaded`)
63 |
64 | LibraryMenu.setTabs(tabs[index].resource, index, StreamyfinTabs)
65 | }
66 |
67 | export const saveConfig = () => {
68 | Dashboard.showLoadingMsg();
69 |
70 | if (config) {
71 | //todo: potentially just keep it as json? we only need to convert only for editor reasons
72 | // convert config back to yaml
73 | const data = JSON.stringify({
74 | Value: tools.jsYaml.dump(config),
75 | });
76 |
77 | window.ApiClient.ajax({type: 'POST', url: YAML_URL, data, contentType: 'application/json'})
78 | .then(async (response) => {
79 | const {Error, Message} = await response.json();
80 |
81 | if (Error) {
82 | Dashboard.hideLoadingMsg();
83 | Dashboard.alert(Message);
84 | return;
85 | }
86 |
87 | Dashboard.processPluginConfigurationUpdateResult();
88 | })
89 | .catch((error) => console.error(error))
90 | .finally(Dashboard.hideLoadingMsg);
91 | }
92 |
93 | }
94 |
95 | export const getElValue = (el) => {
96 | const isArray = el.getAttribute('data-is-array') === "true";
97 |
98 | const valueKey = el.type === 'checkbox' ? 'checked' : el.type === 'number' ? 'valueAsNumber' : 'value';
99 | let value = el[valueKey];
100 |
101 | if (isArray && value !== undefined && value !== '') {
102 | value = value.split(',').map(v => v.trim());
103 | }
104 |
105 | if (value === '') {
106 | value = null
107 | }
108 |
109 | if (typeof value === 'number' && isNaN(value)) {
110 | value = null
111 | }
112 |
113 | return value ?? null
114 | }
115 |
116 | export const setDomValues = (dom, obj) => {
117 | dom.querySelectorAll('[data-key-name][data-prop-name]').forEach(el => {
118 | const key = el.getAttribute('data-key-name');
119 | const prop = el.getAttribute('data-prop-name');
120 |
121 | el[el.type === 'checkbox' ? 'checked' : 'value'] = obj?.[key]?.[prop] ?? null;
122 | })
123 | }
124 |
125 | // prevent duplicate listeners from being created everytime a tab is switched
126 | export const keyedEventListener = (el, type, listener) =>{
127 | const elId = el.getAttribute("id");
128 |
129 | if (!registeredEventListeners[elId]) {
130 | registeredEventListeners[elId] = {
131 | type,
132 | listener,
133 | };
134 | el.addEventListener(type, listener);
135 | }
136 | }
137 | // endregion helpers
138 |
139 | export const StreamyfinTabs = () => [
140 | {
141 | href: "configurationpage?name=Application",
142 | resource: "Application",
143 | name: "Application"
144 | },
145 | {
146 | href: "configurationpage?name=Notifications",
147 | resource: "Notifications",
148 | name: "Notifications"
149 | },
150 | {
151 | href: "configurationpage?name=Other",
152 | resource: "Other",
153 | name: "Other"
154 | },
155 | {
156 | href: "configurationpage?name=Yaml",
157 | resource: "Yaml",
158 | name: "Yaml Editor"
159 | },
160 | ];
161 |
162 | // region on Shared init
163 | if (!window.Streamyfin?.shared) {
164 | // import json-yaml library
165 | import("/web/configurationpage?name=js-yaml.js").then((jsYaml) => {
166 | tools.jsYaml = jsYaml;
167 |
168 | //fetch default configuration
169 | window.ApiClient.ajax({type: 'GET', url: DEFAULT_URL, contentType: 'application/json'})
170 | .then(async function (response) {
171 | const {Value} = await response.json();
172 | defaultConfig = jsYaml.load(Value)
173 | })
174 | .catch((error) => console.error(error))
175 |
176 | // fetch schema
177 | // We want to define any pages first before setting any values
178 | fetch(SCHEMA_URL)
179 | .then(async (response) => setSchema(await response.json()))
180 | .then(() => {
181 |
182 | // fetch configuration
183 | window.ApiClient.ajax({type: 'GET', url: YAML_URL, contentType: 'application/json'})
184 | .then(async function (response) {
185 | const {Value} = await response.json();
186 | setYamlConfig(Value)
187 | })
188 | .catch((error) => console.error(error))
189 | });
190 | })
191 |
192 | // For developers when reviewing in console
193 | window.Streamyfin = {
194 | shared: {
195 | setOnSchemaUpdatedListener,
196 | setOnConfigUpdatedListener,
197 | setYamlConfig,
198 | setPage,
199 | saveConfig,
200 | getJsonSchema,
201 | getDefaultConfig,
202 | getConfig,
203 | setConfig,
204 | StreamyfinTabs,
205 | registeredEventListeners,
206 | keyedEventListener,
207 | getElValue,
208 | setDomValues,
209 | SCHEMA_URL,
210 | YAML_URL,
211 | DEFAULT_URL,
212 | NOTIFICATION_URL,
213 | tools
214 | }
215 | }
216 | }
217 | // endregion on Shared init
218 |
--------------------------------------------------------------------------------
/Jellyfin.Plugin.Streamyfin/Plugin.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using System.Collections.Generic;
3 | using System.Linq;
4 | using Jellyfin.Plugin.Streamyfin.Configuration;
5 | using Jellyfin.Plugin.Streamyfin.Storage;
6 | using MediaBrowser.Common.Configuration;
7 | using MediaBrowser.Common.Plugins;
8 | using MediaBrowser.Model.Plugins;
9 | using MediaBrowser.Model.Serialization;
10 |
11 | namespace Jellyfin.Plugin.Streamyfin;
12 |
13 | ///
5 |
39 |
6 |
30 |
31 |
7 |
9 | Streamyfin
8 |
11 |
29 | Yaml Editor
12 |
13 |
15 |
16 | Help
17 |
18 |
20 |
21 | Examples
22 |
23 |
27 |
28 |
32 |
38 |
33 |
34 |
37 | 32 | value: `application/json` 33 | 34 | key: `Authorization`
35 | value: `MediaBrowser Token="{apiKey}"` 36 | 37 | **You can generate a jellyfin API Key by going to** 38 | `Dashboard -> Advanced (bottom left) -> API Keys -> Click on (+) to genreate a key` 39 | 40 | ## Template 41 | ```json 42 | [ 43 | { 44 | "title": "string", // Notification title (required) 45 | "subtitle": "string", // Notification subtitle (Visible only to iOS users) 46 | "body": "string", // Notification body (required) 47 | "userId": "string", // Target jellyfin user id this notification is for 48 | "username": "string", // Target jellyfin username this notification is for 49 | "isAdmin": false // Boolean to determine if notification also targets admins. 50 | } 51 | ] 52 | ``` 53 | 54 | ## Notifying all users 55 | To do this all you have to do is populate title & body! Other fields are not required! 56 | 57 | --- 58 | 59 | # Examples 60 | 61 | ## Jellyfin 62 | You can use the [jellyfin-webhook-plugin](https://github.com/jellyfin/jellyfin-plugin-webhook) to create a notification based on any event they offer. 63 | 64 | - Visit the webhooks config page 65 | - Click "Add Generic Destination" 66 | - Webhook Url should be the url example from above 67 | - Selected notification type 68 | 69 | If we don't directly support an event you'll want to create a separate webhook destination for each event so we can avoid filtering on our end. 70 | 71 | **We are currently looking into supporting as many of the jellyfin events so that you don't have to worry about configuring them!** 72 | 73 | ### examples 74 | 75 | - [Item Added](#item-added-notification) 76 | - We currently support this on our end with the enhancement of: 77 | - reducing spam when multiple episodes are added for a season in a short period of time. 78 | - deep link into item page to start playing item from notification 79 | 80 | 81 | ### Item added notification 82 | - Select event "Item Added" 83 | - Paste in template below 84 | 85 | ```json 86 | [ 87 | { 88 | {{#if_equals ItemType 'Movie'}} 89 | "title": "{{{Name}}} ({{Year}}) added", 90 | "body": "Watch movie now" 91 | {{/if_equals}} 92 | {{#if_equals ItemType 'Season'}} 93 | "title": "{{{SeriesName}}} season added", 94 | "body": "Watch season '{{{Name}}}' now" 95 | {{/if_equals}} 96 | {{#if_equals ItemType 'Episode'}} 97 | "title": "{{{SeriesName}}} S{{SeasonNumber00}}E{{EpisodeNumber00}} added", 98 | "body": "Watch episode '{{{Name}}}' now" 99 | {{/if_equals}} 100 | } 101 | ] 102 | ``` 103 | 104 | --- 105 | 106 | ## Jellyseerr 107 | 108 | You can go to your jellyseerr instances notification settings to forward events 109 | 110 | - Go to Settings > Notifications > Webhook 111 | - Check "Enable Agent" 112 | - Enter notification endpoint as "Webhook URL" 113 | - Copy an example below 114 | 115 | [Template variable help](https://docs.overseerr.dev/using-overseerr/notifications/webhooks#template-variables) 116 | 117 | 118 | ## Issues notification 119 | 120 | - Copy json below and paste in as JSON Payload 121 | - Select Notification Types 122 | - Issue Reported 123 | - Issue Commented 124 | - Issue Resolved 125 | - Issue Reopened 126 | 127 | ```json 128 | [ 129 | { 130 | "title": "{{event}}", 131 | "body": "{{subject}}: {{message}}", 132 | "isAdmin": true 133 | }, 134 | { 135 | "title": "{{event}} - {{subject}}", 136 | "body": "{{commentedBy_username}}: {{comment_message}}", 137 | "isAdmin": true 138 | } 139 | ] 140 | ``` 141 | 142 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 |
3 |
12 |
13 |
14 | Features
15 | ------
16 |
17 | With this plugin you allow the streamyfin application to do the following for all your users...
18 |
19 | Companion plugin for Streamyfin
4 | 5 |
6 | Allows for a centralised configuration of the Streamyfin application.
7 |
8 | Configure and synchronize the apps settings or notifications!
9 |
| Automatically log in users into jellyseerr | 22 |Custom Home screen using collections | 23 |Notification support | 24 | 25 | 26 |
|---|---|---|
 |
28 |  |
29 |  |
30 |
Plus many more features!
35 | 36 | 37 | Install Process 38 | ------ 39 | 40 | 1. In jellyfin, go to dashboard -> plugins -> repositories -> copy and paste this link: https://raw.githubusercontent.com/streamyfin/jellyfin-plugin-streamyfin/main/manifest.json 41 | 2. Go to Catalog and search for Streamyfin 42 | 3. Click on it and install 43 | 4. Restart Jellyfin 44 | 45 | 46 | More information 47 | ------ 48 | 49 | ### Automatically log into jellyseerr 50 | 51 | We currently offer the ability to log in your users into jellyseerr for a seamless jellyseerr integration.52 | Currently this is only supported if you use Jellyfin authentication to log into your jellyseerr instance. 53 | 54 | 55 | ### Customize home screen 56 | 57 | You are able to further customize your home screen beyond jellyfins current limits. 58 | This can be done alongside using the [collection import](https://github.com/lostb1t/jellyfin-plugin-collection-import) plugin, one can make very dynamic homescreens. 59 | 60 | Be inspired to create home screens by adding views for collections like 61 | `Trending`, `Popular`, `Most viewed`, etc.
62 | Just like you would see from major streaming applications like netflix! 63 | 64 | ### Notifications 65 | 66 | We're currently working hard to offer some of jellyfins events as notifications when you use streamyfin.
67 | Some notifications that work out the box with almost no configuration are: 68 | 69 | - `Item Added` tells you when new content is added to your server. This also summarizes the total episodes being added for a series season. This reduces the amount of notification spam. 70 | - `Session Started` allows you to see when your users are online in jellyfin 71 | - `Playback started` allows you to see when content is being played from your server 72 | - `User locked out` allows you to see when a user has been locked out from their account so you can be proactive on resetting if required. 73 | 74 | And if thats not enough we also offer a notification end point that you can use to utilize with any other service! 75 | 76 | [Read more about notifications](NOTIFICATIONS.md) 77 | 78 | ### Using the plugin configuration page 79 | 80 | We offer the ability to modify the configuration via yaml or by normal form. 81 | 82 | See [yaml examples](https://github.com/streamyfin/jellyfin-plugin-streamyfin/tree/main/examples) -------------------------------------------------------------------------------- /assets/home.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/streamyfin/jellyfin-plugin-streamyfin/10fece54dfe87c8be7164d172f8668a5b0b6a534/assets/home.jpg -------------------------------------------------------------------------------- /assets/jellyseerr.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/streamyfin/jellyfin-plugin-streamyfin/10fece54dfe87c8be7164d172f8668a5b0b6a534/assets/jellyseerr.png -------------------------------------------------------------------------------- /assets/notifications.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/streamyfin/jellyfin-plugin-streamyfin/10fece54dfe87c8be7164d172f8668a5b0b6a534/assets/notifications.png -------------------------------------------------------------------------------- /examples/full.yml: -------------------------------------------------------------------------------- 1 | # You can remove any settings you do not need configured. 2 | 3 | # Format Example 4 | # settingName: 5 | # locked: true | false # if true, locks the setting from modification in app. Default false. 6 | # value: value # Value you want the setting to be. Editor will give you type suggestion for a specific setting. 7 | 8 | # Example below shows all supported settings at this time. 9 | settings: 10 | # Media Controls 11 | forwardSkipTime: 12 | rewindSkipTime: 13 | 14 | # Audio Controls 15 | rememberAudioSelections: 16 | 17 | # Subtitles 18 | subtitleMode: 19 | rememberSubtitleSelections: 20 | subtitleSize: 21 | 22 | # Other 23 | autoRotate: 24 | defaultVideoOrientation: 25 | safeAreaInControlsEnabled: 26 | showCustomMenuLinks: 27 | hiddenLibraries: 28 | disableHapticFeedback: 29 | 30 | # Downloads 31 | downloadMethod: 32 | remuxConcurrentLimit: 33 | autoDownload: 34 | optimizedVersionsServerUrl: 35 | 36 | # Jellyseerr 37 | jellyseerrServerUrl: 38 | 39 | # Search 40 | searchEngine: 41 | marlinServerUrl: 42 | 43 | # Popular Lists 44 | usePopularPlugin: 45 | mediaListCollectionIds: 46 | 47 | # misc 48 | libraryOptions: 49 | locked: false 50 | value: 51 | display: list | row 52 | cardStyle: detailed | compact 53 | imageStyle: cover | poster 54 | showTitles: boolean 55 | showStats: boolean 56 | 57 | # Home 58 | home: 59 | locked: true 60 | value: 61 | sections: 62 | - title: Continue Watching 63 | orientation: vertical 64 | items: 65 | filters: 66 | - IsResumable 67 | includeItemTypes: 68 | - Episode 69 | - Movie 70 | limit: 25 71 | - title: Nextup 72 | orientation: horizontal 73 | nextUp: 74 | limit: 25 75 | - title: Recently Added 76 | orientation: vertical 77 | items: 78 | sortBy: 79 | - DateCreated 80 | sortOrder: 81 | - Descending 82 | includeItemTypes: 83 | - Series 84 | - Movie 85 | limit: 25 86 | # latest is can group episodes. Which items cannot do. 87 | - title: Latest 88 | orientation: horizontal 89 | latest: 90 | limit: 25 91 | - title: Favorites 92 | orientation: vertical 93 | items: 94 | sortBy: 95 | - Default 96 | sortOrder: 97 | - Ascending 98 | filters: 99 | - IsFavorite 100 | includeItemTypes: 101 | - Series 102 | - Movie 103 | limit: 25 104 | # It's possible to filter by collection. 105 | # Checkout https://github.com/lostb1t/jellyfin-plugin-collection-import to create collections from external lists 106 | - title: My collection 107 | items: 108 | # parentID is the collection id. You can find it in the url on the web collection page 109 | parentId: ab7b2bcacafa97a2ad7d72d86eb1b408 110 | includeItemTypes: 111 | - Movie 112 | - Series 113 | -------------------------------------------------------------------------------- /jellyfin.ruleset: -------------------------------------------------------------------------------- 1 | 2 |