diff --git a/LICENSE.md b/LICENSE.md index 2878d98..c301be0 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,7 +1,7 @@ The MIT License (MIT) -Copyright (c) 2018 mmuffins +Copyright (c) 2018 Michael Kellner Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index c71ce96..c15c04b 100644 --- a/README.md +++ b/README.md @@ -3,4 +3,35 @@ The SteamStorefrontAPI is a .NET wrapper for the steam storefront api which is exposed via Steam Big Picture. The API is not officially available or documented, all data in this library was either compiled by trial and error from the [inofficial api documentation](https://wiki.teamfortress.com/wiki/User:RJackson/StorefrontAPI), and is therefore provided as-is. ## Usage examples -Please see the SteamStorefrontConsole Project for usage examples. + +```cs +using SteamStorefrontAPI; +using SteamStorefrontAPI.Classes; + +static async Task Examples() +{ + // Get details for SteamApp with ID 443790 + SteamApp steamApp1 = await AppDetails.GetAsync(460810); + + // Get details for SteamApp with ID 443790 for region US + SteamApp steamApp2 = await AppDetails.GetAsync(322330, "US"); + + // Get details for Package with ID 68179 for region + PackageInfo package1 = await PackageDetails.GetAsync(68179); + + // Get details for Package with ID 68179 for region JP + PackageInfo package2 = await PackageDetails.GetAsync(68179, "JP"); + + // Get a list of featured games + FeaturedApps featured = await Featured.GetAsync(); + + // Get a list of featured games for region DE + FeaturedApps featured2 = await Featured.GetAsync("DE"); + + // Get a list of featured games grouped by category + List featuredCategories = await FeaturedCategories.GetAsync(); + + // Get a list of featured games grouped by category for region US + List featuredCategories2 = await FeaturedCategories.GetAsync("DE"); +} +``` \ No newline at end of file diff --git a/SteamStorefrontAPI/Properties/AssemblyInfo.cs b/SteamStorefrontAPI/Properties/AssemblyInfo.cs index 477fb61..6d240f9 100644 --- a/SteamStorefrontAPI/Properties/AssemblyInfo.cs +++ b/SteamStorefrontAPI/Properties/AssemblyInfo.cs @@ -8,9 +8,9 @@ using System.Runtime.InteropServices; [assembly: AssemblyTitle("SteamStorefrontAPI")] [assembly: AssemblyDescription("A .NET wrapper for the Steam Storefront API")] [assembly: AssemblyConfiguration("")] -[assembly: AssemblyCompany("")] +[assembly: AssemblyCompany("Michael Kellner")] [assembly: AssemblyProduct("SteamStorefrontAPI")] -[assembly: AssemblyCopyright("Copyright © mmuffins 2018")] +[assembly: AssemblyCopyright("Copyright © 2018")] [assembly: AssemblyTrademark("")] [assembly: AssemblyCulture("")] diff --git a/SteamStorefrontAPI/SteamStorefrontAPI.csproj b/SteamStorefrontAPI/SteamStorefrontAPI.csproj index a7ea9a1..81f26f5 100644 --- a/SteamStorefrontAPI/SteamStorefrontAPI.csproj +++ b/SteamStorefrontAPI/SteamStorefrontAPI.csproj @@ -9,8 +9,9 @@ Properties SteamStorefrontAPI SteamStorefrontAPI - v4.7.1 + v4.6.1 512 + true diff --git a/SteamStorefrontAPI/SteamStorefrontAPI.nuspec b/SteamStorefrontAPI/SteamStorefrontAPI.nuspec new file mode 100644 index 0000000..3ec0bf0 --- /dev/null +++ b/SteamStorefrontAPI/SteamStorefrontAPI.nuspec @@ -0,0 +1,16 @@ + + + + $id$ + $version$ + $title$ + $author$ + $author$ + http://LICENSE_URL_HERE_OR_DELETE_THIS_LINE + http://PROJECT_URL_HERE_OR_DELETE_THIS_LINE + false + $description$ + $copyright$ + steam api valve + + \ No newline at end of file diff --git a/SteamStorefrontConsole/App.config b/SteamStorefrontConsole/App.config index 787dcbe..bae5d6d 100644 --- a/SteamStorefrontConsole/App.config +++ b/SteamStorefrontConsole/App.config @@ -1,6 +1,6 @@ - + - + - \ No newline at end of file + diff --git a/SteamStorefrontConsole/Program.cs b/SteamStorefrontConsole/Program.cs index 5b766a9..df568b7 100644 --- a/SteamStorefrontConsole/Program.cs +++ b/SteamStorefrontConsole/Program.cs @@ -18,18 +18,29 @@ namespace SteamStorefrontConsole static async Task Examples() { - var steamApp1 = await AppDetails.GetAsync(637670); - var steamApp2 = await AppDetails.GetAsync(443790); - var steamApp3 = await AppDetails.GetAsync(460810, "JP"); - var steamApp4 = await AppDetails.GetAsync(322330, "US"); + // Get details for SteamApp with ID 443790 + SteamApp steamApp1 = await AppDetails.GetAsync(460810); - var package1 = await PackageDetails.GetAsync(68179); - var package2 = await PackageDetails.GetAsync(68179, "JP"); - var package3 = await PackageDetails.GetAsync(235158); - var package4 = await PackageDetails.GetAsync(235158, "US"); + // Get details for SteamApp with ID 443790 for region US + SteamApp steamApp2 = await AppDetails.GetAsync(322330, "US"); - var featured = await Featured.GetAsync(); - var featuredCategories = await FeaturedCategories.GetAsync(); + // Get details for Package with ID 68179 for region + PackageInfo package1 = await PackageDetails.GetAsync(68179); + + // Get details for Package with ID 68179 for region JP + PackageInfo package2 = await PackageDetails.GetAsync(68179, "JP"); + + // Get a list of featured games + FeaturedApps featured = await Featured.GetAsync(); + + // Get a list of featured games for region DE + FeaturedApps featured2 = await Featured.GetAsync("DE"); + + // Get a list of featured games grouped by category + List featuredCategories = await FeaturedCategories.GetAsync(); + + // Get a list of featured games grouped by category for region US + List featuredCategories2 = await FeaturedCategories.GetAsync("DE"); } } } diff --git a/SteamStorefrontConsole/SteamStorefrontConsole.csproj b/SteamStorefrontConsole/SteamStorefrontConsole.csproj index 5f027c2..80f6b23 100644 --- a/SteamStorefrontConsole/SteamStorefrontConsole.csproj +++ b/SteamStorefrontConsole/SteamStorefrontConsole.csproj @@ -8,9 +8,10 @@ Exe SteamStorefrontConsole SteamStorefrontConsole - v4.7.1 + v4.6.1 512 true + AnyCPU