City of Heroes is a complex game that provides its players with a lot of choices. In order to make the best of a player’s gaming experience, HeroStats attempts to provide more information about City of Heroes to the player.
HeroStats is an Open Source statistical analyzer for the game City of Heroes. It runs alongside City of Heroes and collects information about how well your hero is performing. For complete information and documentation about HeroStats, visit the website at www.herostats.org.
HeroStats is written using the Microsoft .NET v2.0 framework, largely in C# (with some C++ modules where it made sense). This help file is designed for programmers wishing to write other City of Heroes utilities using the HeroStats engine, and documents the publicly accessible classes, methods and attributes in the various engine assemblies. Although complete source code is available for download, the HeroStats developers wanted to make it easier for programmers new to the HeroStats experience to work with the libraries, and so put together this documentation.
Please note, though, that due to limitations in the way Visual Studio creates typed datasets, we're currently unable to supply documentation details for the elements of the two configuration datasets and the statistics storage data set. Since those are automatically generated by the IDE, and Visual Studio does not generate the XML comments for its code, any changes we make will be overwritten. This is supposed to improve in the next version of Visual Studio.
Sample code showing how to use the libraries is available in the developer's section of the HeroStats website.
The HeroStats team would like to thank the creators of NDoc, without whose help this help file would never have been written.
Usage of the HeroStats libraries is governed by the HeroStats license, which is the GNU General Public License.
