Code Documentation

Need help testing contributed art or code or having trouble getting your newest additions into game compatible format? Confused by changes to data formats? Reading through source and wondering what the developers were thinking when they wrote something? Need "how-to" style guidance for messing with VS internals? This is probably the right forum.
Post Reply
macross
Explorer
Explorer
Posts: 11
Joined: Fri Oct 01, 2004 4:42 pm
Location: Munich, Germany
Contact:
Contact macross

Code Documentation

Post by macross »

Hi *!

I recently checked out the code from SVN and started browsing it. Trying to understand it gave me a hard time. I'm missing code documentation. There are only very little commented methods/code lines and no explanation is given what is done where.

So my question...

Is there any developer documentation available or planned? Where can I get info where to start. I'd really like to contribute and try out some ideas I had, but right now I'm quite lost.

Furthermore where is the OGRE port? I guess it is not in the SVN as I can't find any code related to it.

Sebastian
A fight to death between zombies has some inherent problems.
Top
www2
Venturer
Venturer
Posts: 537
Joined: Sat May 14, 2005 10:51 am
Location: milkyway->the sol system->earth->Europe->The Nederland->Soud Holland->Leiden
Contact:
Contact www2

Re: Code Documentation

Post by www2 »

macross wrote:Hi *!

I recently checked out the code from SVN and started browsing it. Trying to understand it gave me a hard time. I'm missing code documentation. There are only very little commented methods/code lines and no explanation is given what is done where.
i know that this a problem is...
macross wrote: Furthermore where is the OGRE port? I guess it is not in the SVN as I can't find any code related to it.
is in a older branch than the main branch....
All Your Base Are Belong To Us
Top
Zeog
ISO Party Member
ISO Party Member
Posts: 453
Joined: Fri Jun 03, 2005 10:30 am
Location: Europe

Post by Zeog »

WRT the OGRE thing:
klauss wrote:First of all, check out from CVS the ogre branch.

The code is in https://svn.sourceforge.net/svnroot/veg ... gre_branch

And the data in
https://svn.sourceforge.net/svnroot/veg ... nk/data5.x

(Hm... the data may be a bit outdated, since I've been doing changes and I've been procrastinating the commitment of some data files so that I don't inflate the repository unnecessarily - after all, data files are just conversions of the bfxms in data4.x)
Some docs about code internals are in the old manual.
http://vegastrike.sourceforge.net/manua ... index.html
In particular sections 28 and 29 explain some classes in VS and the connection to python.

Other than that, ask the main devs.
Top
macross
Explorer
Explorer
Posts: 11
Joined: Fri Oct 01, 2004 4:42 pm
Location: Munich, Germany
Contact:
Contact macross

Post by macross »

Thanks for the quick answers. I'll take a closer look at the OGRE branch. Just peek some minutes into it until now...

Have you some pointers where to start looking for the OGRE stuff. The gfx folder seems to be old stuff...

cu
Sebastian
A fight to death between zombies has some inherent problems.
Top
klauss
Elite
Elite
Posts: 7243
Joined: Mon Apr 18, 2005 2:40 pm
Location: LS87, Buenos Aires, República Argentina

Post by klauss »

Ogre code is all in

branches/ogre_branch/vegastrike/src/UserInterface
Oíd mortales, el grito sagrado...
Call me "Menes, lord of Cats"
Wing Commander Universe
Top
macross
Explorer
Explorer
Posts: 11
Joined: Fri Oct 01, 2004 4:42 pm
Location: Munich, Germany
Contact:
Contact macross

Post by macross »

Cool. Thanks!
A fight to death between zombies has some inherent problems.
Top
Post Reply

Return to “Contributor Help & Internal How-Tos”