doc

README.md

@@ -4,21 +4,38 @@ VPin Extensions provides an easy generation of highscore cards for Visual Pinbal
 and PinUP Popper. A user interface allows you customize the size, color, fonts and design of highscore cards,
 which are generated everytime a highscore changes.
 
+## Overview
+
+This section gives a brief overview about the functionality provided by this project.
+
 ![](./documentation/screen-cards-1.png)
 *Configuration screen for highscore card generation.*
 
-<img src="/documentation/sample-card-1.png" width="300"><img src="/documentation/sample-card-2.png" width="300">
-*Sample generated with the highscore card generator.*
+<img src="/documentation/sample-card-1.png" width="400"><img src="/documentation/sample-card-2.png" width="400">
+
+*Samples generated with the highscore card generator.*
 
 Additionally, the service runner provides the generation of a global highscore card which includes multiple tables.
-This overlay can be opend via configurable shortcut every time using PinUP popper or playing a table.
+This overlay can be opend via configurable shortcut.
+
+
+![](./documentation/screen-overlay-1.png)
+*Configuration screen for overlay screen generation.*
 
 
+The __DOF Event Rules__ sections allows to trigger DOF commands based on events emitted by the 
+system or PinUP Popper:
 
+![](./documentation/screen-dof-1.png)
+*Configuration screen for DOF rules.*
 
-#Overview 
-###[Installation](#installation)
 
+The __Table Overview__ gives an overview about all tables installed in PinUP Popper
+and their VPin Extensions support status.
+
+
+![](./documentation/screen-tables-1.png)
+*Configuration screen for the table overview.*
 
 ## Installation
 
@@ -41,11 +58,39 @@ Once the installation is completed (including a JDK download), the folder should
 
 ## Configure Highscore Overlay
 
-## Configure Highscore Cards 
 
-![](./documentation/display-configuration.png)
+## Configure Highscore Cards
+
+The highscore card generation is enabled once a PinUP Popper screen has been selected.
+Currently, the screens __Other2__, __GameInfo__ and __GameHelp__ are supported.
+Be aware that if the __VPin Extensions Service__ is started, existing media in the
+corresponding PinUP Popper folder will be overwritten. An additional warning of this is visible in the UI for this.
+
+![](./documentation/card-warning.png)
+
+If no screen is selected, not highscore card is generation is disabled.
+
+For testing the generator output, a sample table can be selected and the button
+__Generate Sample Card__ will generate a sample highscore image and preview it in the right panel of the editor.
+
+![](./documentation/screen-cards-2.png)
+
+Be careful when selecting __another background image__. The selected image is not scaled or cropped in any form.
+It's recommend to select a matching size with a fix ratio of __16:9__ or __4:1__, because these are the 
+ratios supported by the PinUP popper screen configuration.
+
+### Screen Setup in PinUP Popper
+
+There is already a good documentation for this available at https://www.nailbuster.com/wikipinup/doku.php.
+The basic steps to show the generated highscore cards are explained here again nonetheless.
+The given screenshots are showing the setup where highscore cards are shown on the __Other 2__ screen.
+
+__Make sure that the screen is active in the global settings:__
+
+<img src="/documentation/display-configuration.png" width="400">
+
 
-![](./documentation/display-settings.png)
+<img src="/documentation/display-settings.png" width="400">
 
 ![](./documentation/key-binding.png)