Skip to content

avivbiton/BlizzardApiReader

Repository files navigation

Build Status

Blizzard ApiReader

C# .net Core library wrapper for Blizzard Public APIs UPDATE:
I do not maintain this repo regulary anymore. But will still keep track of pull requests and issues that come up.
Currently, I do not have plans to re-visit it but I may some time in the future will come back and update it properly.

First timers friendly

As I am also new to open source projects, I want to make this project first-timer friendly as much as possible. Don't be afraid to try and contribute and make mistakes, then we can learn and improve together. This project is also a learning process for me, please tell me if I am doing anything wrong.

WARNING

This project is still under heavy development, it will often change drastically and therefore not recommended for production environments yet. If you are using this in production, you may only want to update this library after a major version.

Setup

  1. Fork this repo and then clone it.
  2. Compile it and put the compiled DLL inside your project.
  3. Don't forget to add the relevant references to your project.

API Access

Create / login to your Blizzard account through here https://develop.battle.net/
It will allow you to create up to 50 clients, you will need to use the Client ID and Secret to make API requests

Contributing

Anyone is welcome to contribute to this project.
Take a quick look at the project, most of the core concept is at BlizzardApiReader.Core.
There are different namespaces for each game. Just go to open issues and look what you can grab.
You may open an issue if you have a question (even if minor) or you can ask me or one of the contributors.

Pull requests

Before making a pull request:

  • All tests must pass.
  • Naming conventions must be met with our naming standards *(this will come soon)
  • Don't leave any commented code or old/outdated comments

Goals

Complete all the API requests available for all games.
Unit tests coverage for the project.
Ongoing code refactor and improvements.
Resolve all open issues.

License

This project is under the MIT license.