From 048b8f03851a4e849996b2cda9c589858ba0d260 Mon Sep 17 00:00:00 2001 From: nitschis <62210453+nitschis@users.noreply.github.com> Date: Wed, 15 Jun 2022 06:04:00 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 48 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 47 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f392055..e70943b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,52 @@ # JellyCon -JellyCon is a lightweight Kodi addon that lets you browse and play media files from your Jellyfin server directly within the Kodi interface. +JellyCon is a lightweight Kodi add-on that lets you browse and play media files from your Jellyfin server directly within the Kodi interface. Think of it as a Think client, compared to Jellyfin for Kodi, which integrates into Kodi itself. + + +JellyCon behaves more like a standard Kodi streaming add-on. Media is accessed primarily by going through the Add-ons -> JellyCon menu, however depending on what skin is being used custom shortcuts and widgets can be added to the home menu. It also allows easier switching between multiple Jellyfin servers or users since it doesn't have to rely on syncing all the metadata down. By not having metadata synced, it has to request info from the server which can take a bit more time when you're browsing, but you don't have to wait for the database to sync or keep it up to date. It's also compatible with other media sources and can be used with other add-ons without issue. + + + +## Installation + +#### 1. Adding the Jellyfin repository +https://jellyfin.org/docs/general/clients/kodi.html#install-add-on-repository + +#### 2. Install JellyCon Add-on + +- From within Kodi, navigate to "Add-on Browser" +- Select "Install from Repository" +- Choose "Kodi Jellyfin Add-ons", followed by "Video Add-ons" +- Select the JellyCon add-on and choose install + +#### 3. Login + +- Within a few seconds after the installation you should be prompted for your server details. +- If a Jellyfin server is detected on your local network, it will displayed in a dialog. Otherwise, you will be prompted for a URL +- Select a user from the list, or Manual Login to type in a username/password + + + +## Configuration + +#### Configuring Home + +Many Kodi skins allow for customizing of the home menu with custom nodes and widgets. However, all of these use slightly different layouts and terminology. Rather than a step by step guide, this section serves as an barebones introduction to customizing a skin. +Examples + +If you would like a link on the home screen to open a library in your Jellyfin server called "Kid's Movies", you would point the menu item to the path: Add-On -> Video Add-On -> JellyCon -> Jellyfin Libraries -> Kid's Movies -> Create menu item to here. + +Beyond just modifying where the home menu headers go, many skins also allow you to use widgets. Widgets help populate the home screen with data, often the posters of media in the selected image. If you would like to display the most recent movies across all of your Jellyfin libraries on the home screen, the path would be: Add-On -> Video Add-On -> JellyCon -> Global Lists -> Movies -> Movies - Recently Added (20) -> Use as widget + +Another common use case of widgets would be to display the next available episodes of shows that you may be watching. As above, this can be done both with individual libraries or with all libraries combined: + + Add-On -> Video Add-On -> JellyCon -> Jellyfin Libraries -> Anime -> Anime - Next Up (20) -> Use as widget + Add-On -> Video Add-On -> JellyCon -> Global Lists -> TV Shows -> TV Shows - Next Up (20) -> Use as widget + + + + + ## License From cce9acb182152e9b871fb7ec01a4a736320fdf4a Mon Sep 17 00:00:00 2001 From: nitschis <62210453+nitschis@users.noreply.github.com> Date: Wed, 15 Jun 2022 23:01:17 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index e70943b..3e2e33a 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,14 @@ # JellyCon -JellyCon is a lightweight Kodi add-on that lets you browse and play media files from your Jellyfin server directly within the Kodi interface. Think of it as a Think client, compared to Jellyfin for Kodi, which integrates into Kodi itself. - - -JellyCon behaves more like a standard Kodi streaming add-on. Media is accessed primarily by going through the Add-ons -> JellyCon menu, however depending on what skin is being used custom shortcuts and widgets can be added to the home menu. It also allows easier switching between multiple Jellyfin servers or users since it doesn't have to rely on syncing all the metadata down. By not having metadata synced, it has to request info from the server which can take a bit more time when you're browsing, but you don't have to wait for the database to sync or keep it up to date. It's also compatible with other media sources and can be used with other add-ons without issue. +JellyCon is a lightweight Kodi add-on that lets you browse and play media files directly from your Jellyfin server within the Kodi interface. Think of it as a Thin client, compared to Jellyfin for Kodi, which integrates into Kodi itself. +JellyCon compared to the Jellyfin add-on, behaves more like a standard Kodi streaming add-on. Media is accessed primarily by going through the Add-ons -> JellyCon menu, however depending on what skin is being used custom shortcuts and widgets can be added to the home menu. It also allows easier switching between multiple Jellyfin servers or users since it doesn't have to rely on syncing all the metadata down. By not having metadata synced, it has to request info from the server which can take a bit more time when you're browsing, but you don't have to wait for the database to sync or keep it up to date. It's also compatible with other media sources and can be used with other add-ons without issue. ## Installation #### 1. Adding the Jellyfin repository + https://jellyfin.org/docs/general/clients/kodi.html#install-add-on-repository #### 2. Install JellyCon Add-on @@ -22,9 +21,9 @@ https://jellyfin.org/docs/general/clients/kodi.html#install-add-on-repository #### 3. Login - Within a few seconds after the installation you should be prompted for your server details. -- If a Jellyfin server is detected on your local network, it will displayed in a dialog. Otherwise, you will be prompted for a URL -- Select a user from the list, or Manual Login to type in a username/password - +- If a Jellyfin server is detected on your local network, it will displayed in a dialog. Otherwise, you will be prompted to enter the URL of your Jellyfin server +- A "Quick Connect" code will be displayed. Which can be used to Login without the need of credentials, once you enter it on your Jellyfin server under "User Settings" -> "Quick Connect" +- Alternatively you can select "Manual Login" to select a user from the list, or Manual Login using your username and password ## Configuration @@ -44,10 +43,6 @@ Another common use case of widgets would be to display the next available episod Add-On -> Video Add-On -> JellyCon -> Global Lists -> TV Shows -> TV Shows - Next Up (20) -> Use as widget - - - - ## License JellyCon is licensed under the terms of the [GPLv2](LICENSE.txt). From 32288aba9762770b0f23d6bd4432ebd23ad40862 Mon Sep 17 00:00:00 2001 From: mcarlton00 Date: Fri, 17 Jun 2022 19:03:32 -0400 Subject: [PATCH 3/3] Apply suggestions from code review --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3e2e33a..3479cfb 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # JellyCon -JellyCon is a lightweight Kodi add-on that lets you browse and play media files directly from your Jellyfin server within the Kodi interface. Think of it as a Thin client, compared to Jellyfin for Kodi, which integrates into Kodi itself. +JellyCon is a lightweight Kodi add-on that lets you browse and play media files directly from your Jellyfin server within the Kodi interface. It can be thought of as a thin frontend for a Jellyfin server. -JellyCon compared to the Jellyfin add-on, behaves more like a standard Kodi streaming add-on. Media is accessed primarily by going through the Add-ons -> JellyCon menu, however depending on what skin is being used custom shortcuts and widgets can be added to the home menu. It also allows easier switching between multiple Jellyfin servers or users since it doesn't have to rely on syncing all the metadata down. By not having metadata synced, it has to request info from the server which can take a bit more time when you're browsing, but you don't have to wait for the database to sync or keep it up to date. It's also compatible with other media sources and can be used with other add-ons without issue. +JellyCon can be used with Movie, TV Show, Music Video, and Music libraries, in addition to viewing LiveTV from the server. It can easily switch between multiple user accounts at will. It's easy to integrate with any customizable Kodi skin with a large collection of custom menus. Media items are populated from the server dynamically, and menu speed will vary based on local device speed. ## Installation @@ -22,8 +22,8 @@ https://jellyfin.org/docs/general/clients/kodi.html#install-add-on-repository - Within a few seconds after the installation you should be prompted for your server details. - If a Jellyfin server is detected on your local network, it will displayed in a dialog. Otherwise, you will be prompted to enter the URL of your Jellyfin server -- A "Quick Connect" code will be displayed. Which can be used to Login without the need of credentials, once you enter it on your Jellyfin server under "User Settings" -> "Quick Connect" -- Alternatively you can select "Manual Login" to select a user from the list, or Manual Login using your username and password +- If Quick Connect is enabled in the server, a code will be displayed that you can use to log in via Quick Connect in the web UI or a mobile app. +- If Quick Connect is not enabled, or if you select the "Manual Login" button, you will be able to select a user from the list, or manually login using your username and password. ## Configuration