documentation

documentation

Discuss the source code and development of Spring Engine in general from a technical point of view. Patches go here too.

Moderator: Moderators

Post Reply
greenail
Spring Developer
Posts: 80
Joined: 13 Dec 2005, 20:16

documentation

Post by greenail »

I'm willing to put some time into documenting how spring works if some of the developers are willing to help me. I'm not sure the best way to get started, but perhaps we can stub out some stuff from the current doxygen stuff and add from there. Some stuff is pretty well discussed like the AI system, sync methodology. Some stuff is not at all clear for someone looking to get started, and the reasons why things have been designed a certain way would be important to document so ppl don't waste time re-inventing the wheel on things that have already been tested. What do we think needs to be documented first?
User avatar
AF
AI Developer
Posts: 20687
Joined: 14 Sep 2004, 11:32

Post by AF »

Well first off you need to centralize stuff. I know the sync stuff is on the berliOS mailing list but nto everyone knows thata dn not everyone knows howto get there.

That and you could try and document the AI itnerface on the spring side rather than the globalAI side, maybe you'll find some bugs that'recausing the interface to be as unreliable as it currently is.
greenail
Spring Developer
Posts: 80
Joined: 13 Dec 2005, 20:16

Post by greenail »

well the berliOS site's wiki is mostly broken (i'm not a huge fan of wiki), does a new development wiki(or whatever) need to be hosted somewhere?

AF, perhaps we could start with documenting one of the simple group AIs and see how it goes. let me know if you can help me out and I can stub out a draft.
User avatar
Min3mat
Posts: 3455
Joined: 17 Nov 2004, 20:19

Post by Min3mat »

wtf is wrong with the wiki??? :?
User avatar
AF
AI Developer
Posts: 20687
Joined: 14 Sep 2004, 11:32

Post by AF »

I dont have the time to go documenting everything, with or without you. I was just suggesting where to begin. But I will document NTAI and any of my creations, btu i think it would be more beneficial to document the engien itself and not the GroupAI/GlobalAI it uses, and of them all the onyl one that would really benefit people from havign documentation would be the central build groupAI.
Post Reply

Return to “Engine”