Spring documentation

Spring 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
cgkanchi
Posts: 6
Joined: 08 Jan 2010, 01:09

Spring documentation

Post by cgkanchi »

Hello all, I'm just getting started with spring (I'm in the process of installing the dependencies) and I decided, mostly for my own reference, to put the Doxygen generated documents on my website. It's available both online and as a tarball. If anyone is interested, I can post the links here. Since this is my first post, I didn't want to post an external link since it looks suspicious.

Cheers,
cgkanchi
User avatar
lurker
Posts: 3842
Joined: 08 Jan 2007, 06:13

Re: Spring documentation

Post by lurker »

Bah, the spam that comes here is wow gold all low grade bots.
cgkanchi
Posts: 6
Joined: 08 Jan 2010, 01:09

Re: Spring documentation

Post by cgkanchi »

Alrighty then! At a forum I moderate, we are getting insane amounts of spam from humans who post semi-coherent posts in not-very-good English and after a few days, a link appears in their signature. Very annoying, since the CAPTCHAs don't keep them out.
So without further ado, I refer you to:

http://springdocs.amphiesma.com/

Cheers,
cgkanchi
User avatar
lurker
Posts: 3842
Joined: 08 Jan 2007, 06:13

Re: Spring documentation

Post by lurker »

I guess we've had a couple of those, but no great flood.
The 4 captcha is very effective.
User avatar
Peet
Malcontent
Posts: 4384
Joined: 27 Feb 2006, 22:04

Re: Spring documentation

Post by Peet »

Any idea why the graphical class hierarchy isn't showing up?
cgkanchi
Posts: 6
Joined: 08 Jan 2010, 01:09

Re: Spring documentation

Post by cgkanchi »

Bleh, looks like I don't have Graphviz installed, so Doxygen quietly failed to generate the class hierarchy. Installing it now. If you try later today at some point, it should be there.

Cheers,
cgkanchi
User avatar
Beherith
Posts: 5145
Joined: 26 Oct 2007, 16:21

Re: Spring documentation

Post by Beherith »

Hmm I would like to take a look at the graphical class hierarchy :)
Auswaschbar
Spring Developer
Posts: 1254
Joined: 24 Jun 2007, 08:34

Re: Spring documentation

Post by Auswaschbar »

Beherith wrote:Hmm I would like to take a look at the graphical class hierarchy :)
  • $ doxygen
  • wait some minutes
  • browse class hierarchy and documentation with your favorite browers locally
cgkanchi
Posts: 6
Joined: 08 Jan 2010, 01:09

Re: Spring documentation

Post by cgkanchi »

Bloody hell! I generated the docs with the images, put them in a tarball and started uploading them. It turns out that the docs when generated with images are 1.3 gigs!! Oh well, hooray for unlimited disk-space/bandwidth!

It'll take a while to upload though, so check the site tomorrow, the docs should be back there and have images.
redwyaster5
Posts: 20
Joined: 14 Jun 2009, 03:50

Re: Spring documentation

Post by redwyaster5 »

Hi so my freind and I downloaded a working binary of the mac osx spring game. We got the mods and maps. Now we I started a game and he would join. Simple right WRONG!! The game says unnamed player atempted to join but was rejected becouse it he wasn'int in the script. We really need some help on this one. Were can i find the script to fix that? We are using direct connect.
Societal
Posts: 64
Joined: 05 May 2009, 13:57

Re: Spring documentation

Post by Societal »

You aren't in the right thread or forum. "Documentation" here refers to the source code documentation, not user documentation. :-)

By "Direct Connect" I assume you mean you launched the game directly from the Spring executable. It would be a lot easier to use Springlobby instead, if you can follow the directions and build it. Then you could host a passworded server he connects to and let the lobby handle the script.
cgkanchi
Posts: 6
Joined: 08 Jan 2010, 01:09

Re: Spring documentation

Post by cgkanchi »

Bah, sorry about this guys, but my internet died while uploading the docs yesterday. I will upload on Monday morning from my work's 100+ meg connection. Shouldn't take long at that speed :D
User avatar
AF
AI Developer
Posts: 20687
Joined: 14 Sep 2004, 11:32

Re: Spring documentation

Post by AF »

Shouldnt the uber compression ratio of zip on text files be a factor here?

And where's the url to the latest OS X build!!!!
redwyaster5
Posts: 20
Joined: 14 Jun 2009, 03:50

Re: Spring documentation

Post by redwyaster5 »

Exelent QUESTION!!
Tobi
Spring Developer
Posts: 4598
Joined: 01 Jun 2005, 11:36

Re: Spring documentation

Post by Tobi »

Sorry to disappoint you cgkanchi, but there's already some doxygen docs online here:

http://springrts.com/doxygen/

Half a year old though but I'm regenerating it now.

Thanks for the effort either way, and if you have patches to the Doxyfile / custom style / extra frontend / you name it, improvements are always welcome ;-)
User avatar
Caydr
Omnidouche
Posts: 7179
Joined: 16 Oct 2004, 19:40

Re: Spring documentation

Post by Caydr »

AF, guy guilty by association who posted after AF, keep your shite in Off Topic, with me and the rest of the assholes. They're doing srs business here. They're makin rockets n shit.
User avatar
AF
AI Developer
Posts: 20687
Joined: 14 Sep 2004, 11:32

Re: Spring documentation

Post by AF »

I develop things, what do you do?
User avatar
Caydr
Omnidouche
Posts: 7179
Joined: 16 Oct 2004, 19:40

Re: Spring documentation

Post by Caydr »

Right now? I just collect royalties for my previous good deeds in the form of moderator tolerance in the face of douchery. But soon... soon...
cgkanchi
Posts: 6
Joined: 08 Jan 2010, 01:09

Re: Spring documentation

Post by cgkanchi »

Well, it's up now if anyone wants it. I'm going to keep it there anyway, since I don't feel like using up 1.3 gigs of disk space, so feel free to use that site whenever you want or need to.

Cheers,
cgkanchi
Post Reply

Return to “Engine”