diff --git a/README.md b/README.md index 6045082..0e18930 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,25 @@
- Your project logo + KefinTweaks
-
- +

+Jellyfin Latest Version +Jellyfin Latest Version +Jellyfin Version 10.10.7 +

JS Delivr hits -Jellyfin Latest Version -Jellyfin Version 10.10.7

-

Jellyfin Community Discord KefinTweaks Channel

+KefinTweaks Devices Mockup +

+Windows IconmacOS IconiOS IconAndroid IconBrowser IconLG WebOS IconXbox Icon +

+
**KefinTweaks is a comprehensive collection of enhancements and customizations for Jellyfin, focused on, but not limited to, filling gaps in functionality based on the community's most desired [Feature Requests](https://features.jellyfin.org/?view=most-wanted). This includes things like a [Watchlist](#watchlist), a [customizable Home Screen](#enhanced-home-screen), an [improved search experience](#enhanced-search), and an [Appearance Manager](#skin-manager)**. @@ -89,10 +94,9 @@ Note: The Slideshow at the top of the Home Screen in the video below is from the ### Prerequisites -- Jellyfin 10.10.7 or earlier (10.11.X is untested and "unsupported" but may be mostly functional) +- Jellyfin 12, 11 or 10 - [JS Injector](https://github.com/n00bcodr/Jellyfin-JavaScript-Injector) plugin installed and configured - [File Transformation Plugin](https://github.com/IAmParadox27/jellyfin-plugin-file-transformation) plugin is recommended to avoid file permission issues when injecting scripts with JS Injector -- Only required for Watchlist: [Custom Tabs](https://github.com/IAmParadox27/jellyfin-plugin-custom-tabs) plugin ### Setup Instructions @@ -107,7 +111,7 @@ script.async = true; document.head.appendChild(script); ``` -If you are hosting the script yourself, replace the `https://cdn.jsdelivr.net/gh/ranaldsgift/KefinTweaks@latest/` with your hosted location + `/KefinTweaks/`. You should be able to include the scripts in your jelly-web folder and access it from `/web/KefinTweaks` if you like. +If you are hosting the script yourself, replace the `https://cdn.jsdelivr.net/gh/ranaldsgift/KefinTweaks@latest/` with your hosted location + `/KefinTweaks/`. You should be able to include the scripts in your jellyfin-web folder and access it from `/web/KefinTweaks` if you like. 3. **Navigate to the Plugins page and click on KefinTweaks** 4. **Choose your preferred plugin version, or specify a custom source if you are self hosting the scripts** @@ -478,56 +482,8 @@ This shows an "Included In" section on the Item Details page which displays any - **Ratings and Comments**: Coming soon...requires the [Updoot](https://github.com/BobHasNoSoul/jellyfin-updoot) backend script -
-## Script Details - -### Dependency Scripts - -| Script | Description | -| ---------------------- | ----------------------------------------------------------------------- | -| `utils.js` | Page view management and common utilities | -| `skinConfig.js` | Default skin configuration for KefinTweaks | -| `apiHelper.js` | API helper functions for common Jellyfin operations | -| `cardBuilder.js` | Core card building functionality (required by other scripts) | -| `localStorageCache.js` | localStorage-based caching layer with 24-hour TTL and manual refresh | -| `indexedDBCache.js` | IndexedDB-based caching layer for large datasets with TTL support | -| `modal.js` | Generic modal system for Jellyfin-style dialogs | -| `toaster.js` | Toast notification system using Jellyfin's existing toast functionality | - -### Feature Scripts - -| Script | Description | Dependencies | -| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | -| `skinManager.js` | Skin selection and management (loads with priority) | `utils`, `skinConfigLegacyDefaults`, `skinConfig`, `modal` | -| `watchlist.js` | Adds watchlist functionality throughout Jellyfin interface | `cardBuilder`, `localStorageCache`, `modal`, `utils` | -| `homeScreen.js` | Adds custom home screen sections | `cardBuilder`, `localStorageCache`, `utils` | -| `search.js` | Enhanced search functionality | `cardBuilder`, `utils` | -| `headerTabs.js` | Header tab improvements | None | -| `customMenuLinks.js` | Load and add custom menu links from configuration | `utils` | -| `exclusiveElsewhere.js` | Modifies the behavior of the Jellyfin Enhanced Elsewhere functionality to add custom branding when items are not available on streaming services | None | -| `updoot.js` | Upvote functionality provided by https://github.com/BobHasNoSoul/jellyfin-updoot | None | -| `backdropLeakFix.js` | Fixes issue that causes backdrop images to be continuously added to the page if the tab isn't focused | None | -| `dashboardButtonFix.js` | Fixes the dashboard button to redirect to the home page when the back button is clicked and there is no history to go back to | None | -| `infiniteScroll.js` | Adds infinite scroll functionality to media library pages | `cardBuilder` | -| `removeContinue.js` | Adds remove from continue watching functionality to cards with data-position-ticks | None | -| `subtitleSearch.js` | Adds subtitle search functionality to the video OSD, allowing users to search and download subtitles from remote sources | `toaster` | -| `breadcrumbs.js` | Adds breadcrumb navigation to item detail pages for Movies, Series, Seasons, Episodes, Music Artists, and Music Albums | `utils` | -| `playlist.js` | Modifies playlist view page behavior to navigate to item details instead of playing, adds play button to playlist items, and adds sorting functionality | `cardBuilder`, `utils`, `modal` | -| `itemDetailsCollections.js` | Adds related collections to item details pages showing which collections contain the current item | `indexedDBCache`, `utils`, `cardBuilder` | -| `seriesEpisodes.js` | Displays episodes directly on series page with season selection. Works for both single and multi-season shows when enabled. | `cardBuilder`, `utils` | -| `seriesInfo.js` | Adds series and season information (seasons count, episodes count, end time) to details pages | `utils` | -| `collections.js` | Adds sorting functionality to collection pages | `utils`, `modal` | - -
- -### Auto-Inject Dependencies - -KefinTweaks automatically enables required dependencies when you enable a script that needs them. For example: - -- Enabling `watchlist` automatically enables `cardBuilder`, `localStorageCache`, `modal`, and `utils` - -This ensures all scripts have their required dependencies without manual configuration. +
### Info for Developers @@ -556,7 +512,7 @@ Here is a list of known supported clients: - [Jellyfin for Android](https://github.com/jellyfin/jellyfin-android) - [Jellyfin for iOS](https://github.com/jellyfin/jellyfin-ios) - [Jellyfin for WebOS](https://github.com/jellyfin/jellyfin-webos) -- [Jellyfin for Tizen](https://github.com/jellyfin/jellyfin-tizen) +- [Jellyfin for Tizen](https://github.com/jellyfin/jellyfin-tizen)* (maybe) These third party clients support the same Watchlist as KefinTweaks: