Input Wanted: Roadmap for SC2Reader

[Graylin Kim]

Hey Everyone,

I'm thinking about pushing some more cylces into this library over the next couple weeks (at least) and am looking to do a bit of an informal poll to see where you guys might think my efforts be best directed and if applicable, where you might like to help me out. Not all tasks are created equal and some would be a LOT more work than others but don't worry about that right now. I'm just trying to see if we can have a discussion about what people are interested in.

Your response with top picks from the list below along with any comments you might have will be very helpful. This list is in no way comprehensive so if it is missing something let me know so I can keep it in mind going forward. Other people might agree with you and want to push it forward as well.

• Documentation
• User Manual
• Developers/Contributors Manual
• Replay Format Guide
  
• Data
• Better Data support, currently 1.4.x and 1.2.x are (mostly) supported
• More types of data, unit costs, build times, ability costs, cool downs
• Ability differentiation. i.e. these are construction abilities, transport, channelling, etc
  
• Maps
• Automatic Map Download
• Minimaps
• Parsing of data files in the map MPQ
• Replay Analysis
• Better Selection Tracking
• Better APM Stats
• Build Orders
• Army Compositions
• Parsing improvements on Camera, Ability, or Unknown Events
• Scripts
• Demo Scripts need to be updated (currently non-functional)
• Could stand to have some mature, intended for use scripts
  
• Tests
• We need them...
  

If I get any interest in helping out on any of these things I'll make a mini developers manual a priority so that you can get started quickly. While many of these things are hard problems, some are completely none technical and others might be easier than you think.

Thanks,

~Graylin

Also, are any of you actually using this library for anything cool right now? I'm assuming it was too incomplete to get anywhere before since I haven't heard otherwise.

[David Joerg]

That's great news Graylin!

Here's my top picks from your list, most important first:

* Documentation

* Parsing improvements on Camera, Ability, or Unknown Events

* Parsing of data files in the map MPQ

* Better Data support, currently 1.4.x and 1.2.x are (mostly) supported

I'm working now on a stats-tracking site designed to help me track my own improvement, maybe others will find it useful too.   --dj

[Andreas]

Hi all,

Documentation would be on top of my list too.

And be assured that your library is super useful.
As you know i was building a small django site for collecting replays.
I use your library to automatically parse and display game information
and additionally i pull some player information via sc2ranks-api.
If this is of any interest i would release what i got on github.

Thanks for your great work,
Andreas

On 18 Jan., 05:43, David Joerg <dsjo...@gmail.com> wrote:
> That's great news Graylin!
>
> Here's my top picks from your list, most important first:
> * Documentation
> * Parsing improvements on Camera, Ability, or Unknown Events
> * Parsing of data files in the map MPQ
> * Better Data support, currently 1.4.x and 1.2.x are (mostly) supported
>
> I'm working now on a stats-tracking site designed to help me track my own
> improvement, maybe others will find it useful too.   --dj
>
>
>
>
>
>
>
> On Tue, Jan 17, 2012 at 11:31 PM, Graylin Kim <graylin....@gmail.com> wrote:
> > Hey Everyone,
>
> > I'm thinking about pushing some more cylces into this library over the
> > next couple weeks (at least) and am looking to do a bit of an informal poll
> > to see where you guys might think my efforts be best directed and if
> > applicable, where you might like to help me out. Not all tasks are created
> > equal and some would be a LOT more work than others but don't worry about
> > that right now. I'm just trying to see if we can have a discussion about
> > what people are interested in.
>
> > Your response with top picks from the list below along with any comments
> > you might have will be very helpful. This list is in no way comprehensive
> > so if it is missing something let me know so I can keep it in mind going
> > forward. Other people might agree with you and want to push it forward as
> > well.
>

> >    - Documentation
> >       - User Manual
> >       - Developers/Contributors Manual
> >       - Replay Format Guide
> >       - Data
> >       - Better Data support, currently 1.4.x and 1.2.x are (mostly)
> >       supported
> >       - More types of data, unit costs, build times, ability costs, cool
> >       downs
> >       - Ability differentiation. i.e. these are construction abilities,
> >       transport, channelling, etc
> >       - Maps
> >       - Automatic Map Download
> >       - Minimaps
> >       - Parsing of data files in the map MPQ
> >    - Replay Analysis
> >       - Better Selection Tracking
> >       - Better APM Stats
> >       - Build Orders
> >       - Army Compositions
> >       - Parsing improvements on Camera, Ability, or Unknown Events
> >    - Scripts
> >       - Demo Scripts need to be updated (currently non-functional)
> >       - Could stand to have some mature, intended for use scripts
> >       - Tests
> >       - We need them...

[Graylin Kim]

David & Andreas,

What kind of documentation are we talking about? User Manual, Developer Guide, something else?

We've already got user documentation. It is out of date on the new_data branch but otherwise reasonably useful. Are there specific improvements or additions you'd like to see?

~Graylin

[David Joerg]

The documentation is pretty good actually, it's just a bit disorganized and out of date.

For example, in this page:

https://github.com/GraylinKim/sc2reader/wiki/Developer-documentation

It mentions PeopleProcessor but I don't believe there's any such thing.

But really Graylin should you heavily favor working on whichever thing _you_ want to work on, or at least don't work on the things that don't excite you.  If someone needs more documentation, they can write it themselves and contribute it!

--David J    [ twitter   blog   calendar   meetup: drink for america  ]