KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #ai-agent #developer-tools #claude-code #codex #deepseek-harness #ai-agents #react #mcp #rust

cpp-sc2

★ 61 Open GitHub ↗

StarCraft II Client C++ library, proud fork of Blizzard/s2client-api.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# cpp-sc2

[![GitHub](https://img.shields.io/github/license/cpp-sc2/cpp-sc2)](https://github.com/cpp-sc2/cpp-sc2/blob/master/LICENSE)
[![C++20](https://img.shields.io/badge/C%2B%2B-20-green.svg)](https://isocpp.org/std/the-standard)
[![Build Status](https://github.com/cpp-sc2/cpp-sc2/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/cpp-sc2/cpp-sc2/actions/workflows/ci.yml)
[![Join the chat in Discord: https://discord.gg/YurYAgHRSw](https://img.shields.io/badge/Discord-Chat!-brightgreen.svg)](https://discord.gg/YurYAgHRSw)

The StarCraft II API provides access to in-game state observation and unit
control. The API is a wrapper around protobuf defined protocol over a websocket
connection.  
While it's possible to write directly to the protocol, this library provides
a C++ and class-based abstraction.

## Documentation

* [Getting Started with SC2 CPP Bot API](https://www.youtube.com/watch?v=Z7eX7YLPwc8).
* A detailed tutorial is located in [docs/tutorial1.md](docs/tutorial1.md).
* The API documentation can be found on our
  [github pages site](https://cpp-sc2.github.io/cpp-sc2). The documentation is
  generated from code automatically, using [Doxygen](http://www.stack.nl/~dimitri/doxygen/)
* For example of usage of this API please refer to
  [CommandCenter](https://github.com/cpp-sc2/commandcenter),
  [Suvorov bot](https://github.com/alkurbatov/suvorov-bot) and
  the [examples](https://github.com/cpp-sc2/cpp-sc2/tree/master/examples) folder
  in this project.
* To start from scratch, please check this
  [boilerplate](https://github.com/cpp-sc2/blank-bot).

## Precompiled Libraries

You can download precompiled libraries for Windows and OS X
[here](docs/precompiled_libs.md).

## Support

Have questions but don't want to create an issue? Join the unofficial
Starcraft II AI Discord server
([Invite Link](https://discordapp.com/invite/Emm5Ztz)). Questions about this
repository can be asked in the text channel `#cpp`.  
Also, please consider to support this project on
[Boosty](https://boosty.to/cpp-sc2). Support of the project allows to make
releases more often and implement new features for developers.

## Building the project

This library uses [CMake](https://cmake.org/download/) to generate project
files. It builds with [Visual Studio](https://www.visualstudio.com/downloads/)
on Windows and Makefiles on the other platforms. It relies on the following
contrib packages:

1. Civetweb
1. Protobuf
1. SDL (optional)

Follow the instructions for submodules and building in
[docs/building.md](docs/building.md).

## Additional Maps

This repository only comes with a few maps for testing.
Additional maps can be found [here](https://aiarena.net/wiki/maps/).

## Contributing

Please, read the detailed [contributing guide][contributing-guide] before
creating pull-requests to the project. It can save you a lot of time.

[contributing-guide]: https://github.com/cpp-sc2/cpp-sc2/issues/9

cpp-sc2

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README