Skip to content

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

1 watching

Forks

Repository files navigation

Jellyfin Plugin Wholphin

A Jellyfin server plugin that supports the Wholphin Android TV app and provides advanced UI customization options.

Important

This plugin is currenlty only usable with a custom forkof Wholphin!

Features

🎨 Login Screen Customization

  • Customizable background images for the login screen
  • Adjustable transparency (alpha) of the background image
  • Configurable blur effects

🏠 Home Screen Configuration

Flexible home screen configuration with various section types:

  • Resume: Continue watching content in progress
  • NextUp: Next episodes in series
  • Latest: Recently added content
  • Items: Custom item queries
  • Custom: Custom plugin endpoints

Push settings to Wholphin app

Currenlty only pushing the Seerr URL is supported, more settings will follow soon.

Installation

Via Plugin Repository (Recommended)

  1. Open your Jellyfin server dashboard
  2. Navigate to Dashboard → Plugins → Repositories
  3. Click the + button to add a new repository
  4. Enter the following details:
    • Repository Name: Wholphin Plugin
    • Repository URL: https://raw.githubusercontent.com/kamilkosek/jellyfin-plugin-wholphin/main/manifest.json
  5. Click Save
  6. Go to Catalog tab
  7. Find Wholphin in the plugin list and click Install
  8. Restart your Jellyfin server when prompted

Manual Installation

  1. Download the latest Jellyfin.Plugin.Wholphin.dll from Releases
  2. Copy the DLL to your Jellyfin plugin directory:
    • Linux: /var/lib/jellyfin/plugins/Wholphin/
    • Windows: C:\ProgramData\Jellyfin\Server\plugins\Wholphin\
    • macOS: /var/lib/jellyfin/plugins/Wholphin/
  3. Restart your Jellyfin server

Usage

See usage

API Endpoints

This plugin provides the following API endpoints:

GET /wholphin/loginbackground

Retrieves the login background configuration (no authentication required).

Response:

{
  "backgroundUrl": "https://example.com/image.jpg",
  "alpha": 0.2,
  "blur": 1.0
}

GET /wholphin/settings

Retrieves plugin settings (authentication required). Currently only pushing the Seerr URL is supported, more to follow soon.

Response:

{
  "seerrUrl": "https://seerr.example.com"
}

GET /wholphin/home

Retrieves home screen configuration (authentication required).

Response:

{
  "sections": [
    {
      "id": "resume",
      "title": "Continue Watching",
      "type": "Resume",
      "limit": 20
    },
    {
      "id": "nextup",
      "title": "Next Up",
      "type": "NextUp",
      "limit": 20
    }
  ]
}

Configuration

The plugin can be configured through the Jellyfin admin interface:

  1. Navigate to Dashboard → Plugins → Wholphin
  2. Configure the desired settings:
    • Login Background Image URL: URL to the background image
    • Login Background Alpha: Transparency (0.0 - 1.0)
    • Login Background Blur: Blur strength in dp
    • Seerr URL: URL to your Seerr instance
    • Home Configuration: JSON configuration for home screen sections

Development

Prerequisites

  • .NET 8.0 SDK
  • Jellyfin 10.9.0 or higher

Build

# Using dotnet
dotnet build

# Using Make
make build

# Or build + deploy
make build-and-copy

Project Structure

Jellyfin.Plugin.Wholphin/
├── Api/                        # API Controllers
│   └── WholphinPluginController.cs
├── Configuration/              # Plugin configuration
│   ├── configPage.html        # Admin UI
│   └── PluginConfiguration.cs
├── Models/                     # Data models
│   ├── HomeConfiguration.cs
│   ├── HomeSection.cs
│   ├── HomeSectionQuery.cs
│   └── HomeSectionType.cs
├── Plugin.cs                   # Main plugin class
└── ServiceRegistration.cs     # Dependency injection

Tasks

The project includes predefined VS Code tasks:

  • build: Compiles the plugin
  • deploy-remote: Deploys the plugin to a remote server
  • build-and-copy: Build + deploy in one step

License

See LICENSE file for details.

Author

Kamil Kosek (@kamilkosek)

Links

Changelog

See GitHub Releases for a complete changelog.

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages