Skip to content

Latest commit

 

History

History
83 lines (77 loc) · 4.17 KB

README.md

File metadata and controls

83 lines (77 loc) · 4.17 KB
Raw

A machine-readable directory of scripts and other tools for mpv.

Why

Mpv is a great free and open video player. It has interfaces to extend it with different types of scripts. There is a large number of those scripts, many of them of great use. A wiki page lists them, but browsing this is tedious and installing and updating scripts was not comfortable. Therefore, I created this directory as backend for a new plugin manager.

How does it work

The main file of this project ist mpv_script_directory.json. It contains all the known tools with their metadata. The Information is encoded as JSON:

  • The file contains an object (aka dictionary) where each tool is represented as one value.
  • The keys in this object are identifiers that have to be unique. They are for github and gitlab they are well-defined, otherwise they are derived from the projects url.
  • Every script is described by an object with the following keys:
    • name: The name of the tool
    • url: The url of the project
    • type: The type of the tool:
      • javascript
      • lua script
      • user shader
      • vapourSynth scripts
      • C plugin
      • other
    • desc: A short description of the tool
    • os: A List of the supported operating systems, an empty list is interpreted as platform independent.
    • stars: The number of stars the project's repository has on github/gitlab
    • sharedrepo: Boolean, True if the tool shares a repository with other tools
    • install: Install method, currently git, url and tar are supported by mplug
    • receiving_url: The url that is used to download the script.
    • install_dir: Name for local directory in that the script will be installed. the git repo in. Needed to support scripts sharing a git repo.
    • scriptfiles: List of files from source that should be installed in the script folder ($MPV_HOME/scripts).
    • scriptoptfiles: List of files from source that should be installed in the script-opts folder ($MPV_HOME/script-opts).
    • shaderfiles: List of files from source that should be installed in the shaders folder ($MPV_HOME/shaders).
    • fontfiles: List of files from source that should be installed in the fonts folder ($MPV_HOME/fonts).
    • executeablefiles: List of executeable files from source that should be installed (user queried, defaults to ~/bin).
    • install-notes: Text that will be displayed after install.
  • For a more detailed description of how to add the installation instructions of a script to the mpv script directory, see here.
  • The directory is initially created by scraping the wiki page. This is done by scrapewiki.py – in the future the directory should be updated directly and the scraping script should therefore become obsolete. Maybe it can be continued to be used to check for divergence from the wiki page.
  • The script querystars.py checks the number of stars the project has, if it is hosted on github, github gist or gitlab.com. Other fields are not modified.

Usage

  • MPlug is a plugin manager for mpv, it can install plugins from this directory.
    • Note: For this to work, the directory needs to contain install instructions. Those are currently still missing for most plugins, but can most often be added easily.
  • There is a Proof-of-Concept webpage that allows searching, sorting and filtering the directory.
  • This list can be read with any JSON parser.

Status and ToDo

The catalog was scraped and enriched by hand. The installation instructions have been added for the most prominent scripts but many others are still pending. If you want to use a plugin that isn't yet supported, please add the Information and open a PR.

There's a lot to do – please help!

  • Fill the install introductions for all tools
  • Create formal format specification
  • Add further fields: screenshot, deprecated, superseededby, …
  • Set up an automatic update of the star counts
  • Improve the web version
  • Tell the world!