RAWG

[sgamesdev]

How did you use the RAWG API in your app

[lpeyr]

The RAWG API is used to fetch data about games information, such as the cover image, ratings, achievements, etc... To get this information, Gavilya uses RestSharp to fetch the RAWG API. But before that, the user must associate the game to a RAWG (game) ID using a search dialog. The RAWG ID of the game is then stored in the Games.gav file. After associating the game to a RAWG ID, Gavilya can use the data from the API.
For example, here's the code that gets the ratings of a game from its RAWG ID:

Gavilya/Gavilya/Classes/Global.cs

Lines 361 to 387 in 5aa610f

	/// <summary>
	/// Gets the game rating from it's id.
	/// </summary>
	/// <param name="id">The id of the game.</param>
	/// <returns></returns>
	public static async Task<float> GetGameRatingAsync(int id)
	{
	try
	{
	var client = new RestClient(new Uri($"https://api.rawg.io/api/games/{id}")); // Create a REST Client
	var request = new RestRequest
	{
	Method = Method.Get
	}; // Create a request
	request.AddQueryParameter("key", APIKeys.RAWGAPIKey);
	var response = await client.ExecuteAsync(request); // Execute the request and store the result
	var game = JsonSerializer.Deserialize<Game>(response.Content); // Deserialize the content of the reponse
	return game.rating;
	}
	catch (Exception ex)
	{
	MessageBox.Show(ex.Message, Properties.Resources.MainWindowTitle, MessageBoxButton.OK, MessageBoxImage.Error); // Error
	return 0f;
	}
	}

Note Most of the code in this method was generated using Nightingale REST Client. I had to update it since I updated RestSharp to a version that contained breaking changes.

More RAWG-related methods are available in the Global.cs file.

You'll notice that the JSON returned by the API is deserialized to a Game object which contains all different properties about a game.
It's available in Gavilya.SDK which is a separated module of Gavilya that is used as a library.

Gavilya/Gavilya.SDK/RAWG/Game.cs

Lines 1 to 156 in 5aa610f

	/*
	MIT License
	Copyright (c) Léo Corporation
	Permission is hereby granted, free of charge, to any person obtaining a copy
	of this software and associated documentation files (the "Software"), to deal
	in the Software without restriction, including without limitation the rights
	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	copies of the Software, and to permit persons to whom the Software is
	furnished to do so, subject to the following conditions:
	The above copyright notice and this permission notice shall be included in all
	copies or substantial portions of the Software.
	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	SOFTWARE.
	*/
	using System.Collections.Generic;
	namespace Gavilya.SDK.RAWG
	{
	public class GamesResults
	{
	public int count { get; set; }
	public string next { get; set; }
	public string previous { get; set; }
	public List<Game> results { get; set; }
	public bool user_platform { get; set; }
	}
	public class Game
	{
	public string slug { get; set; }
	public string name { get; set; }
	public string description { get; set; }
	public string description_raw { get; set; }
	public int playtime { get; set; }
	public List<ReturnedPlatforms> platforms { get; set; }
	public List<ParentStore> stores { get; set; }
	public string released { get; set; }
	public bool tba { get; set; }
	public string background_image { get; set; }
	public string background_image_additional { get; set; }
	public float rating { get; set; }
	public int rating_top { get; set; }
	public List<Rating> ratings { get; set; }
	public int rating_count { get; set; }
	public int review_text_count { get; set; }
	public int added { get; set; }
	public Added_By_Status added_by_status { get; set; }
	public int? metacritic { get; set; }
	public int suggestion_count { get; set; }
	public int id { get; set; }
	public object score { get; set; }
	public Clip clip { get; set; }
	public List<Tag> tags { get; set; }
	public object user_count { get; set; }
	public int reviews_count { get; set; }
	public string saturated_color { get; set; }
	public string dominant_color { get; set; }
	public List<Short_Screenshot> short_screenshots { get; set; }
	public List<Parent_Platform> parent_platforms { get; set; }
	public Genre[] genres { get; set; }
	}
	public class Added_By_Status
	{
	public int yet { get; set; }
	public int owned { get; set; }
	public int beaten { get; set; }
	public int toplay { get; set; }
	public int dropped { get; set; }
	public int playing { get; set; }
	}
	public class Clip
	{
	public string clip { get; set; }
	public Clips clips { get; set; }
	public string video { get; set; }
	public string preview { get; set; }
	}
	public class Clips
	{
	public string _320 { get; set; }
	public string _640 { get; set; }
	public string full { get; set; }
	}
	public class Genre
	{
	public int id { get; set; }
	public string name { get; set; }
	public string slug { get; set; }
	}
	public class Parent_Platform
	{
	public Platform platform { get; set; }
	}
	public class ReturnedPlatforms
	{
	public Platform platform { get; set; }
	}
	public class Platform
	{
	public int id { get; set; }
	public string name { get; set; }
	public string slug { get; set; }
	}
	public class Rating
	{
	public int id { get; set; }
	public string title { get; set; }
	public int count { get; set; }
	public float percent { get; set; }
	}
	public class Short_Screenshot
	{
	public int id { get; set; }
	public string image { get; set; }
	}
	public class ParentStore
	{
	public Store store { get; set; }
	}
	public class Store
	{
	public int id { get; set; }
	public string name { get; set; }
	public string slug { get; set; }
	}
	public class Tag
	{
	public int id { get; set; }
	public string name { get; set; }
	public string slug { get; set; }
	public string language { get; set; }
	public int games_count { get; set; }
	public string image_background { get; set; }
	}
	}

To use the API, you need an API key that isn't publicly available in this repo. I have two APIKeys class: one that is public and empty, and one that is local, so the app can still compile.
Here's how it looks like:

Gavilya/Gavilya/Classes/APIKeys.cs

Lines 25 to 35 in 5aa610f

	namespace Gavilya.Classes;
	public static partial class APIKeys
	{
	/// <summary>
	/// The RAWG.io API key. DO NOT SET A VALUE DIRECTLY IN A FILE THAT MIGHT BE PUBLISHED TO GITHUB.
	/// <para>YOUR API KEY IS SECRET!</para>
	/// <para>Define your API keys in a copy of <see cref="APIKeys"/> called <c>APIKeysLocal.cs</c></para>
	/// </summary>
	public static readonly string RAWGAPIKey = "";
	}

The local one: (named APIKeysLocal.cs)

public static partial class APIKeys
{
	static APIKeys()
	{
		RAWGAPIKey = "API_KEY_HERE";
	}
}

You can learn more about RestSharp here.
You can check the RAWG API documentation here.

[sgamesdev]

Is there anyway to get the game genres , to convert the list to a string ?

[lpeyr]

Yes, I guess you could use the following code (if you know the game id):

// Don't forget to include the SDK.
using Gavilya.SDK.RAWG;


var client = new RestClient(new Uri($"https://api.rawg.io/api/games/{id}")); // Create a REST Client 
var request = new RestRequest 
{ 
 	Method = Method.Get 
}; // Create a request 
request.AddQueryParameter("key", APIKeys.RAWGAPIKey); 
var response = await client.ExecuteAsync(request); // Execute the request and store the result 
  
var game = JsonSerializer.Deserialize<Game>(response.Content); // Deserialize the content of the reponse 
string s = ""; // The string

for (int i = 0; i < game.genres.Length; i++)
{
	s += $"{game.genres[i].name}\n"; // Convert the list to a string
}

For Minecraft s would be equal to:

Action
Arcade
Simulation
Indie
Massively Multiplayer

[sgamesdev]

how did you do the achievement system

[lpeyr]

Achievements are a bit different from other requests to the RAWG API. Indeed, the URL where the request is sent is not the same as usual, and it also returns a different JSON object, which will be deserialized into the AchievementsResult class. This class contains a List of Achievement named results. The Achievement class contains different property:

• id
• name
• description
• image
• percent (The percentage of players who have unlocked this achievement)

To get the achievements of a game, Gavilya uses the GetAchievementsAsync() method:

Gavilya/Gavilya/Classes/Global.cs

Lines 417 to 443 in 5aa610f

	/// <summary>
	/// Gets the game achivements from its id.
	/// </summary>
	/// <param name="id">The id of the game.</param>
	/// <returns></returns>
	public static async Task<List<Achievement>> GetAchievementsAsync(int id)
	{
	try
	{
	var client = new RestClient(new Uri($"https://api.rawg.io/api/games/{id}/achievements?")); // Create a REST Client
	var request = new RestRequest
	{
	Method = Method.Get
	}; // Create a request
	request.AddQueryParameter("key", APIKeys.RAWGAPIKey);
	request.AddQueryParameter("page_size", "20");
	var response = await client.ExecuteAsync(request); // Execute the request and store the result
	var achievementsResults = JsonSerializer.Deserialize<AchievementsResults>(response.Content); // Deserialize the content of the reponse
	return achievementsResults.results ?? new(); // Return the results
	}
	catch (Exception ex)
	{
	MessageBox.Show(ex.Message, Properties.Resources.MainWindowTitle, MessageBoxButton.OK, MessageBoxImage.Error); // Error
	return new();
	}
	}

Note Gavilya only displays the first 20 achievements of a game.

Achievements are displayed in a section of the GameInfoPage using the AchievementItem user control, using the data that was returned by the RAWG API.

XAML

Gavilya/Gavilya/UserControls/AchievementItem.xaml

Lines 1 to 17 in 5aa610f

	<UserControl x:Class="Gavilya.UserControls.AchievementItem" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:d="http://schemas.microsoft.com/expression/blend/2008" xmlns:local="clr-namespace:Gavilya.UserControls" FontFamily="../Fonts/#Hauora" Foreground="White" mc:Ignorable="d" Height="85" d:DesignWidth="800" Margin="5" MaxWidth="800">
	<Border CornerRadius="10" Background="#FF141428">
	<Grid>
	<Grid.ColumnDefinitions>
	<ColumnDefinition Width="Auto" />
	<ColumnDefinition />
	</Grid.ColumnDefinitions>
	<Image x:Name="AchievementImg" Grid.Column="0" Margin="10" />
	<StackPanel MaxWidth="800" Grid.Column="1">
	<TextBlock x:Name="AchievementNameTxt" d:Text="AchievementName" FontSize="18" FontWeight="ExtraBold" Margin="0,10,0,0" />
	<TextBlock x:Name="AchievementDescriptionTxt" d:Text="AchievementDescription" FontSize="12" TextWrapping="Wrap" />
	<TextBlock x:Name="AchievementPourcentTxt" d:Text="AchievementPourcent" FontSize="12" TextWrapping="Wrap" VerticalAlignment="Bottom" Margin="0,10,0,0" />
	</StackPanel>
	</Grid>
	</Border>
	</UserControl>

C#

Gavilya/Gavilya/UserControls/AchievementItem.xaml.cs

Lines 24 to 56 in 5aa610f

	using Gavilya.SDK.RAWG;
	using System;
	using System.Windows.Controls;
	using System.Windows.Media.Imaging;
	namespace Gavilya.UserControls;
	/// <summary>
	/// Interaction logic for AchievementItem.xaml
	/// </summary>
	public partial class AchievementItem : UserControl
	{
	public AchievementItem(Achievement achievement)
	{
	InitializeComponent();
	InitUI(achievement); // Loads the UI
	}
	private void InitUI(Achievement achievement)
	{
	var image = new BitmapImage();
	image.BeginInit();
	image.UriSource = new Uri(achievement.image);
	image.DecodePixelWidth = 50;
	image.EndInit();
	AchievementImg.Source = image; // Set the image
	AchievementNameTxt.Text = achievement.name; // Set text
	AchievementDescriptionTxt.Text = achievement.description; // Set text
	AchievementPourcentTxt.Text = $"{achievement.percent}% {Properties.Resources.AchievementPlayerUnlocked}"; // Set text
	}
	}