{"id":13835392,"url":"https://github.com/vc-01/metadata-osd","last_synced_at":"2025-07-10T07:31:51.426Z","repository":{"id":62694329,"uuid":"505338681","full_name":"vc-01/metadata-osd","owner":"vc-01","description":"Metadata OSD for mpv player","archived":false,"fork":false,"pushed_at":"2023-12-25T22:57:18.000Z","size":206,"stargazers_count":15,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-20T20:39:10.024Z","etag":null,"topics":["metadata","mpv","mpv-script","music"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vc-01.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-20T07:30:32.000Z","updated_at":"2024-11-03T03:21:21.000Z","dependencies_parsed_at":"2023-01-22T08:00:10.368Z","dependency_job_id":"756629d7-6195-42db-ba2f-1821a5f133c1","html_url":"https://github.com/vc-01/metadata-osd","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/vc-01/metadata-osd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vc-01%2Fmetadata-osd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vc-01%2Fmetadata-osd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vc-01%2Fmetadata-osd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vc-01%2Fmetadata-osd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vc-01","download_url":"https://codeload.github.com/vc-01/metadata-osd/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vc-01%2Fmetadata-osd/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264545167,"owners_count":23625404,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["metadata","mpv","mpv-script","music"],"created_at":"2024-08-04T14:01:00.972Z","updated_at":"2025-07-10T07:31:51.182Z","avatar_url":"https://github.com/vc-01.png","language":"Lua","funding_links":[],"categories":["Music"],"sub_categories":[],"readme":"# Metadata OSD script for mpv player\n\nThis script adds metadata OSD (on-screen display) to mpv.\n\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"sshots/sshot_osd_1_dark.png\"\u003e\n  \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"sshots/sshot_osd_1_light.png\"\u003e\n  \u003cimg alt=\"OSD-1 Screenshot\" src=\"sshots/sshot_osd_1_light.png\"\u003e\n\u003c/picture\u003e\n\n\u003csub\u003e* Screenshot taken on a packaged mpv on Arch Linux; font type and size may vary on other platforms.\u003c/sub\u003e\n\n## Installation \u0026 Configuration\n\nDownload \u0026 place [metadata_osd.lua](scripts/metadata_osd.lua?raw=true) script into\n\n- `$XDG_CONFIG_HOME/mpv/scripts` (it will be most of the times `~/.config/mpv/scripts`) on Linux, or\n- `%APPDATA%\\mpv\\scripts` on Windows\n\nfor autoload.\n\n(_Optional_) Config file with user settings named `metadata_osd.conf` can be created in\n\n- `$XDG_CONFIG_HOME/mpv/script-opts` on Linux, or\n- `%APP‐DATA%\\mpv\\script-opts` on Windows\n\nSee the example configuration file [metadata_osd.conf](script-opts/metadata_osd.conf?raw=true) in this repo for available user config options.\n\n## Key Bindings\n\nThe following table summarizes the script's default key bindings and their config options:\n\n| Key           | Action                                | Config Option Name    | Binding Name (for input.conf) |\n| -------------:|:------------------------------------- |:--------------------- |:----------------------------- |\n| \u003ckbd\u003eF1\u003c/kbd\u003e | Master enable / disable (killswitch)  | key_toggleenable      | toggleenable                  |\n| \u003ckbd\u003eF5\u003c/kbd\u003e | Enable / disable the autohide feature | key_toggleautohide    | toggleautohide                |\n| _unassigned_  | Show / hide OSD-1                     | key_toggleosd_1       | toggleosd_1                   |\n| _unassigned_  | Show / hide OSD-2                     | key_toggleosd_2       | toggleosd_2                   |\n| \u003ckbd\u003eF6\u003c/kbd\u003e | Reset any user-toggled switches       | key_reset_usertoggled | reset_usertoggled             |\n| _unassigned_  | Show status OSD                       | key_showstatusosd     | showstatusosd                 |\n\nKey bindings can be configured either via script's config file, see [metadata_osd.conf](script-opts/metadata_osd.conf?raw=true) example with pre-filled defaults, or via _input.conf_.\n\nDefault bindings in _input.conf_ format are listed below again for clarity:\n\n```\nF1 script-binding metadata_osd/toggleenable\nF5 script-binding metadata_osd/toggleautohide\n#\u003cunassigned\u003e script-binding metadata_osd/toggleosd_1\n#\u003cunassigned\u003e script-binding metadata_osd/toggleosd_2\nF6 script-binding metadata_osd/reset_usertoggled\n#\u003cunassigned\u003e script-binding metadata_osd/showstatusosd\n```\n\n## Per media-type enable / autohide\n\nOSD enabled state or auto-hiding after a delay can be triggered either manually by pressing the relevant key (see _key_toggleenable_ and _key_toggleautohide_ [above](#key-bindings)) or determined algorithmically based on the currently playing media type and its related config options settings.\n\nOSD is enabled by default for audio and video media, disabled while viewing pictures. Autohide feature is enabled for video, autohide is disabled (that is, the OSD will stay visible) while playing music, as well as for music files with cover art image.\n\nCurrently recognizable media types are namely: _audio_, _audio_withalbumart_, _video_, _image_.\n\nConfig options for per media-type OSD enable and autohide are cumulatively:\n\n* _enable_for\\_\u003cmedia_type\\\u003e_ (yes/no)\n* _autohide_for\\_\u003cmedia_type\\\u003e_ (yes/no)\n\nIf user presses a button to toggle enable / disable the OSD or the autohide feature, it will override the automatic determining until reset back by presssing a key specified by:\n\n* _key_reset_usertoggled_ / _reset_usertoggled_ (F6) (see [above](#key-bindings))\n\n## Program Architecture\n\nSee [ARCHITECTURE.md](ARCHITECTURE.md).\n\n## License\n\nThis project is licensed under the terms of the **MIT license**. See [LICENSE](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvc-01%2Fmetadata-osd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvc-01%2Fmetadata-osd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvc-01%2Fmetadata-osd/lists"}