Skip to content

Moonfin-Client/Plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

193 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Moonbase, the server plugin for Moonfin!

Moonbase is the server plugin that powers the Moonfin experience on both Jellyfin and Emby.


Moonbase

License Release

What is Moonbase?

Moonbase is a server plugin for Jellyfin and Emby that provides the shared backbone for every Moonfin client. It syncs your settings across devices, hosts the Moonfin web app right on your server, serves media bar and home screen data, adds extra rating sources, connects your library to Seerr, and gives admins a set of server-wide defaults and tools. This repo ships two plugins from one place: a Jellyfin plugin under Jellyfin/ and an Emby plugin under Emby/.

Recommended: If you use any Moonfin client, install Moonbase on your server for the best experience.

Opening the Moonfin Web App

Moonbase serves the Moonfin web app at /Moonfin/Web/, so you can open and bookmark it directly:

https://your-server-host/Moonfin/Web/

On Jellyfin, you can optionally add a one-click Moonfin button to the stock web header (next to SyncPlay) by installing the File Transformation plugin. On Emby, the web app is served the same way at /Moonfin/Web/, but there is no header button because Emby has no equivalent injection path.

Moonfin header button

Not loading after a fresh install? Run the Moonfin Startup task once (Dashboard, Scheduled Tasks), then refresh your browser.

Features

  • Cross-device settings sync so your preferences follow you between web, TV, mobile, and desktop, with an optional per-device profile for desktop, mobile, and TV.
  • The Moonfin web app hosted at /Moonfin/Web/, running side by side with the stock web interface.
  • Media bar and home screen data resolved on the server and shared across clients.
  • Extra rating sources through MDBList and TMDB, with the API keys kept on the server.
  • Seerr integration with a built-in proxy, single sign-on, and optional request and issue notifications.
  • Admin tools for setting server-wide defaults, pushing them to existing users, and broadcasting messages to everyone at once.
  • Custom themes with a built-in editor, plus server-side upload and validation.
  • Retro games support for browsing and playing game libraries in the browser. See Retro Games.
  • Custom rows built from MDBList and IMDb lists, cached on the server.
  • Active downloads dashboard with live transcode metrics in the admin panel.

Installation

Jellyfin

Plugin repository (recommended)

  1. Jellyfin Dashboard, Administration, Plugins, Repositories
  2. Add a repository:
    • Name: Moonfin
    • URL: https://raw.githubusercontent.com/Moonfin-Client/Plugin/refs/heads/master/manifest.json
  3. Go to Catalog, find Moonfin, and install it
  4. Restart Jellyfin

Manual install

  1. Download the latest Moonfin.Server-x.x.x.x.zip from Releases
  2. Extract it into your Jellyfin plugins folder:
    Platform Path
    Linux /var/lib/jellyfin/plugins/Moonfin/
    Docker /config/plugins/Moonfin/
    Windows %ProgramData%\Jellyfin\Server\plugins\Moonfin\
  3. Restart Jellyfin

Optional one-click header button: add the File Transformation plugin repository (https://www.iamparadox.dev/jellyfin/plugins/manifest.json), install File Transformation from the catalog, restart Jellyfin, then force refresh your browser. To hide the button while keeping the plugin, add this to Branding, Custom CSS:

.headerMoonfinButton { display: none !important; }

Emby

The Emby plugin is a drop-in zip, not a catalog plugin.

  1. Download the latest Emby.Plugins.Moonfin-x.x.x.x.zip from Releases
  2. Extract its contents (Emby.Plugins.Moonfin.dll, SharpCompress.dll, and the web folder) into your Emby plugins folder:
    Platform Path
    Linux /var/lib/emby/plugins/
    Docker /config/plugins/
    Windows %AppData%\Emby-Server\programdata\plugins\
  3. Restart Emby

Configuration

Open your server dashboard, go to Plugins, and select Moonbase to configure things like:

  • Your Seerr URL and whether Seerr is enabled
  • Shared MDBList and TMDB API keys, so individual users do not need their own
  • Default user settings that new users inherit, with a button to push them to existing users
  • A broadcast message to announce something to everyone at once
  • Web startup options and custom theme uploads

Users change their own preferences from the in-app settings page in any Moonfin client. Settings are stored per user and shared across clients, with an optional per-device override for desktop, mobile, and TV.

Documentation

The deeper reference material lives in the Wiki:

Page What it covers
API Reference Every plugin endpoint, with methods, auth, and the Seerr config response
Settings Sync How sync works, the settings envelope, and the full list of synced settings
Retro Games Game libraries, cores, ROMs, BIOS, saves, and in-browser play
Themes The theme editor and custom theme uploads
Reverse Proxy and Seerr Path forwarding and Seerr single sign-on behind a proxy
Building from Source Building the Jellyfin and Emby plugins from this repo

Contributing

Contributions are welcome. Check the existing issues first, open an issue before starting a large change, match the existing code style, and test your changes on desktop and mobile. Features that would help all Jellyfin or Emby users are worth proposing upstream first.

To submit a change, fork the repo, create a feature branch, make your changes with clear commit messages, and open a pull request with a clear description.

Support and Community

Credits

Moonfin is built on the work of others:

  • Jellyfin Project for the foundation and upstream codebase
  • Druidblack for the original MDBList Ratings plugin
  • Moonfin Contributors for everything they have added to the project

License

This project is licensed under GPL-3.0. See the LICENSE file for details.


Moonfin is an independent project and is not affiliated with the Jellyfin or Emby projects.
Back to the main Moonfin project

About

Companion server plugin for all Moonfin clients

Resources

License

Stars

288 stars

Watchers

4 watching

Forks

Contributors