PROJECT: A bit of organisation

[LDiCesare]

I don't plan to actually work on the CtP2 code. (I'm too busy with Clash and don't want to let this project down).
But I DO want to look at the code, maybe make some comments, and generally follow what's being done here. (I also don't want to buy MSVC++, I already hate working with it at work, so not at home if I can avoid it).

Now, how will I be able to follow the mess that this forum will soon become when everyone asks stuff about the function m_cxSchmoofoobar() in class ctpMrOgPyaJBytwrnemdByLcts?
What about making a sticky thread by package (I call package the source directories), where vital information about each package would be kept and discussed? When a post limit of (something) is reached, the information should be digested somehow, the thread unstickied and a new one put in place instead?

Of course, I am not proposing myself to do the nasty work of organising things up, just suggesting someone else do it for my own convenience.
This could help, however. Particularly, I want to peek and maybe comment a few ai and mapgen files. There are silly stuff, but having dedicated threads per topic might help a bit, and the source is already organised in folders so it looks like a convenient way to organise our posts here. What do you think?

[J Bytheway]

Indeed, this does sound like a good plan. Since by and large we have now been able to compile and run the game (with certain caveats...) the next task should be documenting the source, and we'll need to be a lot more organised about it than we have been so far.

One thread for each of the main directories under ctp2_code, and another for each in ctp2_code\ctp would seem about right (although some of those probably still include hundreds of files).

[J Bytheway]

Now that this has fallen off the first page I thought I'd give it a bump, and also ask, does anyone else wish to start making a serious attempt to document the source code?

I believe that there exist cunning tools around for converting documented code into XML and such like. Does anyone know any details about such things, or have any recommendations as to what methods of documentation we should be using.

I'm happy to start documenting, but I don't want to make it a wasted effort.

[MrBaggins]

I've documented new original (database front end) code. Pretty straightforward, since we were going from a full design, and referencing to within those documents.

The CTP2 code is a different beast. Somethings are straightforward. Other things, are not.

I don't feel that we are going to have the degree of familiarity with the code, and why what goes where, and at what points changes can be made, until a while.

To a certain degree we are gaining familiarity through hacking the obvious bugs away.

As far as the code itself, its not *terribly* untidy. I can do bug hunting without code documents, and I think Dale and John feel similarly.

At some point, we'll have the kind of familiarity to start to write some documents. We can certainly comment the bits we are fixing.

[Dale]

If someone on broadband can download the 96meg DirectMedia 7 package, and zip up just the /lib & /include directories for me (and anything else needed for the code), I'll be able to be a bit more productive for the team.

This is the one reason I haven't been that active in looking at the code. 96meg is too much on a modem.

[MrBaggins]

No problem, Dale. Where do you want it?

[Dale]

If it's only a few meg send it to my email. (The one on my profile).

[MrBaggins]

Sure. It is, btw, DirectX Media 6.0 SDK, not 7.

[MrBaggins]

Uploaded it to http://apolyton.net/upload/files/MrBaggins/DXMedia.rar

Easier than dealing with sending limit.

[Locutus]

MrBaggins, should you ever get in trouble with Dan or Markos for having that (non-Civ related) file in your upload folder, please explain them why they *are* Civ-related and tell them that you have my permission.

[Locutus]

On the actual topic of this thread, I think posting a thread per package is a good idea, but that would leave us with too many threads to top. So it'd be best to create a single thread with links to all the package threads.

Once information has been 'digested', I guess it would be best to put in online in HTML form, I can arrange for adding a section to the Apolyton CtP2 website devoted to (documentation of) the source code. I reckon it would look a bit like the Clash website, where stuff is organized by topic/package.

[MrBaggins]

Thanks Locutus, much appretiated. I'll take it down after I know Dale has it. Perhaps we'll set up an "official" appropriate dial-up viable DirectMedia package when we have some sort of source repository going.

[Dale]

Thanks MrBaggins. Got it.

With the dialup options, don't forget the DX7 SDK option I posted in the other thread.

[Dale]

Well guys, bit of bad news I'm afraid.

Firstly, some of you know I won't be around for a few weeks. So I'll miss a good chunk of the code-hacking action.

Secondly, with Empire, Candle'Bre and everything else I do, I'm just not going to have enough time to help with this.

So I'm gunna have to say I won't be helping out with the source code this. Sorry guys.

Dale

[centrifuge]

Come on now Dale, I don't believe that for a second