Skip to content
Snippets Groups Projects
Commit 27ebb1bf authored by David Bergström's avatar David Bergström
Browse files

Quickstart -> Getting started

parent 0a55a6f1
No related branches found
No related tags found
No related merge requests found
.. TODO: How should we host the binaries .. TODO: How should we host the binaries
Creating your first bot .. _gettingstarted:
=======================
Getting started
===============
The goal of this page is to get you quickly started using the API. The The goal of this page is to get you quickly started using the API. The
following code block is the bare minimum you need to start Starcraft II and run following code block is the bare minimum you need to start Starcraft II and run
......
IDABot IDABot
====== ======
.. TODO: Missing methods: on_start, on_step
.. class:: library.IDABot .. class:: library.IDABot
This is the basis of your bot. It contains all available managers and some This is the basis of your bot. It contains all available managers and some
methods to get you started. methods to get you started.
See :doc:`this page <quickstart>` for how to properly See :ref:`this page <gettingstarted>` for how to properly
inherit from IDABot. inherit from IDABot.
Instances of managers: Instances of managers:
......
...@@ -3,13 +3,18 @@ Welcome to PyCommandCenter's documentation! ...@@ -3,13 +3,18 @@ Welcome to PyCommandCenter's documentation!
This is a Python library based on the CommandCenter bot for implementing bots for Starcraft II. This is a Python library based on the CommandCenter bot for implementing bots for Starcraft II.
.. TODO: IDABot in toctree If you are looking on how to get started, take a look at :ref:`Getting
started <gettingstarted>`.
.. TODO: Coordinates explained
Table of contents
-----------------
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents:
quickstart gettingstarted
managers managers
idabot idabot
unit unit
......
...@@ -47,6 +47,8 @@ BaseLocationManager ...@@ -47,6 +47,8 @@ BaseLocationManager
.. attribute:: library.BaseLocation.position .. attribute:: library.BaseLocation.position
The position of the center of the BaseLocation, defined as a :class:`library.Point2D`. The position of the center of the BaseLocation, defined as a :class:`library.Point2D`.
This is the position used if you want to build a Command Center at the
base location.
.. attribute:: library.BaseLocation.depot_position .. attribute:: library.BaseLocation.depot_position
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment