Add documentation for config options that were previously removed from the example bot.
@@ -79,6 +79,41 @@ This is probably the simplest bot that has any realistic chances of winning the
You can find more examples in the [`examples/`](/examples) folder.
+## API Configuration Options
+
+The API supports a number of options for configuring how it operates.
+
+### `raw_affects_selection`
+Setting this to true improves bot performance by a little bit.
+```python
+class MyBot(sc2.BotAI):
+ def __init__(self):
+ self.raw_affects_selection = True
+```
+
+### `distance_calculation_method`
+The distance calculation method:
+- 0 for raw python
+- 1 for scipy pdist
+- 2 for scipy cdist
+```python
+class MyBot(sc2.BotAI):
+ def __init__(self):
+ self.distance_calculation_method = 2
+```
+
+### `game_step`
+On game start or in any frame actually, you can set the game step. This controls how often your bot's `step` method is called.
+__Do not set this in the \_\_init\_\_ function as the client will not have been initialized yet!__
+```python
+class MyBot(sc2.BotAI):
+ def __init__(self):
+ pass # don't set it here!
+
+ async def on_start(self):
+ self.client.game_step = 2
+```
+
## Community - Help and support
You have questions but don't want to create an issue? Join the [Starcraft 2 AI Discord server](https://discordapp.com/invite/zXHU4wM) or [ai-arena.net Discord server](https://discord.gg/yDBzbtC). Questions about this repository can be asked in text channel #python. There are discussions and questions about SC2 bot programming and this repository every day.
