From cc796e93c72505f68acb3a44004e6d54c2ff7de1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20Bergstr=C3=B6m?= <david-bergstrom@outlook.com>
Date: Tue, 14 Aug 2018 08:48:25 +0200
Subject: [PATCH] Add notes on techtree.json
---
docs/index.rst | 2 --
docs/perception.rst | 8 ++++++++
2 files changed, 8 insertions(+), 2 deletions(-)
diff --git a/docs/index.rst b/docs/index.rst
index 9d98af269..022e36c31 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -13,8 +13,6 @@ If you are looking for something specific, you can either check the
If you want to know about a certain topic, check the table of contents below
this paragraph.
-.. TODO: Add information about tree.json
-
.. TODO: Base repos for C++ AI
Table of contents
diff --git a/docs/perception.rst b/docs/perception.rst
index c1432719e..e4cba6ab9 100644
--- a/docs/perception.rst
+++ b/docs/perception.rst
@@ -65,12 +65,20 @@ TechTree
build a certain unit and what builds it. It only has one method, which is
used to look-up unit types properties:
+ This class has some invalid information by default, this can be corrected by
+ placing the file `techtree.json` in the working directory. The
+ `techtree.json` files are available here_, select the lastest version. A
+ recent file is included in the `template repository`_.
+
.. method:: get_data(argument) -> library.TypeData
Argument is either an instance of the class :class:`library.UnitType` or
an instance of the class :class:`library.CCUpgrade`, depending on what
information is wanted.
+.. _here: https://github.com/noorus/sc2-gamedata
+.. _`template repository`: https://gitlab.ida.liu.se/starcraft-api/sc2-python-bot
+
TypeData
~~~~~~~~
--
GitLab