From d41376517866d924bdd95029076afb7f0c9813a3 Mon Sep 17 00:00:00 2001
From: Jiiniasu <jiiniasu@gief.info>
Date: Sun, 4 Sep 2016 18:32:24 +0200
Subject: [PATCH] Add Highscore Style Setting

Add ability to select whether the highscore screen should display all
scores or only the best score for each player, difficulty and
duet-track.
---
 Output/Languages/English.xml                  |  3 +
 .../Ambient/Screens/ScreenOptionsGame.xml     | 58 ++++++++++++++++++-
 .../Changelog/Changelog_ScreenOptionsGame.txt |  6 ++
 Vocaluxe/Base/CConfig.cs                      |  1 +
 Vocaluxe/Base/CMain.cs                        |  5 ++
 Vocaluxe/Lib/Database/CHighscoreDB.cs         |  9 ++-
 Vocaluxe/Screens/CScreenOptionsGame.cs        |  7 ++-
 VocaluxeLib/Enums.cs                          |  6 ++
 VocaluxeLib/IBasic.cs                         |  2 +
 9 files changed, 92 insertions(+), 5 deletions(-)

diff --git a/Output/Languages/English.xml b/Output/Languages/English.xml
index f5fc89bc..c3aefaf8 100644
--- a/Output/Languages/English.xml
+++ b/Output/Languages/English.xml
@@ -73,6 +73,8 @@
   <string name="TR_CONFIG_TIMERMODE_TOTAL">Total</string>
   <string name="TR_CONFIG_TIMERLOOK_NORMAL">Normal</string>
   <string name="TR_CONFIG_TIMERLOOK_EXPANDED">Expanded</string>
+  <string name="TR_CONFIG_HIGHSCORE_LIST_ALL">List all</string>
+  <string name="TR_CONFIG_HIGHSCORE_LIST_BEST">List best</string>
   <string name="TR_CONFIG_OWN_MUSIC">Own music and background-music</string>
   <string name="TR_CONFIG_NO_OWN_MUSIC">No own music</string>
   <string name="TR_CONFIG_ONLY_OWN_MUSIC">Only own music</string>
@@ -183,6 +185,7 @@
   <string name="TR_SCREENOGAME_TABS">Tabs</string>
   <string name="TR_SCREENOGAME_DIFFICULTY">Game difficulty</string>
   <string name="TR_SCREENOGAME_TIMERMODE">Timer mode</string>
+  <string name="TR_SCREENOGAME_HIGHSCORESTYLE">Highscore style</string>
   <string name="TR_SCREENORECORD_OPTIONS">Record Options</string>
   <string name="TR_SCREENORECORD_DEVICE">Device</string>
   <string name="TR_SCREENORECORD_INPUT">Input</string>
diff --git a/Output/Themes/Ambient/Screens/ScreenOptionsGame.xml b/Output/Themes/Ambient/Screens/ScreenOptionsGame.xml
index 5b3b6ec4..c546c94a 100644
--- a/Output/Themes/Ambient/Screens/ScreenOptionsGame.xml
+++ b/Output/Themes/Ambient/Screens/ScreenOptionsGame.xml
@@ -2,7 +2,7 @@
 <Screen xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <Informations>
     <ScreenName>ScreenOptionsGame</ScreenName>
-    <ScreenVersion>2</ScreenVersion>
+    <ScreenVersion>3</ScreenVersion>
   </Informations>
   <Backgrounds>
     <Background Name="Background1">
@@ -191,6 +191,20 @@
       <Font>Outline</Font>
       <Text>TR_SCREENOGAME_TIMERMODE</Text>
     </Text>
+    <Text Name="Text8">
+      <X>75</X>
+      <Y>467</Y>
+      <Z>0</Z>
+      <H>27</H>
+      <MaxW>0</MaxW>
+      <Color Name="StaticColor" />
+      <SelColor Name="TextSelColor" />
+      <Align>Left</Align>
+      <ResizeAlign>Center</ResizeAlign>
+      <Style>Bold</Style>
+      <Font>Outline</Font>
+      <Text>TR_SCREENOGAME_HIGHSCORESTYLE</Text>
+    </Text>
   </Texts>
   <Buttons>
     <Button Name="ButtonExit">
@@ -519,6 +533,48 @@
       <TextStyle>Bold</TextStyle>
       <NumVisible>3</NumVisible>
     </SelectSlide>
+    <SelectSlide Name="SelectSlideHighscoreStyle">
+      <Skin/>
+      <SkinArrowLeft>SelectSlideArrowLeft</SkinArrowLeft>
+      <SkinArrowRight>SelectSlideArrowRight</SkinArrowRight>
+      <SkinSelected>SelectSlide</SkinSelected>
+      <SkinArrowLeftSelected>SelectSlideArrowLeft</SkinArrowLeftSelected>
+      <SkinArrowRightSelected>SelectSlideArrowRight</SkinArrowRightSelected>
+      <Rect>
+        <X>500</X>
+        <Y>460</Y>
+        <W>700</W>
+        <H>50</H>
+        <Z>0</Z>
+      </Rect>
+      <RectArrowLeft>
+        <X>505</X>
+        <Y>465</Y>
+        <W>40</W>
+        <H>40</H>
+        <Z>0</Z>
+      </RectArrowLeft>
+      <RectArrowRight>
+        <X>1170</X>
+        <Y>465</Y>
+        <W>40</W>
+        <H>40</H>
+        <Z>0</Z>
+      </RectArrowRight>
+      <Color Name="SelectSlideColor" />
+      <SelColor Name="SelectSlideSelColor" />
+      <ArrowColor Name="ArrowColor" />
+      <ArrowSelColor Name="ArrowSelColor" />
+      <TextColor Name="TextColor" />
+      <TextSelColor Name="TextSelColor" />
+      <TextH>27</TextH>
+      <TextRelativeX>50</TextRelativeX>
+      <TextRelativeY>0</TextRelativeY>
+      <TextMaxW>205.33</TextMaxW>
+      <TextFont>Outline</TextFont>
+      <TextStyle>Bold</TextStyle>
+      <NumVisible>2</NumVisible>
+    </SelectSlide>
   </SelectSlides>
   <SingNotes />
   <NameSelections />
diff --git a/Output/Themes/Changelog/Changelog_ScreenOptionsGame.txt b/Output/Themes/Changelog/Changelog_ScreenOptionsGame.txt
index e60b7e4a..fcc4de50 100644
--- a/Output/Themes/Changelog/Changelog_ScreenOptionsGame.txt
+++ b/Output/Themes/Changelog/Changelog_ScreenOptionsGame.txt
@@ -1,5 +1,11 @@
 ScreenOptionsGame
 
+++++++++++
+Version 3:
+
+Add:
+<Text8>
+<SelectSlideHighscoreStyle>
 ++++++++++
 Version 2:
 
diff --git a/Vocaluxe/Base/CConfig.cs b/Vocaluxe/Base/CConfig.cs
index 85d7d409..fccfed10 100644
--- a/Vocaluxe/Base/CConfig.cs
+++ b/Vocaluxe/Base/CConfig.cs
@@ -139,6 +139,7 @@ namespace Vocaluxe.Base
             [DefaultValue(ELyricsPosition.TR_CONFIG_LYRICSPOSITION_BOTTOM)] public ELyricsPosition LyricsPosition;
             [DefaultValue(0.1f)] public float MinLineBreakTime; //Minimum time to show the text before it is (to be) sung (if possible)
             [XmlArrayItem("Player"), XmlArray] public string[] Players;
+            [DefaultValue(EHighscoreStyle.TR_CONFIG_HIGHSCORE_LIST_BEST)] public EHighscoreStyle HighscoreStyle;
         }
 
         public struct SConfigVideo
diff --git a/Vocaluxe/Base/CMain.cs b/Vocaluxe/Base/CMain.cs
index b5d2e0c7..3a131649 100644
--- a/Vocaluxe/Base/CMain.cs
+++ b/Vocaluxe/Base/CMain.cs
@@ -91,6 +91,11 @@ namespace Vocaluxe.Base
             return CConfig.SongMenu;
         }
 
+        public EHighscoreStyle GetHighscoreStyle()
+        {
+            return CConfig.Config.Game.HighscoreStyle;
+        }
+
         public EOffOn GetVideosToBackground()
         {
             return CConfig.Config.Video.VideosToBackground;
diff --git a/Vocaluxe/Lib/Database/CHighscoreDB.cs b/Vocaluxe/Lib/Database/CHighscoreDB.cs
index 6733e217..cc122fec 100644
--- a/Vocaluxe/Lib/Database/CHighscoreDB.cs
+++ b/Vocaluxe/Lib/Database/CHighscoreDB.cs
@@ -305,8 +305,13 @@ namespace Vocaluxe.Lib.Database
                         return scores;
 
                     command.CommandText = "SELECT PlayerName, Score, Date, Difficulty, LineNr, id FROM Scores " +
-                                          "WHERE [SongID] = @SongID AND [Medley] = @Medley AND [Duet] = @Duet AND [ShortSong] = @ShortSong " +
-                                          "ORDER BY [Score] DESC";
+                                          "WHERE [SongID] = @SongID AND [Medley] = @Medley AND [Duet] = @Duet AND [ShortSong] = @ShortSong ";
+                    if (CBase.Config.GetHighscoreStyle() == EHighscoreStyle.TR_CONFIG_HIGHSCORE_LIST_BEST)
+                    {
+                        command.CommandText += "GROUP BY PlayerName, Difficulty, LineNr ";
+                    }
+                    command.CommandText += "ORDER BY [Score] DESC, [Date] ASC";
+
                     command.Parameters.Add("@SongID", DbType.Int32, 0).Value = dataBaseSongID;
                     command.Parameters.Add("@Medley", DbType.Int32, 0).Value = medley;
                     command.Parameters.Add("@Duet", DbType.Int32, 0).Value = duet;
diff --git a/Vocaluxe/Screens/CScreenOptionsGame.cs b/Vocaluxe/Screens/CScreenOptionsGame.cs
index 71ff7197..485ce2b0 100644
--- a/Vocaluxe/Screens/CScreenOptionsGame.cs
+++ b/Vocaluxe/Screens/CScreenOptionsGame.cs
@@ -27,7 +27,7 @@ namespace Vocaluxe.Screens
         // Version number for theme files. Increment it, if you've changed something on the theme files!
         protected override int _ScreenVersion
         {
-            get { return 2; }
+            get { return 3; }
         }
 
         private const string _SelectSlideLanguage = "SelectSlideLanguage";
@@ -36,6 +36,7 @@ namespace Vocaluxe.Screens
         private const string _SelectSlideSongSorting = "SelectSlideSongSorting";
         private const string _SelectSlideTabs = "SelectSlideTabs";
         private const string _SelectSlideTimerMode = "SelectSlideTimerMode";
+        private const string _SelectSlideHighscoreStyle = "SelectSlideHighscoreStyle";
 
         private const string _ButtonExit = "ButtonExit";
         private const string _ButtonServer = "ButtonServer";
@@ -45,7 +46,7 @@ namespace Vocaluxe.Screens
             base.Init();
 
             _ThemeButtons = new string[] {_ButtonExit, _ButtonServer};
-            _ThemeSelectSlides = new string[] {_SelectSlideLanguage, _SelectSlideDebugLevel, _SelectSlideSongMenu, _SelectSlideSongSorting, _SelectSlideTabs, _SelectSlideTimerMode};
+            _ThemeSelectSlides = new string[] {_SelectSlideLanguage, _SelectSlideDebugLevel, _SelectSlideSongMenu, _SelectSlideSongSorting, _SelectSlideTabs, _SelectSlideTimerMode, _SelectSlideHighscoreStyle};
         }
 
         public override void LoadTheme(string xmlPath)
@@ -60,6 +61,7 @@ namespace Vocaluxe.Screens
             _SelectSlides[_SelectSlideSongSorting].SetValues<ESongSorting>((int)CConfig.Config.Game.SongSorting);
             _SelectSlides[_SelectSlideTabs].SetValues<EOffOn>((int)CConfig.Config.Game.Tabs);
             _SelectSlides[_SelectSlideTimerMode].SetValues<ETimerMode>((int)CConfig.Config.Game.TimerMode);
+            _SelectSlides[_SelectSlideHighscoreStyle].SetValues<EHighscoreStyle>((int)CConfig.Config.Game.HighscoreStyle);
         }
 
         public override bool HandleInput(SKeyEvent keyEvent)
@@ -140,6 +142,7 @@ namespace Vocaluxe.Screens
             CConfig.Config.Game.SongSorting = (ESongSorting)_SelectSlides[_SelectSlideSongSorting].Selection;
             CConfig.Config.Game.Tabs = (EOffOn)_SelectSlides[_SelectSlideTabs].Selection;
             CConfig.Config.Game.TimerMode = (ETimerMode)_SelectSlides[_SelectSlideTimerMode].Selection;
+            CConfig.Config.Game.HighscoreStyle = (EHighscoreStyle)_SelectSlides[_SelectSlideHighscoreStyle].Selection;
 
             CConfig.SaveConfig();
 
diff --git a/VocaluxeLib/Enums.cs b/VocaluxeLib/Enums.cs
index fb4f08a2..39e8399f 100644
--- a/VocaluxeLib/Enums.cs
+++ b/VocaluxeLib/Enums.cs
@@ -369,6 +369,12 @@ namespace VocaluxeLib
         Game
     }
 
+    public enum EHighscoreStyle
+    {
+        TR_CONFIG_HIGHSCORE_LIST_ALL,
+        TR_CONFIG_HIGHSCORE_LIST_BEST
+    }
+
     /// <summary>
     ///     Base screens
     /// </summary>
diff --git a/VocaluxeLib/IBasic.cs b/VocaluxeLib/IBasic.cs
index 1374ae86..0e35883e 100644
--- a/VocaluxeLib/IBasic.cs
+++ b/VocaluxeLib/IBasic.cs
@@ -46,6 +46,8 @@ namespace VocaluxeLib
 
         ESongMenu GetSongMenuType();
 
+        EHighscoreStyle GetHighscoreStyle();
+
         EOffOn GetDrawNoteLines();
         EOffOn GetDrawToneHelper();