README.md: Add playerid information

ejona86 · Apr 5, 2020 · 07baa5f · 07baa5f
1 parent a7a45b6
commit 07baa5f
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -77,6 +77,17 @@ is compatible with the TAUS and twoplayer mods.
 This mod was originally created as a training aid. When used with the twoplayer
 mod it can level the playing field.
 
+## Player ID
+
+[![In-game](media/playerid-ingame.thumb.png)](media/playerid-ingame.aspect.png)
+
+The playerid mod displays an identifier 1-7 at the top-right of the play
+screen, which can be chosen by pressing Select at the level-select screen. It
+is compatible with the TAUS and twoplayer mods.
+
+The identifier is intended to help identify the game in a recording, like
+determining which player was playing.
+
 ## How to build
 
 You only need to build if you are making changes or want to try out changes

diff --git a/media/playerid-ingame.aspect.png b/media/playerid-ingame.aspect.png
diff --git a/media/playerid-ingame.png b/media/playerid-ingame.png
diff --git a/media/playerid-ingame.thumb.png b/media/playerid-ingame.thumb.png