Home

Awesome

<h1 align="center">ModernZ - A Sleek Alternative OSC for mpv</h1>

A sleek and modern OSC for mpv, this project is a fork of ModernX designed to enhance functionality by adding more features, all while preserving the core standards of mpv's OSC.

modernz-osc

<p align="center"> <a href="#installation"><strong>Installation »</strong></a> <br> <a href="#configuration">Configuration</a> · <a href="#controls">Controls</a> · <a href="#interactive-menus">Interactive Menus</a> · <a href="#translations">OSC Language</a> · <a href="#extras">Extra Scripts</a> </p>

Features

Customization Showcase

Don't like the default white buttons and text? ModernZ is fully customizable! Change colors and button layouts to match your style:

modernz-osc_colors_top

modernz-osc_colors_bottom

See the Color Customization section in the configuration guide for details on how to customize colors and buttons.

Interactive Menus

ModernZ supports mpv's built-in console/select (v0.39+) for playlist, subtitles, chapter navigation and more.

preview_menus

Installation

  1. Disable Stock OSC

    • Add osc=no in your mpv.conf

  2. Copy Files

    • Place modernz.lua in your mpv scripts directory
    • Place fluent-system-icons.ttf in your mpv fonts directory
    • (OPTIONAL) Place thumbfast.lua in your mpv scripts directory

  3. Locations

    Linux:   ~/.config/mpv/
Windows: C:/Users/%username%/AppData/Roaming/mpv/
macOS:   ~/Library/Application Support/mpv/

  4. Folder Structure [mpv manual]

    mpv/
├── fonts/
│   └── fluent-system-icons.ttf
├── script-opts/
│   └── modernz.conf
└── scripts/
	   ├── modernz.lua
	   └── thumbfast.lua (optional)

Configuration

  1. Create modernz.conf in the /script-opts folder to customize settings

  2. Example short configuration:

    # Seekbar colors (Hex format)
seekbarfg_color=#B7410E

# Interface options
showplaylist=no
title=${media-title}
scalewindowed=1.0
windowcontrols=auto

For a full list of options, check out the detailed user options here.

Controls

Button Interactions

[!NOTE] Middle clicking performs the same function as Shift+left mouse button, allowing for one handed use

For a full list of interactions, check out the Button Interactions Guide.

Keybinds

ModernZ doesn't set keybinds by default to avoid interfering with your current setup. You can add keybinds in input.conf if you prefer:

w   script-binding modernz/progress-toggle     # Toggle progress bar
x   script-message-to modernz osc-show         # Show OSC
y   script-message-to modernz osc-visibility   # Toggle visibility
z   script-message-to modernz osc-idlescreen   # Toggle idle screen

Translations

ModernZ is currently available in English, but you can easily switch it to your preferred language! Here's how:

  1. Download the locale pack:

Grab the modernz-locale.json file from this repository. This file holds translations for various languages.

  1. Add the locales to mpv:

Copy the downloaded modernz-locale.json file to your mpv's /script-opts folder.

  1. Choose your language:

There are two ways to set your preferred language:

Need More Info?

For a complete list of available languages, contribution guidelines, and in-depth translation documentation, head over to the TRANSLATIONS.md.

Extras

The following scripts are ones I wrote and maintain, feel free to use them if they're useful to you.

For even more useful scripts, check out the mpv User Scripts Wiki. It offers a wide range of community-contributed scripts to enhance your mpv experience.

History

Why fork yet again?

In essence, to modernize and revive the Modern origin.

Having said that, ModernZ still uses parts of the old code, and every previous and current fork author and contributor deserve credit (including mpv's stock osc), that is why they're mentioned in detail.

Credits: