1 Topic by kimlai

  • kimlai
  • New member
  • Offline

Topic: [QUESTION] Documentation

Hi all,

I discovered this great game today, and as I'm interested in game development (eventhough a total newbie), I downloaded the source code to check it out. I appear to be completely lost, and I was wondering if a documentation exists (doxygen style or such)...

Thanks

2 Reply by kimlai

  • kimlai
  • New member
  • Offline

Re: [QUESTION] Documentation

I've actually been learning C++ at university for two year now, and documentation is taught as an imperative in any project. Anyway, it would just have been nice, and a great gain of time, I guess I'll just have to take a closer look at the code...

3 Reply by Magnet

  • Magnet
  • Magnet
  • Developer
  • Offline

Re: [QUESTION] Documentation

Answered here: http://www.teeworlds.com/forum/viewtopic.php?id=3891

Please use forum search.

4 Reply by kimlai

  • kimlai
  • New member
  • Offline

Re: [QUESTION] Documentation

I'm sorry that I didn't see this thread in my post result... I downloaded the Doc from the link proposed, however compiling with a /docs folder doesn't generate documentation...
Anyway thanks a lot !

5 Reply by Magnet

  • Magnet
  • Magnet
  • Developer
  • Offline

Re: [QUESTION] Documentation

kimlai wrote:

I'm sorry that I didn't see this thread in my post result... I downloaded the Doc from the link proposed, however compiling with a /docs folder doesn't generate documentation...
Anyway thanks a lot !

The code went through a lot of changes since I last tried this, so maybe it does not work anymore. If it doesn't, it means there is no way to get the doc today until someone fixes it. Feel free to be that someone wink

6 Reply by Kottizen

  • Kottizen
  • Kottizen
  • Administrator
  • Offline

Re: [QUESTION] Documentation

If you want to contribute to the official development, which is highly recommended, you should go here and look at the unsolved bugs. You may clone the repository and make new features that isn't in that list, but be sure to chat with the other developers, and players, in #teeworlds-dev, to make sure you don't code anything they don't like.

If you just want to know how to compile the development version, which is the most stable one right now, follow this:
1. Download bam from here, take the development version, not any of the tags under Downloads, those are mainly for older versions of Teeworlds.
2. Extract it and run "./make_unix.sh" from the bam directory.
3. Go to your teeworlds-folder and do ../bam/bam config followed by ../bam/bam release, or server_release.

You need the SDL development libraries, Python and a compiler.

7 Reply by kimlai

  • kimlai
  • New member
  • Offline

Re: [QUESTION] Documentation

I'd be happy to try to contribute, but I've never been involved in a real project before, and I still got a lot to learn about programming... I'll take a look at the bug list, even if I doubt a could really do anything.
As for the documentation, I've generated it using the make_docs.sh script (having downloaded the perl NaturalDocs tool), but I can figure out how to add the doc generation to the bam configuration...