Bump release, update changelog and release notes, update usage

doctorfree · Apr 12, 2022 · da0a990 · da0a990
1 parent a8efc01
commit da0a990
Show file tree

Hide file tree

Showing 4 changed files with 83 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file.
 
+# MusicPlayerPlus-1.0.1r3 (2022-04-12)
+* Disable tmux recording when tmux is disabled
+* Improve interactive menu entries
+* If -s song argument is provided look for song in MPD music library as well
+* Added interactive mode with -i command line option
+* Added support for mpplus front-end to mppsplash and mppsplash-tmux
+* Add ability to download cover art to mpplus command
+* Add option to download_cover_art to specify alternate music directory
+* Add -d option to mpplus to download album cover art
+
 # MusicPlayerPlus-1.0.1r2 (2022-04-04)
 * Use MPlayer to play media during ASCIImatics animations
 * Use a signal handler in ASCIImatics animations to fade audio and cleanup

diff --git a/VERSION b/VERSION
@@ -1,2 +1,2 @@
 VERSION=1.0.1
-RELEASE=2
+RELEASE=3
diff --git a/pkg/release.md b/pkg/release.md
@@ -1,14 +1,21 @@
 Changes in this release include:
+* Disable tmux recording when tmux is disabled
+* Improve interactive menu entries
+* If -s song argument is provided look for song in MPD music library as well
+* Added interactive mode with -i command line option
+* Added support for mpplus front-end to mppsplash and mppsplash-tmux
+* Add ability to download cover art to mpplus command
+* Add option to download_cover_art to specify alternate music directory
+* Add -d option to mpplus to download album cover art
+
+Changes in previous release include:
 
 * Use MPlayer to play media during ASCIImatics animations
 * Use a signal handler in ASCIImatics animations to fade audio and cleanup
 * Use a FIFO in ASCIImatics animations to communicate with MPlayer
 * Added tmux session integration to `mpplus` command
 * Re-enable visualizer in `mpcplus` MPD client build
 * Cleanup tmux sessions, add ability to kill tmux sessions in `mpplus`
-
-Changes in previous release include:
-
 * Add capability to play audio while displaying ASCIImatics scenes
 * Add several ASCIImatics scenes including one during initialization
 * Rename `mpcava` to `mpplus`
@@ -29,12 +36,12 @@ Changes in previous release include:
 ## Installation
 Install the package on Debian based systems by executing the command
 ```bash
-sudo apt install ./MusicPlayerPlus_1.0.1-2.amd64.deb
+sudo apt install ./MusicPlayerPlus_1.0.1-3.amd64.deb
 ```
 
 Install the package on RPM based systems by executing the command
 ```bash
-sudo yum localinstall ./MusicPlayerPlus-1.0.1-2.x86_64.rpm
+sudo yum localinstall ./MusicPlayerPlus-1.0.1-3.x86_64.rpm
 ```
 
 ## Configuration

diff --git a/usage.txt b/usage.txt
@@ -1,15 +1,65 @@
 =============================================================================
 
-Usage: mpplus [-c] [-C client] [-f] [-h] [-q] [-r] [-t] [-u]
+Usage: mpplus [-A] [-a] [-b] [-c] [-C client] [-D] [-d music_directory]
+		[-f] [-h] [-i] [-jJ] [-k] [-m] [-n num] [-N] [-p] [-P script]
+		[-q] [-r] [-R] [-s song] [-S] [-t] [-T] [-u]
+MPCplus/Visualizer options:
+	-A indicates display album cover art (implies tmux session)
+	-c indicates use cantata MPD client rather than mpcplus
+	-C 'client' indicates use 'client' MPD client rather than mpcplus
+	-f indicates fullscreen display
+	-i indicates start mpplus in interactive mode
+	-h indicates half-height for cava window (with -f only)
+	-P script specifies the ASCIImatics script to run in visualizer pane
+	-q indicates quarter-height for cava window (with -f only)
+	-r indicates use retro terminal emulator
+	-t indicates use tilix terminal emulator
+ASCIImatics animation options:
+	-a indicates play audio during ASCIImatics display
+	-b indicates use backup audio during ASCIImatics display
+	-j indicates use Julia Set scenes in ASCIImatics display
+	-J indicates Julia Set with several runs using different parameters
+	-m indicates use MusicPlayerPlus scenes in ASCIImatics display
+	-n num specifies the number of times to cycle ASCIImatics scenes
+	-N indicates use alternate comments in Plasma ASCIImatics scenes
+	-p indicates use Plasma scenes in ASCIImatics display
+	-s song specifies a song to accompany an ASCIImatics animation
+		'song' can be the full pathname to an audio file or a
+		relative pathname to an audio file in the MPD music library
+		or /home/ronnie/Music/
+	-S indicates display ASCIImatics splash animation
+General options:
+	-D indicates download album cover art
+	-d 'music_directory' specifies the music directory to use for
+		downloaded album cover art (without this option -D will use
+		the 'music_directory' setting in '/etc/mpd.conf'
+	-k indicates kill MusicPlayerPlus tmux sessions and ASCIImatics scripts
+	-R indicates record tmux session with asciinema
+	-T indicates use a tmux session for either ASCIImatics or mpcplus
+	-u displays this usage message and exits
+
+=============================================================================
+
+Usage: mppsplash [-A] [-a] [-b] [-C] [-c num] [-d] [-jJ] [-m] [-p] [-s song] [-u]
 Where:
-  -c indicates use cantata MPD client rather than mpcplus
-  -C 'client' indicates use 'client' MPD client rather than mpcplus
-  -f indicates fullscreen display
-  -h indicates half-height for cava window (with -f only)
-  -q indicates quarter-height for cava window (with -f only)
-  -r indicates use retro terminal emulator
-  -t indicates use tilix terminal emulator
-  -u displays this usage message and exits
+	-A indicates use all effects
+	-a indicates play audio during ASCIImatics display
+	-b indicates use backup audio during ASCIImatics display
+	-C indicates use alternate comments in Plasma effect
+	-c num specifies the number of times to cycle
+	-d indicates enable debug mode
+	-j indicates use Julia Set effect
+	-J indicates Julia Set with several runs using different parameters
+	-m indicates use MusicPlayerPlus effect
+	-p indicates use Plasma effect
+	-s song specifies the audio file to play as accompaniment
+		'song' can be the full pathname to an audio file or a relative
+		pathname to an audio file in the MPD music library or
+		/home/ronnie/Music/
+	-u displays this usage message and exits
+
+Default audio: /usr/share/doc/musicplayerplus/music/Epic_Dramatic-Yuriy_Bespalov.wav
+Without any options the MusicPlayerPlus effect will repeat
 
 =============================================================================
 
@@ -53,4 +103,4 @@ Keys:
         b         Cycle background color
         q         Quit
 
-as of 0.4.0 all options are specified in config file, see in '/home/username/.config/cava/' 
+As of 0.4.0 all options are specified in config file, see in '/home/username/.config/cava/'