Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/cpp-sc2/blank-bot

Starter bot for StarCraft II with integrated cpp-sc2
https://github.com/cpp-sc2/blank-bot

ai bot cpp game sc2 starcraft starcraft-ii starcraft-ii-bot starcraft2 starter

Last synced: 20 days ago
JSON representation

Starter bot for StarCraft II with integrated cpp-sc2

Host: GitHub
URL: https://github.com/cpp-sc2/blank-bot
Owner: cpp-sc2
License: mit
Created: 2021-02-19T17:28:42.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-05-30T08:03:08.000Z (about 1 month ago)
Last Synced: 2024-05-31T08:27:02.445Z (about 1 month ago)
Topics: ai, bot, cpp, game, sc2, starcraft, starcraft-ii, starcraft-ii-bot, starcraft2, starter
Language: C++
Homepage:
Size: 50.8 KB
Stars: 2
Watchers: 2
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-sc2-ai - cpp-sc2/blank-bot - empty starter bot with integrated cpp-sc2. (Open-source bots / CPP bots)

README

        # blank-bot

[![Build](https://github.com/cpp-sc2/blank-bot/actions/workflows/ci.yml/badge.svg)](https://github.com/cpp-sc2/blank-bot/actions/workflows/ci.yml)

Starter bot for StarCraft II with integrated cpp-sc2.

**Table of Contents**

- [blank-bot](#blank-bot)

    - [Support](#support)

    - [Build instructions](#build-instructions)

        - [Windows](#windows)

        - [macOS](#macos)

        - [Linux](#linux)

    - [Additional options](#additional-options)

        - [WSL2 Support](#wsl2-support)

        - [Game client version](#game-client-version)

        - [AIArena ladder build](#aiarena-ladder-build)

    - [Managing CMake dependencies](#managing-cmake-dependencies)

    - [Troubleshooting](#troubleshooting)

        - [CMake options don't take effect](#cmake-options-dont-take-effect)

        - [Build freezes (Linux or macOS)](#build-freezes-linux-or-macos)

    - [License](#license)

## Support

Feel free to post questions on the unofficial StarCraft II AI Discord server. [Invite Link](https://discordapp.com/invite/Emm5Ztz)

## Build instructions

> :construction: This project requires a compiler with C++17 support.

1. Before proceeding further download the [actual map pack](https://aiarena.net/wiki/maps/).

1. Put the downloaded maps into the `Maps` folder (create it if the folder doesn't exist):

   * Windows: `C:\Program Files\StarCraft II\Maps`

   * OS X: `/Applications/StarCraft II/Maps`

   * Linux: anywhere.

### Windows

For building for Windows under WSL2, see [WSL2 Support](#wsl2-support).

1. Install [CMake](https://cmake.org/download/).

1. Download and install Visual Studio ([2017](https://www.visualstudio.com/downloads/) or newer).

1. Get the project.

   ```bat

   git clone [email protected]:cpp-sc2/blank-bot.git

   ```

1. Enter the working directory.

   ```bat

   cd blank-bot

   ```

1. Create Visual Studio project files in the directory "build".

   E.g. for Visual Studio 2022:

   ```bat

   cmake -B build -G "Visual Studio 17 2022"

   ```

1. Build the project using Visual Studio.

   ```bat

   start build\BlankBot.sln

   ```

1. Launch the bot with the specified path to a SC2 map, e.g:

   ```bat

   build\bin\Debug\BlankBot.exe Ladder2019Season3/AcropolisLE.SC2Map

   ```

### macOS

1. Install [CMake](https://cmake.org/download/).

1. Install XCode.

1. Install XCode command-line tools.

1. Clone the project.

   ```bash

   git clone [email protected]:cpp-sc2/blank-bot.git && cd blank-bot

   ```

1. Generate CMake build tree.

   ```bash

   cmake -B build

   ```

1. Build the project.

   ```bash

   cmake --build build --parallel $(nproc)

   ```

1. Launch the bot with the specified absolute path to a SC2 map, e.g.:

   ```bash

   ./build/bin/BlankBot "/home/alkurbatov/Ladder2019Season3/AcropolisLE.SC2Map"

   ```

### Linux

1. Install [CMake](https://cmake.org/download/).

1. Install `gcc-c++`.

1. Install the `make` utility.

1. Get the project.

   ```bash

   git clone [email protected]:cpp-sc2/blank-bot.git && cd blank-bot

   ```

1. Generate CMake build tree.

   ```bash

   cmake -B build

   ```

1. Build the project.

   ```bash

   cmake --build build --parallel $(nproc)

   ```

1. Launch the bot with the specified absolute path to a SC2 map, e.g.:

   ```bash

   ./build/bin/BlankBot "/home/alkurbatov/Ladder2019Season3/AcropolisLE.SC2Map"

   ```

## Additional options

### WSL2 Support

Cross compiling for Windows under WSL2 is supported through `cpp-sc2`. See the `cpp-sc2` [documentation](https://github.com/cpp-sc2/cpp-sc2/blob/master/docs/building.md#wsl2-support) for build requirements. The build flag remains the same, setting `-DWSL_CROSS_COMPILE=ON`.

### Game client version

By default, the API assumes the latest version of the game client. The assumed version can be found in cmake's output, e.g.:

```bash

$ cmake -B build grep 'SC2 version'

Target SC2 version: 5.0.5

...

```

However, sometimes one may need to compile with an older version of the game, e.g. to play with a Linux build which is

always behind the Windows version. It is possible by specifying the game version manually, e.g.:

```bash

cmake -B build -DSC2_VERSION=4.10.0

```

### AIArena ladder build

To compile a bot capable to play on [the AIArena ladder](https://aiarena.net), configure the project in the following way:

```bash

cmake -B build -DBUILD_FOR_LADDER=ON -DSC2_VERSION=4.10.0

```

## Managing CMake dependencies

`BlankBot` uses the CMake `FetchContent` module to manage and collect dependencies. To use a version of `cpp-sc2` outside of the pinned commit, modify the `GIT_REPOSITORY` and/or the `GIT_TAG` in `cmake/cpp_sc2.cmake`:

```

...

FetchContent_Declare(

    cpp_sc2

    GIT_REPOSITORY 

    GIT_TAG 

)

FetchContent_MakeAvailable(cpp_sc2)

...

```

With the updated configuration, re-run the build configuration and the dependency will be updated to the new configuration:

```

cmake -B build

```

## Troubleshooting

### CMake options don't take effect

If you see that some of cmake options don't take effect

(e.g. project was configured with `cmake -B build -DBUILD_FOR_LADDER=ON` and a bit later with `cmake -B build`)

remove the `build` folder or the `CMakeCache.txt` file, or explicitly re-specify the desired default behavior (e.g. `cmake -B build -DBUILD_FOR_LADDER=OFF`).

### Build freezes (Linux or macOS)

If project compilation freezes, decrease nproc to 1 or more, e.g.:

``` bash

cmake --build build --parallel $(nproc --ignore=1)

```

## License

Copyright (c) 2021-2024 Alexander Kurbatov

Licensed under the [MIT license](LICENSE).