PlaneShift

Development => Development Deliberation => Topic started by: oliver123 on October 08, 2005, 10:03:49 pm

Title: Guide to the source code?
Post by: oliver123 on October 08, 2005, 10:03:49 pm

Hello devs,
is there some kind of guide / summary of the source code and how the different parts work together? I\'ve never worked on such a big project and get lost in the code all the time :-/

Also, do you have any source code browser you could recommend for the PlaneShift / CS source code (for Linux)?

Thanks in advance,
Oliver

Title:
Post by: stfrn on October 09, 2005, 05:47:44 am

Well, the main site right now would be the build guides on laanx:
http://laanx.fragnetics.com/index.php
But they are not always up to date. If you just want to look at source, checkout CVS:
http://cvs.sourceforge.net/viewcvs.py/planeshift/planeshift/
Thre are also more guides there.
If you want to look at an API, see this:
http://planeshift.sourceforge.net/pubapi/html/index.html

Above all, if you want to talk to people, the best way is on irc.freenode.net, channel #planeshift-build.

Title:
Post by: Cha0s on October 09, 2005, 06:43:23 am

The best way to really learn the code is to work with it. You\'d be surprised at how good a teacher Necessity is...

Title:
Post by: acraig on October 09, 2005, 07:47:47 am

There is a doxygen config file in the docs directory that you can use to generate the html documentation from the code.  We had it on Sourceforge but we had some issues with the cron job.

As for a source code browser I don\'t have anything like that.  I use KDE\'s Kate editor most of the time and \'grep\' a lot.

Title:
Post by: AryHann on October 09, 2005, 09:48:06 am

I have been using PS engine for building up another application, and yes, I had plenty of troubles getting a grip on it at first place, since the lack of documentation (and even comments in the code).

Luckily, I had the opportunity to realize that the best doclumentation are the coders, so I started to stress up people to understand how things work and after that of course looking at the code itself was the way to get a complete view over everything.

If you want to have just something like some really big overview of PS code, I think there was aeris link somewhere that was useful.
http://www.aerig.plus.com/planeshift/index.html

In my utopic dreams, I have been thinking of documenting a bit more what i have learnt in those days, but then I started to code for PS and i haven\'t yet produced anything. Maybe in the future.

Title:
Post by: oliver123 on October 09, 2005, 03:20:03 pm

Thanks for your replies! That \"IntroToPlaneShift2\" PDF at aerig\'s site is especially helpful... Gives a good overview about the various parts.

Title:
Post by: Ethan on October 12, 2005, 04:06:37 pm

Didn\'t know this one. Great!!!

It is not my fault if there is nothing in pages 17-18-19, isn\'t it?

Title:
Post by: AryHann on October 12, 2005, 04:51:56 pm

Nope, it is normal ;-)

Title:
Post by: Welli on November 09, 2005, 12:15:33 pm

im a n00b - where can i nab the source?

got a team together to try to make an online RPG

PS looks amazing - we are all very impressed.

Dont worry its not like PS at all :D

Title:
Post by: Ethan on November 10, 2005, 07:53:10 am

Quote

Originally posted by Welli
got a team together to try to make an online RPG

Quote

Originally posted by Welli
im a n00b - where can i nab the source?

Don\'t want to be rude, but I don\'t understand how you want to make an online RPG if your are not even able to grap the source.... Anyway.... Try http://www.ps-mc.com/docs/index.php/Main_Page to get information. I order to get the sources you will have to use CVS. (see compilation tutorial)

Quote

Originally posted by Welli
Dont worry its not like PS at all :D

Well... PS is licensed. For more informattion, see http://www.planeshift.it/pslicense.html. In short, you can only use the code which is open source.

Title:
Post by: Welli on November 15, 2005, 02:31:55 pm

yes i know i meant a n00b to coding mmorpgs.

It\'s more of a getting to know it session

thanks for the links

Title:
Post by: kulay on November 16, 2005, 12:04:11 am

I know how to program.  I am a bit rusty because I took a break.   I know how to program, but I am having some difficulties compling planeshift code.  Guess I am a newbie at this too.  
 I found a guide on how to compile it with Visual studio .NET.    I won\'t have access to my visual studio .net cds till January.  I have Visual Studio 6, which is diffrent from the .net version.  I can understand not knowing how to use it.  Guess I have to find a guide for Visual studio 6 or wait till january when I have access to my visual studio .net
Good luck everyone.

Title:
Post by: lynx_lupo on November 16, 2005, 08:55:49 am

Unless you\'re feeling really masochistic,  I mean wanting a challenge, VC6 won\'t work. You can grab the free mingw though (devc++ should probably work too).

Title:
Post by: DaveG on November 16, 2005, 08:57:14 pm

Support for VC6 may be lost in CS at some point.

Title:
Post by: AryHann on November 16, 2005, 09:03:36 pm

CS and CEL still support Visual Studio 6. This is going to be dropped soon (if it hasn\'t been done in these days), since it has been released and made free and public this:
VC++ 2005 Express Edition available free of charge

Please, check more info on that and I guess you will have a nice product.

Anyhow, the support of PS for MSVC 6 has been lacking of interest from the team since a lot of developers use MSVC 7.1 (and somebody 8 and others of course gcc or mingw). This means that project files are not updated, that there might be compiling errors and warnings that are not fixed and you will have to deal with them. If you are really willing to try that (still I suggest the Express Edition above), contact us on #planeshift-build and we will try to help you on fixing errors and warnings.
The guide compiling-visualc.txt that you find in the /docs directory of your Planeshift copy should guide you through the main steps.
Still, if you have trouble I suggest again #planeshift-build on freenode.

If you are not used to MSVC 6 and you are going to change to MSVC 7.1 I suggest you to wait or at least use the express edition in the while. PS support for it is reduced, but I guess it could be fixed as well - I guess more and more people will use that edition.

Regards,