Skip to content

index.rst

Latest commit

 

History

History
61 lines (43 loc) · 1.93 KB

index.rst

File metadata and controls

61 lines (43 loc) · 1.93 KB

SC2Reader User Manual

Thanks for choosing sc2reader for your Starcraft analysis needs.

There is a pressing need in the SC2 community for better statistics, better analytics, better tools for organizing and searching replays. Better websites for sharing replays and hosting tournaments. These tools can't be created with out first being able to open up replay files and analyse the content within. That's why SC2Reader was built, to provide a solid foundation on which the next generation of tools and websites can be built and benefit the community.

So lets get you started right away! Through the linked tutorials and reference pages below we'll get you started building your own tools and systems in no time. Any questions, suggestions, or concerns should be posted to the sc2reader mailing list. You can also pop on to our #sc2reader, our IRC channel on Freenode if you want to chat or need some live support.

Note

Checkout our :doc:`faq`. If your question isn't covered there, let us know and we'll add it to the list.

Tutorials

The best way to learn how to pick sc2Reader up and get started is probably by example. With that in mind, we've written up a series of tutorials on getting various simple tasks done with sc2reader; hopefully they can serve as a quick on ramp for you.

Reference Pages

SC2 replays hold a ton of information. The following reference pages were put together to help you quickly find the information you need.

.. toctree::

    faq
    sc2reader
    primaryresources
    supportobjects
    utilityclasses
    plugins



.. toctree::
    :hidden:
    :maxdepth: 2
    :glob:

    faq
    sc2reader
    primaryresources
    supportobjects
    utilityclasses
    plugins
    tutorials/*