Merge branch 'achievement-support' of https://git.jeddunk.xyz/jeddunk/GoldbergGUI into achievement-support

GoldbergGUI.Core/Services/GoldbergService.cs

@@ -208,6 +208,7 @@ namespace GoldbergGUI.Core.Services
         {
             _log.Info("Reading configuration...");
             var appId = -1;
+            var achievementList = new List<Achievement>();
             var dlcList = new List<DlcApp>();
             var steamAppidTxt = Path.Combine(path, "steam_appid.txt");
             if (File.Exists(steamAppidTxt))
@@ -221,6 +222,19 @@ namespace GoldbergGUI.Core.Services
                 _log.Info(@"""steam_appid.txt"" missing! Skipping...");
             }
 
+            var achievementJson = Path.Combine(path, "steam_settings", "achievements.json");
+            if (File.Exists(achievementJson))
+            {
+                _log.Info("Getting achievements...");
+                var json = await File.ReadAllTextAsync(achievementJson)
+                    .ConfigureAwait(false);
+                achievementList = System.Text.Json.JsonSerializer.Deserialize<List<Achievement>>(json);
+            }
+            else
+            {
+                _log.Info(@"""steam_settings/achievements.json"" missing! Skipping...");
+            }
+
             var dlcTxt = Path.Combine(path, "steam_settings", "DLC.txt");
             var appPathTxt = Path.Combine(path, "steam_settings", "app_paths.txt");
             if (File.Exists(dlcTxt))
@@ -263,6 +277,7 @@ namespace GoldbergGUI.Core.Services
             return new GoldbergConfiguration
             {
                 AppId = appId,
+                Achievements = achievementList,
                 DlcList = dlcList,
                 Offline = File.Exists(Path.Combine(path, "steam_settings", "offline.txt")),
                 DisableNetworking = File.Exists(Path.Combine(path, "steam_settings", "disable_networking.txt")),
@@ -303,6 +318,53 @@ namespace GoldbergGUI.Core.Services
             await File.WriteAllTextAsync(Path.Combine(path, "steam_appid.txt"), c.AppId.ToString())
                 .ConfigureAwait(false);
 
+            // Achievements + Images
+            if (c.Achievements.Count > 0)
+            {
+                _log.Info("Downloading images...");
+                var imagePath = Path.Combine(path, "steam_settings", "images");
+                Directory.CreateDirectory(imagePath);
+
+                foreach (var achievement in c.Achievements)
+                {
+                    await DownloadImageAsync(imagePath, achievement.Icon);
+                    await DownloadImageAsync(imagePath, achievement.IconGray);
+
+                    // Update achievement list to point to local images instead
+                    achievement.Icon = $"images/{Path.GetFileName(achievement.Icon)}";
+                    achievement.IconGray = $"images/{Path.GetFileName(achievement.IconGray)}";
+                }
+
+                _log.Info("Saving achievements...");
+
+                var achievementJson = System.Text.Json.JsonSerializer.Serialize(
+                    c.Achievements,
+                    new System.Text.Json.JsonSerializerOptions
+                    {
+                        Encoder = System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping,
+                        WriteIndented = true
+                    });
+                await File.WriteAllTextAsync(Path.Combine(path, "steam_settings", "achievements.json"), achievementJson)
+                    .ConfigureAwait(false);
+
+                _log.Info("Finished saving achievements.");
+            }
+            else
+            {
+                _log.Info("No achievements set! Removing achievement files...");
+                var imagePath = Path.Combine(path, "steam_settings", "images");
+                if (Directory.Exists(imagePath))
+                {
+                    Directory.Delete(imagePath);
+                }
+                var achievementPath = Path.Combine(path, "steam_settings", "achievements");
+                if (File.Exists(achievementPath))
+                {
+                    File.Delete(achievementPath);
+                }
+                _log.Info("Removed achievement files.");
+            }
+
             // DLC + App path
             if (c.DlcList.Count > 0)
             {
@@ -621,5 +683,22 @@ namespace GoldbergGUI.Core.Services
 
             return success;
         }
+
+        private async Task DownloadImageAsync(string imageFolder, string imageUrl)
+        {
+            var fileName = Path.GetFileName(imageUrl);
+            var targetPath = Path.Combine(imageFolder, fileName);
+            if (File.Exists(targetPath))
+            {
+                return;
+            }
+            else if (imageUrl.StartsWith("images/"))
+            {
+                _log.Warn($"Previously downloaded image '{imageUrl}' is now missing!");
+            }
+
+            var wc = new System.Net.WebClient();
+            await wc.DownloadFileTaskAsync(new Uri(imageUrl, UriKind.Absolute), targetPath);
+        }
     }
 }

GoldbergGUI.Core/Services/SteamService.cs

@@ -23,6 +23,7 @@ namespace GoldbergGUI.Core.Services
         public Task<IEnumerable<SteamApp>> GetListOfAppsByName(string name);
         public Task<SteamApp> GetAppByName(string name);
         public Task<SteamApp> GetAppById(int appid);
+        public Task<List<Achievement>> GetListOfAchievements(SteamApp steamApp);
         public Task<List<DlcApp>> GetListOfDlc(SteamApp steamApp, bool useSteamDb);
     }
 
@@ -81,6 +82,7 @@ namespace GoldbergGUI.Core.Services
         private const string AppTypeGame = "game";
         private const string AppTypeDlc = "dlc";
         private const string Database = "steamapps.cache";
+        private const string GameSchemaUrl = "https://api.steampowered.com/ISteamUserStats/GetSchemaForGame/v2/";
 
         private IMvxLog _log;
 
@@ -168,6 +170,32 @@ namespace GoldbergGUI.Core.Services
             return app;
         }
 
+        public async Task<List<Achievement>> GetListOfAchievements(SteamApp steamApp)
+        {
+            var achievementList = new List<Achievement>();
+            if (steamApp == null)
+            {
+                return achievementList;
+            }
+
+            _log.Info($"Getting achievements for App {steamApp}");
+
+            var client = new HttpClient();
+            client.DefaultRequestHeaders.UserAgent.ParseAdd(UserAgent);
+            var apiUrl = $"{GameSchemaUrl}?key={Secrets.SteamWebApiKey()}&appid={steamApp.AppId}&l=en";
+
+            var response = await client.GetAsync(apiUrl);
+            var responseBody = await response.Content.ReadAsStringAsync().ConfigureAwait(false);
+
+            var jsonResponse = JsonDocument.Parse(responseBody);
+            var achievementData = jsonResponse.RootElement.GetProperty("game")
+                .GetProperty("availableGameStats")
+                .GetProperty("achievements");
+
+            achievementList = JsonSerializer.Deserialize<List<Achievement>>(achievementData.GetRawText());
+            return achievementList;
+        }
+
         public async Task<List<DlcApp>> GetListOfDlc(SteamApp steamApp, bool useSteamDb)
         {
             var dlcList = new List<DlcApp>();

GoldbergGUI.Core/ViewModels/MainViewModel.cs

@@ -30,6 +30,7 @@ namespace GoldbergGUI.Core.ViewModels
         private int _appId;
 
         //private SteamApp _currentGame;
+        private ObservableCollection<Achievement> _achievements;
         private ObservableCollection<DlcApp> _dlcs;
         private string _accountName;
         private long _steamId;
@@ -142,6 +143,16 @@ namespace GoldbergGUI.Core.ViewModels
             }
         }
 
+        public ObservableCollection<Achievement> Achievements
+        {
+            get => _achievements;
+            set
+            {
+                _achievements = value;
+                RaisePropertyChanged(() => Achievements);
+            }
+        }
+
         public string AccountName
         {
             get => _accountName;
@@ -368,6 +379,33 @@ namespace GoldbergGUI.Core.ViewModels
             if (steamApp != null) GameName = steamApp.Name;
         }
 
+        public IMvxCommand GetListOfAchievementsCommand => new MvxAsyncCommand(GetListOfAchievements);
+
+        private async Task GetListOfAchievements()
+        {
+            if (AppId <= 0)
+            {
+                _log.Error("Invalid Steam App!");
+                return;
+            }
+
+            MainWindowEnabled = false;
+            StatusText = "Trying to get list of achievements...";
+            var listOfAchievements = await _steam.GetListOfAchievements(new SteamApp { AppId = AppId, Name = GameName });
+            Achievements = new MvxObservableCollection<Achievement>(listOfAchievements);
+            MainWindowEnabled = true;
+
+            if (Achievements.Count > 0)
+            {
+                var empty = Achievements.Count == 1 ? "" : "s";
+                StatusText = $"Successfully got {Achievements.Count} achievement{empty}! Ready.";
+            }
+            else
+            {
+                StatusText = "No achievements found! Ready.";
+            }
+        }
+
         public IMvxCommand GetListOfDlcCommand => new MvxAsyncCommand(GetListOfDlc);
 
         private async Task GetListOfDlc()
@@ -416,6 +454,7 @@ namespace GoldbergGUI.Core.ViewModels
             await _goldberg.Save(dirPath, new GoldbergConfiguration
             {
                 AppId = AppId,
+                Achievements = Achievements.ToList(),
                 DlcList = DLCs.ToList(),
                 Offline = Offline,
                 DisableNetworking = DisableNetworking,
@@ -526,6 +565,7 @@ namespace GoldbergGUI.Core.ViewModels
             DllPath = "Path to game's steam_api(64).dll...";
             GameName = "Game name...";
             AppId = -1;
+            Achievements = new ObservableCollection<Achievement>();
             DLCs = new ObservableCollection<DlcApp>();
             AccountName = "Account name...";
             SteamId = -1;
@@ -546,6 +586,7 @@ namespace GoldbergGUI.Core.ViewModels
         private void SetFormFromConfig(GoldbergConfiguration config)
         {
             AppId = config.AppId;
+            Achievements = new ObservableCollection<Achievement>(config.Achievements);
             DLCs = new ObservableCollection<DlcApp>(config.DlcList);
             Offline = config.Offline;
             DisableNetworking = config.DisableNetworking;

GoldbergGUI.WPF/Views/MainView.xaml

@@ -32,7 +32,7 @@
                     <Grid Margin="10,20,10,10">
                         <Grid.RowDefinitions>
                             <RowDefinition Height="Auto"/>
-                            <RowDefinition Height="Auto"/>
+                            <RowDefinition Height="Auto" MaxHeight="0"/>
                             <RowDefinition Height="Auto"/>
                             <RowDefinition/>
                         </Grid.RowDefinitions>
@@ -42,33 +42,71 @@
                         <TextBox Text="{Binding GameName, Mode=TwoWay}" TextWrapping="Wrap" VerticalAlignment="Center" Padding="1,0,0,0" Grid.Row="2" Margin="0,5,215,5" Height="20"/>
                         <Button Content="_Find ID..." Command="{Binding FindIdCommand}" Width="80" Grid.Row="2" Margin="0,5,130,5" HorizontalAlignment="Right" Height="20"/>
                         <TextBox Text="{Binding AppId, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}" TextWrapping="Wrap" HorizontalAlignment="Right" VerticalAlignment="Center" Padding="1,0,0,0" Grid.Row="2" Width="125" Margin="0,5,0,5" Height="20"/>
-                        <GroupBox Header="DLC" Grid.Row="3" Padding="0,0,0,0" Margin="0,5,0,0">
+                        <TabControl Grid.Row="3" Margin="0,5,0,0" Padding="0,0,0,0">
-                            <GroupBox.InputBindings>
+                            <TabItem Header="DLC">
-                                <KeyBinding Key="V" Modifiers="Control" 
+                                <TabItem.InputBindings>
-                                    Command="{Binding PasteDlcCommand}"/>
+                                    <KeyBinding Key="V" Modifiers="Control" Command="{Binding PasteDlcCommand}"/>
-                            </GroupBox.InputBindings>
+                                </TabItem.InputBindings>
-                            <Grid Margin="10,10,10,10">
+                                <Grid Margin="10,10,10,10">
-                                <Grid.RowDefinitions>
+                                    <Grid.RowDefinitions>
-                                    <RowDefinition/>
+                                        <RowDefinition/>
-                                    <RowDefinition Height="Auto"/>
+                                        <RowDefinition Height="Auto"/>
-                                </Grid.RowDefinitions>
+                                    </Grid.RowDefinitions>
-                                <DataGrid Margin="0,0,0,5" ItemsSource="{Binding DLCs, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}" SelectionMode="Extended" SelectionUnit="FullRow" HeadersVisibility="Column" AutoGenerateColumns="False" CanUserResizeColumns="False">
+                                    <DataGrid Margin="0,0,0,5" ItemsSource="{Binding DLCs, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}" SelectionMode="Extended" SelectionUnit="FullRow" HeadersVisibility="Column" AutoGenerateColumns="False" CanUserResizeColumns="False">
-                                    <DataGrid.Columns>
+                                        <DataGrid.Columns>
-                                        <DataGridTextColumn Header="App ID" Binding="{Binding AppId}" Width="80" />
+                                            <DataGridTextColumn Header="App ID" Binding="{Binding AppId}" Width="80" />
-                                        <DataGridTextColumn Header="Name" Binding="{Binding Name}" Width="*" />
+                                            <DataGridTextColumn Header="Name" Binding="{Binding Name}" Width="*" />
-                                        <!--<DataGridTextColumn Header="Depot ID" Binding="{Binding DepotId}" Width="80" Visibility="{Binding Source={x:Reference ShowOptionalDlcSettings}, Path=IsChecked, Converter={StaticResource B2V}}"/>
+                                            <!--<DataGridTextColumn Header="Depot ID" Binding="{Binding DepotId}" Width="80" Visibility="{Binding Source={x:Reference ShowOptionalDlcSettings}, Path=IsChecked, Converter={StaticResource B2V}}"/>
-                                        <DataGridTextColumn Header="Depot Name" Binding="{Binding DepotName}" Width="*" Visibility="{Binding Source={x:Reference ShowOptionalDlcSettings}, Path=IsChecked, Converter={StaticResource B2V}}" />-->
+                                            <DataGridTextColumn Header="Depot Name" Binding="{Binding DepotName}" Width="*" Visibility="{Binding Source={x:Reference ShowOptionalDlcSettings}, Path=IsChecked, Converter={StaticResource B2V}}" />-->
-                                        <DataGridTextColumn Header="App Path" Binding="{Binding AppPath}" Width="*" Visibility="{Binding Source={x:Reference ShowOptionalDlcSettings}, Path=IsChecked, Converter={StaticResource B2V}}" />
+                                            <DataGridTextColumn Header="App Path" Binding="{Binding AppPath}" Width="*" Visibility="{Binding Source={x:Reference ShowOptionalDlcSettings}, Path=IsChecked, Converter={StaticResource B2V}}" />
-                                    </DataGrid.Columns>
+                                        </DataGrid.Columns>
-                                </DataGrid>
+                                    </DataGrid>
-                                <CheckBox Grid.Row="1" x:Name="ShowOptionalDlcSettings" Margin="0,5,0,0" Content="Show optional settings"/>
+                                    <Grid Grid.Row="1">
-                                <Button Content="Get _DLCs for AppID" Command="{Binding GetListOfDlcCommand}" Grid.Row="1" Width="120" HorizontalAlignment="Right" Margin="0,5,0,0" Height="20"/>
+                                        <Grid.ColumnDefinitions>
-                            </Grid>
+                                            <ColumnDefinition Width="*" />
-                        </GroupBox>
+                                            <ColumnDefinition Width="Auto" />
+                                            <ColumnDefinition Width="Auto" />
+                                        </Grid.ColumnDefinitions>
+                                        <CheckBox x:Name="ShowOptionalDlcSettings" Margin="0,5,0,0" Content="Show optional settings"/>
+                                        <Button Grid.Column="2" Content="Get _DLCs for AppID" Command="{Binding GetListOfDlcCommand}" HorizontalAlignment="Right" Margin="0,5,0,0" Height="20" Width="117"/>
+                                    </Grid>
+                                </Grid>
+                            </TabItem>
+                            <TabItem Header="Achievements" IsEnabled="{Binding DllSelected, UpdateSourceTrigger=PropertyChanged}">
+                                <Grid Margin="10,10,10,10">
+                                    <Grid.RowDefinitions>
+                                        <RowDefinition/>
+                                        <RowDefinition Height="Auto"/>
+                                    </Grid.RowDefinitions>
+                                    <DataGrid Margin="0,0,0,5" ItemsSource="{Binding Achievements, Mode=OneWay, UpdateSourceTrigger=PropertyChanged}" SelectionMode="Extended" SelectionUnit="FullRow" HeadersVisibility="Column" AutoGenerateColumns="False" CanUserResizeColumns="True" IsReadOnly="True">
+                                        <DataGrid.Columns>
+                                            <DataGridTextColumn Header="Name" Binding="{Binding DisplayName}" Width="*"/>
+                                            <DataGridTextColumn Header="Description" Binding="{Binding Description}" Width="*"/>
+                                            <DataGridCheckBoxColumn Header="Hidden" Binding="{Binding Hidden}" Width="60" CanUserResize="False"/>
+                                        </DataGrid.Columns>
+                                    </DataGrid>
+                                    <Grid Grid.Row="1">
+                                        <Grid.ColumnDefinitions>
+                                            <ColumnDefinition Width="*"/>
+                                            <ColumnDefinition Width="Auto"/>
+                                        </Grid.ColumnDefinitions>
+                                        <Button Grid.Row="1" Grid.Column="1" Content="Get _Achievements for AppID" Command="{Binding GetListOfAchievementsCommand}" Margin="0,5,0,0" HorizontalAlignment="Right" Width="165" />
+                                    </Grid>
+                                </Grid>
+                            </TabItem>
+                            <TabItem Header="Misc" IsEnabled="{Binding DllSelected, UpdateSourceTrigger=PropertyChanged}">
+                                <StackPanel Margin="10,10,10,10">
+                                    <Button Content="_Generate steam__interfaces.txt" IsEnabled="{Binding SteamInterfacesTxtExists, UpdateSourceTrigger=PropertyChanged}" Command="{Binding GenerateSteamInterfacesCommand}" Height="20" Margin="0,0,0,5" />
+                                    <CheckBox Content="Offline" IsChecked="{Binding Offline, Mode=TwoWay}" Height="20" VerticalAlignment="Stretch" VerticalContentAlignment="Center"/>
+                                    <CheckBox Content="Disable Networking" IsChecked="{Binding DisableNetworking, Mode=TwoWay}" Height="20" VerticalContentAlignment="Center"/>
+                                    <CheckBox Content="Disable Overlay" IsChecked="{Binding DisableOverlay, Mode=TwoWay}" Height="20" VerticalContentAlignment="Center" IsEnabled="False"/>
+                                </StackPanel>
+                            </TabItem>
+                        </TabControl>
                     </Grid>
                 </TabItem>
                 <!-- Advanced -->
-                <TabItem Header="Advanced" IsEnabled="{Binding DllSelected, UpdateSourceTrigger=PropertyChanged}">
+                <!--<TabItem Header="Advanced" IsEnabled="{Binding DllSelected, UpdateSourceTrigger=PropertyChanged}">
                     <Grid HorizontalAlignment="Stretch" Margin="10,20,10,10" >
                         <Grid.RowDefinitions>
                             <RowDefinition Height="Auto"/>
@@ -94,7 +132,7 @@
                             </StackPanel>
                         </GroupBox>
                     </Grid>
-                </TabItem>
+                </TabItem>-->
                 <!-- Settings -->
                 <TabItem Header="Global Settings">
                     <StackPanel Margin="10,20,10,10">
@@ -117,7 +155,7 @@
                             <CheckBox Content="Global" Grid.Row="0" Grid.Column="2" HorizontalAlignment="Right" 
                                       Margin="10,0,5,0" VerticalAlignment="Center" IsChecked="True" 
                                       IsEnabled="False"/>
-                                      <!--
+                            <!--
                                       IsEnabled="{Binding DllSelected, UpdateSourceTrigger=PropertyChanged}"/>
                                       -->
                             <Label Content="Steam64ID" HorizontalAlignment="Left" Grid.Row="1"
@@ -126,7 +164,7 @@
                             <CheckBox Content="Global" Grid.Row="1" Grid.Column="2" HorizontalAlignment="Right" 
                                       Margin="10,0,5,0" VerticalAlignment="Center" IsChecked="True" 
                                       IsEnabled="False"/>
-                                      <!--
+                            <!--
                                       IsEnabled="{Binding DllSelected, UpdateSourceTrigger=PropertyChanged}"/>
                                       -->
                             <Label Content="Language" HorizontalAlignment="Left" Grid.Row="2"
@@ -135,7 +173,7 @@
                             <CheckBox Content="Global" Grid.Row="2" Grid.Column="2" HorizontalAlignment="Right" 
                                       Margin="10,0,5,0" VerticalAlignment="Center" IsChecked="True" 
                                       IsEnabled="False"/>
-                                      <!--
+                            <!--
                                       IsEnabled="{Binding DllSelected, UpdateSourceTrigger=PropertyChanged}"/>
                                       -->
                             <Label Content="Custom Broadcast Addresses:" HorizontalAlignment="Left"
@@ -170,6 +208,8 @@
                                         <TextBlock Text="Developed by Jeddunk" />
                                         <TextBlock Text="Licensed under GNU GPLv3" />
                                         <TextBlock Text="Goldberg Emulator is owned by Mr. Goldberg and licensed under GNU LGPLv3" Margin="0,10,0,0"/>
+                                        <TextBlock Text="Contributors:" Margin="0,10,0,0" FontWeight="Bold"/>
+                                        <TextBlock Text="UrbanCMC" Margin="0,5,0,0"/>
                                     </StackPanel>
                                 </DataTemplate>
                             </Label.ContentTemplate>

GoldbergGUI.sln

@@ -9,6 +9,12 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "GoldbergGUI.WPF", "Goldberg
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SteamStorefrontAPI", "SteamStorefrontAPI\SteamStorefrontAPI\SteamStorefrontAPI.csproj", "{42D17FA4-C45C-4CC1-BA9C-80B3FA1C006D}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{4E7DA860-D7FD-4090-B7EC-6DA3974DC845}"
+	ProjectSection(SolutionItems) = preProject
+		COPYING = COPYING
+		README.md = README.md
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU

README.md

@@ -30,7 +30,7 @@ While the most used options are available right now, I am planning to support al
 * Subscribed Groups
 * Mods (Steam Workshop)
 * Inventory and Items
-* Achievements
+* ~~Achievements~~
 * Stats, Leaderboards
 * Controller (Steam Input)
 
@@ -40,8 +40,20 @@ Apart from those, I'm also always looking into improving the user experience of
 
 Goldberg Emulator is owned by Mr. Goldberg and licensed under the GNU Lesser General Public License v3.0.
 
+### Contributors
+
+* [UrbanCMC](https://github.com/UrbanCMC/) - Implementation of achievements
+
+### Dependencies
+
+* AngleSharp
+* MvvmCross
+* NinjaNye
+* Serilog
+* SharpCompress
+* sqlite-net-pcl
+* My fork of SteamStorefrontAPI
+
 ## License
 
 GoldbergGUI is licensed under the GNU General Public License v3.0.
-
-Dependencies will be listed ASAP.