{"id":16556328,"url":"https://github.com/miraclx/cmusd","last_synced_at":"2025-10-28T20:30:27.727Z","repository":{"id":57201267,"uuid":"169995077","full_name":"miraclx/cmusd","owner":"miraclx","description":"CMUS-D (C* Music Player Daemon) with NodeJS","archived":false,"fork":false,"pushed_at":"2019-07-15T23:42:23.000Z","size":1565,"stargazers_count":13,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-09T03:38:02.348Z","etag":null,"topics":["cmus","cmus-control","cmus-remote","dbus","dbus-service","media","media-player","media-player-widget","mpris","mpris2","remote","remote-control"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/miraclx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-02-10T15:51:18.000Z","updated_at":"2021-03-15T00:00:54.000Z","dependencies_parsed_at":"2022-09-15T11:22:08.657Z","dependency_job_id":null,"html_url":"https://github.com/miraclx/cmusd","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miraclx%2Fcmusd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miraclx%2Fcmusd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miraclx%2Fcmusd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miraclx%2Fcmusd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/miraclx","download_url":"https://codeload.github.com/miraclx/cmusd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238710511,"owners_count":19517717,"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":["cmus","cmus-control","cmus-remote","dbus","dbus-service","media","media-player","media-player-widget","mpris","mpris2","remote","remote-control"],"created_at":"2024-10-11T20:04:12.875Z","updated_at":"2025-10-28T20:30:22.269Z","avatar_url":"https://github.com/miraclx.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CMUS-D\n\n\u003e [C* Music Player][cmus] media interface daemon\n\nThis package provides a remote graphical frontend for the [C* Music Player][cmus] using the `MPRIS D-Bus Interface`\n\nHow it works\n\n`cmus` has a remote tool [cmus-remote(1)](https://linux.die.net/man/1/cmus-remote) that can control and query `cmus` through a socket.\n`cmusd` takes advantage of this by parsing the status of `cmus` on request and sending playback controls to it.\nThis data is updated twice every second for precision.\n\n## Features\n\n* Album art: This is generated and rendered after being extracted by `ffmpeg`\n* Playback (Next, Previous, Pause, Play, PlayPause, Stop, Seek)\n* Hybrid Connection: The daemon can either spawn a `cmus` process within itself or connect to an already active one\n* Auto logging\n\n## Installing\n\nThe project is written in Native JavaScript [NodeJS](https://github.com/nodejs/node).\n[Download and install Node.js, NPM](https://nodejs.org/en/download/).\n\nVia [NPM][npm]\n\n``` bash\nnpm install cmusd -g\n```\n\nManual Installatiion\n\n``` bash\ngit clone https://gitlab.com/miraclx/cmusd.git\ncd cmusd\nnpm run setup\n```\n\n## Usage\n\n``` bash\n# Launch the daemon\ncmusd\n\n# Clean all logfiles, launch\ncmusd -x\n\n# Remove the lockfile, launch\n# (incase previous process didn't close correctly)\ncmusd -q\n\n# Write log to specific file\ncmusd \u003cfilename\u003e\n\n# Write log to file in folder\ncmusd \u003cfolder\u003e\n```\n\n* Lock file: `\u003cos-tmp-dir\u003e/cmus-dir/.lock`\n* Album Art cache folder: `\u003cos-tmp-dir\u003e/cmus-dir/`\n* Default log folder: `\u003cos-tmp-dir\u003e/cmus-dir/logs/`\n\n## Screenshots\n\n### `Simple Command`\n\n![CMUS-D Simple Command](https://raw.githubusercontent.com/miraclx/cmusd/master/screenshots/cmusd.png \"CMUS-D Simple Command\")\n\n### \u003ca id=\"a\"\u003e\u003c/a\u003e`Basic Run, spawns cmus within (if not already running)`\n\n![cmus in terminal, spawned from cmusd](https://raw.githubusercontent.com/miraclx/cmusd/master/screenshots/cmusd-spawn.png \"CMUS-D Spawning a cmus process within itself (if not already running)\")\n\n### `Media player instance` for the auto-spawned [CMUS-D listener](#a)\n\n![KDE Media Player displaying cmus music data](https://raw.githubusercontent.com/miraclx/cmusd/master/screenshots/mpris-player.png \"KDE Media Player displaying cmus music data\")\n\n### Connect to an actively running cmus process\n\n![CMUS-D Basic Use](https://raw.githubusercontent.com/miraclx/cmusd/master/screenshots/cmusd-connect.png)\n\n### `Already running CMUS`\n\n![CMUS running on another terminal window](https://raw.githubusercontent.com/miraclx/cmusd/master/screenshots/cmus-solo.png)\n\n### \u003ca id=\"b\"\u003e\u003c/a\u003e`CMUS-D Connected and logging`\n\n![CMUS-D connected and logging](https://raw.githubusercontent.com/miraclx/cmusd/master/screenshots/cmusd-logs.png)\n\n### `Media player instance` for the connected [CMUS-D listener](#b)\n\n![KDE Media Player displaying cmus music data](https://raw.githubusercontent.com/miraclx/cmusd/master/screenshots/mpris-connect.png)\n\n## Development\n\n### Building\n\nUse in adherance to the [license](#license), feel free to send some pull requests\n\n``` bash\ngit clone https://github.com/miraclx/cmusd.git\ncd cmusd\nnpm install\n# hack on code\nnpm run build\n```\n\n## License\n\n[Apache 2.0][license] © **Miraculous Owonubi** ([@miraclx][author-url]) \u0026lt;omiraculous@gmail.com\u0026gt;\n\n[npm]:  https://github.com/npm/cli \"The Node Package Manager\"\n[cmus]:  https://github.com/cmus/cmus \"C* Music Player\"\n[license]:  LICENSE \"Apache 2.0 License\"\n[author-url]: https://github.com/miraclx\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmiraclx%2Fcmusd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmiraclx%2Fcmusd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmiraclx%2Fcmusd/lists"}