-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
15 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,63 +1,2 @@ | ||
# RawgNET | ||
A wrapper for the API of wrag.io, to get a game including all it's data | ||
|
||
## Technologies | ||
|
||
### Created using | ||
- .NET Core 6.0 | ||
|
||
### Nuget(s) | ||
- Newtonsoft.Json (Needs to be added to your project too, until I figure out why) | ||
|
||
## Features | ||
|
||
### New | ||
- Thanks to sgamesdev, I got reminded that the achievements are missing, those are included by now | ||
|
||
### General | ||
- Get a "Game" object including the complete data like images, description and more.. | ||
|
||
## Usage | ||
|
||
## Example | ||
|
||
``` | ||
using (RawgClient client = new(new RawgClientOptions("YOUR KEY FROM https://rawg.io/login?forward=developer"))) | ||
{ | ||
string query = "gtav"; | ||
Console.WriteLine($"Querying for: {query}"); | ||
Game game = client.GetGameData(query, true); | ||
if (!object.Equals(game, null)) | ||
{ | ||
Console.WriteLine($"Output for: {game.Name} | {game.NameOriginal}\n"); | ||
Console.WriteLine(game.ToString()); | ||
} | ||
} | ||
``` | ||
|
||
## FAQ | ||
|
||
#### Does this work on every OS? | ||
|
||
I created this on windows 10 and tested it on other windows 10 machines, I cant guarantee anything for other operating systems or versions. But it should work everywhere, where Core 6 works. | ||
|
||
#### Where do I get an API-Key? | ||
|
||
At https://rawg.io/apidocs just press the "Get API Key" button. | ||
|
||
## License | ||
|
||
**Software:** RawgNET | ||
|
||
**License:** GNU General Public License v3.0 | ||
|
||
**Licensor:** Kim Mario Liebl | ||
|
||
[GNU](https://choosealicense.com/licenses/gpl-3.0/) | ||
|
||
## Roadmap | ||
|
||
- Make code more clean especially the ""RawgRequest"" method! | ||
- Export "Newtonsoft.Json" nuget package with library | ||
- More to come.. | ||
The wrapper, to use in projects. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Demo | ||
The demo project, to test out the functions. |