Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Junker/stumpwm-nuclear
Nuclear music player module for StumpWM
https://github.com/Junker/stumpwm-nuclear
stumpwm
Last synced: 3 months ago
JSON representation
Nuclear music player module for StumpWM
- Host: GitHub
- URL: https://github.com/Junker/stumpwm-nuclear
- Owner: Junker
- Created: 2022-06-03T08:10:30.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-06-03T09:07:25.000Z (over 2 years ago)
- Last Synced: 2024-06-12T01:49:30.521Z (5 months ago)
- Topics: stumpwm
- Language: Common Lisp
- Homepage:
- Size: 2.93 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-stumpwm - nuclear - Nuclear music player module (Modules)
README
# StumpWM Nuclear
Nuclear music player module for StumpWM
## Requirements
- [Nuclear](https://github.com/nukeop/nuclear) music player installed
- [Dexador](https://github.com/fukamachi/dexador) library installed
- [CL-JSON](https://github.com/hankhero/cl-json) library installed
## Installation
- Enable HTTP API in the Nuclear player settings
- download module:
```bash
cd ~/.stumpwm.d/modules/
git clone https://github.com/Junker/stumpwm-nuclear nuclear
```
- install dependency libraries:
```lisp
(ql:quickload "dexador")
(ql:quickload "cl-json")
```
- load module:
```lisp
(stumpwm:add-to-load-path "~/.stumpwm.d/modules/nuclear")
(load-module "nuclear")
```
## Usage
```lisp
(define-key *top-map* (kbd "XF86AudioPlay") "nuclear-play-pause")
(define-key *top-map* (kbd "XF86AudioPrev") "nuclear-previous")
(define-key *top-map* (kbd "XF86AudioNext") "nuclear-next")
(define-key *top-map* (kbd "XF86AudioStop") "nuclear-stop")
```
### Additional commands
- nuclear-play
- nuclear-mute
- nuclear-quit
- nuclear-show-playing
### Parameters
- nuclear:\*url\* - API URL of Nuclear player (default: "http://localhost:3100")
### Modeline
%N - nuclear formatter
#### Parameters for modeline
- nuclear:\*modeline-fmt\* - format of nuclear modeline (default: "%a: %n")
- %a: artist
- %n: name
- %d: duration
- %p: progress
- %l: stream-loading
- %s: status