Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
alyosha committed Sep 7, 2020
1 parent 1541b38 commit b96d437
Showing 1 changed file with 18 additions and 8 deletions.
26 changes: 18 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
## vimedia
## vimedia
Control your media players from inside Vim, if you're really
that lazy 😏

## commands
## Usage
- `:Play` => Begin playback from active media player
- `:Pause` => Pause playback from active media player
- `:PauseAll` => Pause playback from all runing media players
- `:Skip` => Skip to next song
- `:Prev` => Go back to previous song
- `:Restart` => Replay current song from the beginning
- `:Shuffle` => Toggle shuffle for the media player
- `:Mute` => Mute audio for all media players
- `:Unmute` => Unmute audio for all media players
- `:Vol` => Toggle volume louder/quieter
Expand All @@ -18,17 +19,26 @@ that lazy 😏

Please keep in mind that some media players may not have implemented MPRIS
fully/at all and available functionality can vary with each player. At some point
I will go through and properly add error messages when certain functionality is
not supported.
I will go through and properly add debug messages where functionality is not supported,
but for now I've just addressed those places that throw errors.

## coming soon
Throw an env like the following in your .zshrc/.bashrc to configure your preferred default player:

`export DEFAULT_VIMEDIA_PLAYER=chromium`

If you're unsure of the name to set here, try opening the media player and
running `:SelectPlayer` from within Vim to get a list of options.

## Coming soon
- Seek forward/backwards
- Shuffle
- Optional status bar

## installation
Suggestions/contributions welcome.

## Installation
Using your preferred plugin manager or if all else fails:

`git clone https://github.com/alyosha/vimedia ~/.vim/bundle/vimedia`

You may need to install a newer version of Vim if yours wasn't built with python3.
You may need to install a newer version of Vim if yours wasn't built with python3.

0 comments on commit b96d437

Please sign in to comment.