Skip to content

Commit 9902f9b

Browse files
committed
Add a short guide to getting started.
1 parent d5ef74a commit 9902f9b

File tree

3 files changed

+12
-7
lines changed

3 files changed

+12
-7
lines changed

docs/source/articles/conceptsinsc2reader.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ A default factory is automatically configured and attached to the ``sc2reader``
2222
The default factory can be configured with the following environment variables:
2323

2424
* SC2READER_CACHE_DIR - Enables caching to file at the specified directory.
25-
* SC2READER_CACHE_MAX_SIZE - Enables memory caching of resources with a maximum number of entries (not based on memory imprint!)
25+
* SC2READER_CACHE_MAX_SIZE - Enables memory caching of resources with a maximum number of entries; not based on memory imprint!
2626

2727

2828
Resources

docs/source/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ I recommend the following steps when getting started:
5858
* Follow the `installation guide`_
5959
* Read this article on replays: :doc:`articles/whatsinareplay` (5 minutes).
6060
* Read this article on sc2reader: :doc:`articles/conceptsinsc2reader` (5 minutes).
61+
* Short introduction to sc2reader: :doc:`articles/gettingstarted` (5 minutes)
6162

6263
Now that you've been oriented, you can see sc2reader in action by working through a couple of the tutorials below.
6364

@@ -75,7 +76,10 @@ The best way to pick sc2reader up and get started is probably by example. With t
7576
Articles
7677
----------------
7778

79+
A collection of short handwritten articles about aspects of working with replays and sc2reader.
80+
7881
* :doc:`articles/whatsinareplay` (5 minutes).
82+
* :doc:`articles/gettingstarted` (5 minutes).
7983
* :doc:`articles/conceptsinsc2reader` (5 minutes).
8084
* :doc:`articles/creatingagameengineplugin` (10 minutes).
8185

sc2reader/resources.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -273,17 +273,18 @@ def __init__(self, replay_file, filename=None, load_level=4, engine=sc2reader.en
273273
self.load_message_events()
274274
self.load_players()
275275

276-
# Load events if requested
276+
# Load tracker events if requested
277277
if load_level >= 3:
278-
for data_file in ['replay.game.events']:
278+
for data_file in ['replay.tracker.events']:
279279
self._read_data(data_file, self._get_reader(data_file))
280-
self.load_game_events()
280+
self.load_tracker_events()
281281

282-
# Load tracker events if requested
282+
283+
# Load events if requested
283284
if load_level >= 4:
284-
for data_file in ['replay.tracker.events']:
285+
for data_file in ['replay.game.events']:
285286
self._read_data(data_file, self._get_reader(data_file))
286-
self.load_tracker_events()
287+
self.load_game_events()
287288

288289
# Run this replay through the engine as indicated
289290
if engine:

0 commit comments

Comments
 (0)