Hi, this organization is dedicated to the StarCraft II C++ API.
- cpp-sc2 - implemnetation of the C++ API, forked from Blizzard's s2client-api.
- blank-bot - starter bot for StarCraft II with integrated cpp-sc2;
- commandcenter - original version of CommandCenter bot with integrated cpp-sc2;
- docker-sc2 - dockerized StarCraft II Linux client.
There are many more useful resources related to the game and frameworks.
If you would like to contribute to cpp-sc2, help us improve the library and maintain high quality, there is number of ways to do it.
- Search for other issues tagged with
good first issue
orhelp wanted
tag. - Suggest new features.
- Vote for existing issues (issues with highest number of reactions are likely to be fixed first).
- Improve the documentation of the API.
- Fix spelling :)
- Add/Fix/Improve tutorials, bot examples and tests.
- Help to test latest changes.
- Support this project on Boosty. Support of the project allows to make releases more often and implement nice new features for developers.
If you have any suggestions, feel free to message over Discord (the #cpp
channel).
Code guidelines We do our best to conform to the Google C++ Style Guide with the exception that we use four space tabs instead of two space tabs.
Commit guidelines We follow the semantic versioning approach, this is important so your PR will appear on the Changelog 🎉 ! I guess you expect recognition and we will give it to you. See standard-version for commit guidelines.
The list of supported commit message prefixes:
feat
- a new feature or API improvements;fix
- a bugfix;perf
- performance improvements;refactor
- code refactoring;test
- functional or unit tests;build
- build system improvements, also includes CI improvements;docs
- documentation improvements;chore
- routine task, e.g. create new release (doesn't appear in the changelog);style
- fix code style, no functional changes (doesn't appear in the changelog.
- Keep the PR small as possible and one single topic for each.
- Write good commit message: describe what was the problem and why the changes required.
- Consider implementing a test.