#13: Allow separate images when song has no album art vs. when no song is playing [implement proposal C]

Author: Aldaviva

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "nuget"
+    directory: "/WinampNowPlayingToFile"
+    schedule:
+      interval: "weekly"

Readme.md

@@ -20,27 +20,27 @@ This is a plugin for [Winamp](http://www.winamp.com/) that saves text informatio
 
 I was broadcasting video game streams on [my Twitch.tv channel](https://twitch.tv/aldaviva), in which I also play music in the background. I wanted viewers to be able to tell which song I was playing at any given time in case they liked it and wanted to find it for themselves. I started using the [Advanced mIRC Integration Plug-In (AMIP)](http://amip.tools-for.net/wiki/), which is generally used for showing your Now Playing status in IRC using [mIRC](https://www.mirc.com/). It also lets you save the status to a text file, which I added as a Text Source in [OBS](https://obsproject.com/).
 
-Unfortunately, AMIP only supports encoding the text using ANSI, OEM (DOS), FIDO, or KOI8 character encodings, none of which are UTF-8, which OBS requires. For example, `Jävla Sladdar` by [Etnoscope](https://www.discogs.com/Etnoscope-Way-Over-Deadline/master/284523) was being shown in the video stream as `J�vla Sladdar`, because even though AMIP was saving `ä` using ANSI (`0xe4`), OBS was decoding the file with UTF-8, so the character was not properly decoded. In UTF-8, `ä` is supposed to be encoded as `0xc3 0xa4` because `0xe4` is greater than `0x7f` (i.e. `0x34` requires more than 7 bits to represent), so it spills over into a second code unit (byte).
+Unfortunately, AMIP only supports encoding the text using ANSI, OEM (DOS), FIDO, or KOI8 character encodings, none of which are UTF-8, which OBS requires. For example, [Jävla Sladdar](https://www.youtube.com/watch?v=zaCZ9VkJ-so) was being shown in the video stream as `J�vla Sladdar`, because even though AMIP was saving `ä` using ANSI (`0xe4`), OBS was decoding the file with UTF-8, so the character was not properly decoded. In UTF-8, `ä` is supposed to be encoded as `0xc3 0xa4` because `0xe4` is greater than `0x7f` (i.e. `0x34` requires more than 7 bits to represent), so it spills over into a second code unit (byte).
 
 ## Solution
 
 I wrote my own Winamp plugin to save information about the currently playing song to a UTF-8 text file, and the song's album art to an image file.
 
 ## Installation
 
-1. Ensure you have the [Microsoft .NET Framework 4.7.2](https://dotnet.microsoft.com/download/dotnet-framework) Runtime or later installed. This is included in Windows 10 version 1803 and later.
-1. Download `WinampNowPlayingToFile.zip` from the [latest release](https://github.com/Aldaviva/WinampNowPlayingToFile/releases) (not the source code ZIP file).
+1. Ensure you have [Microsoft .NET Framework 4.7.2](https://dotnet.microsoft.com/download/dotnet-framework) Runtime or later installed. This is included in Windows 10 version 1803 and later.
+1. Exit Winamp if it's already running.
+1. Download [**`WinampNowPlayingToFile.zip`**](https://github.com/Aldaviva/WinampNowPlayingToFile/releases/latest/download/WinampNowPlayingToFile.zip) from the [latest release](https://github.com/Aldaviva/WinampNowPlayingToFile/releases) (not the source code ZIP file).
 1. Extract the archive to your Winamp installation directory.
     ```
-    C:\Program Files (x86)\Winamp
-    ├── plugins
-    │   └── gen_WinampNowPlayingToFile.dll
-    ├── WinampNowPlayingToFile.dll
-    ├── Daniel15.Sharpamp.dll
-    └── mustache-sharp.dll
-    └── taglib-sharp.dll
+    📁 C:\Program Files (x86)\Winamp
+    ├── 📁 plugins
+    │   └── 📄 gen_WinampNowPlayingToFile.dll
+    ├── 📄 WinampNowPlayingToFile.dll
+    ├── 📄 Daniel15.Sharpamp.dll
+    └── 📄 mustache-sharp.dll
+    └── 📄 taglib-sharp.dll
     ```
-1. Restart Winamp if it's already running.
 
 ## Configuration
 
@@ -50,13 +50,13 @@ Configuration of this plugin is performed in Winamp.
 1. Go to Options › Preferences › Plug-ins › General Purpose.
 1. Configure the Now Playing to File plugin.
 
-Changes are saved to the registry in `HKCU\Software\WinampNowPlayingToFile`.
-
 ![configuration](.github/images/configuration.png)
 
+*Changes are saved to the registry in `HKCU\Software\WinampNowPlayingToFile`.*
+
 ### Text
 
-By default, this plugin saves textual information about the currently playing song to `winamp_now_playing.txt` in your temporary directory (`%TEMP%`), and the file contains the track Artist, Title, and Album (if applicable), for example
+By default, this plugin saves textual information about the currently playing song to `winamp_now_playing.txt` in your user's temporary directory (`%TEMP%`), and the file contains the track Artist, Title, and Album (if applicable), for example
 ```text
 U2 - Exit - The Joshua Tree
 ```
@@ -79,11 +79,23 @@ When Winamp is not playing a song, this text file will be truncated to 0 bytes.
 
 This plugin also copies the currently playing song's album art from the song metadata or folder. By default, it is copied to `%TEMP%\winamp_now_playing.png`.
 
-Note that the file extension is not changed, even if the album art has a file type different from PNG, to make it easier to refer to this file from other programs like OBS without having to deal with multiple possible file extensions. This means that this file may be a JPEG with a `.png` file extension. Most programs, including OBS, can handle this case just fine, but it is a little silly looking.
+Note that the file extension is not changed, even if the album art has a file type different from PNG, to make it easier to refer to this file from other programs like OBS without having to deal with multiple possible file extensions. This means that this file may be a JPEG with a `.png` file extension. Most programs, including OBS, can handle this case just fine, but the mismatch is a little silly. Feel free to change the file extension using the preferences.
 
 You can customize the album art filename and path using **Save album art as** in the same plugin configuration dialog as the text file above.
 
-When Winamp is playing a song with no album art, or when Winamp is paused, stopped, or closed, the image file will be replaced with a 1px × 1px opaque black PNG. To override this, save your desired image file as `emptyAlbumArt.png` in the Winamp installation directory.
+#### Fallback artwork
+
+When there is no album art, the copied files will be deleted. However, this may be undesirable because it can leave dependent interfaces in a weird-looking state (like an OBS layout with a big transparent gap where the album art would normally be), and it will also trigger the Missing Files warning dialog box each time you launch OBS.
+
+To resolve this, you can specify custom image files that will be copied instead when there is no album art. Here are some sample [black](https://placehold.co/128x128/000f/0000.png) and [transparent](https://placehold.co/128x128/0000/0000.png) images to get started, or you can use your own. There are no requirements for the format or dimensions of these images besides what your downstream consumer like OBS accepts.
+
+##### Missing artwork
+
+When Winamp is playing a song with no album art, the image file will be deleted. To override this, save your desired image file as `emptyAlbumArt.png` in the Winamp installation directory.
+
+##### Playback stopped
+
+When Winamp is paused, stopped, or closed, the image file will be deleted. To override this, save your desired image file as `stoppedAlbumArt.png` in the Winamp installation directory.
 
 ## Integration
 
@@ -102,12 +114,13 @@ When Winamp is playing a song with no album art, or when Winamp is paused, stopp
 1. Select the Now Playing to File plugin, then click the Uninstall Selected Plug-In button.
 1. Delete all the files you extracted to the Winamp installation directory when installing this plugin.
     ```
-    C:\Program Files (x86)\Winamp
-    ├── plugins
-    │   └── gen_WinampNowPlayingToFile.dll
-    ├── WinampNowPlayingToFile.dll
-    ├── Daniel15.Sharpamp.dll
-    ├── mustache-sharp.dll
-    └── taglib-sharp.dll
+    📁 C:\Program Files (x86)\Winamp
+    ├── 📁 plugins
+    │   └── 📄 gen_WinampNowPlayingToFile.dll
+    ├── 📄 WinampNowPlayingToFile.dll
+    ├── 📄 Daniel15.Sharpamp.dll
+    └── 📄 mustache-sharp.dll
+    └── 📄 taglib-sharp.dll
     ```
 1. Delete the song information files (by default, `winamp_now_playing.txt` and `winamp_now_playing.png` in `%TEMP%`).
+1. Delete the plugin settings registry key `HKCU\Software\WinampNowPlayingToFile`.