1 Topic by Joakin

  • Joakin
  • New member
  • Offline

Topic: Questions about code documentation

First of all, I am new here, so hi everyone.

I have to say that after searching in the forum, etc i'm quite scared about asking this things.

I'll explain my situation. I am a computer science student, and I'm trying to find a subject for my end-of-degree project. I still don't have anything clear and I'm researching information in order to get some goals.

Some weeks ago i got to know Teewars, and I was amazed. I think its an amazing game, and i love playing (more specifically hooking around smile ). The topic its that a few days ago, talking to a friend, we had the idea of using teewars as a platform to develop an learning AI (as my project manager its teaching 'AI Technics').

After reading what developers think about bots and all that stuff, im scared about the answers i could get, so im explaining a little bit. I would not like developing a bot as I understand it. Not a program you could play 'out of the box' with, not a program with different levels of skills to train with, not a cheating tool. It would be a research project about coding a learning player, kind of trying to emulate human behaviour.

I have been looking the docs here in the web page and learnt compiling the project, and also downloaded the source code to take a look at it. I must say that the code its wonderfully formatted and clean, but i would like to take a look, if it exists, to code documentation, so that I could study the viability of this idea, and figure out a clean structure to code that, so I could give that conclusions to my project manager to see if he agrees on that.

I dont know if I should ask this in the mailing list, so please, if you could give me some links or orientation it would be great.

And to end, sorry if this is a controversial topic, I am just trying to find a project topic to finish my college, and sorry for my english.

Anything, questions, demands, please dont hesitate to ask.
Great game, see you online

2 Reply by matricks

  • matricks
  • matricks
  • Developer
  • Offline

Re: Questions about code documentation

There are really no code documentation except what's in the code. You can generate some information because the interface between the engine and game are documented quite well using NaturalDocs tags. I have no workstation at home currently because my PSU crapped out on me but scripts/make_docs.sh should generate the documentation.

3 Reply by Joakin

  • Joakin
  • New member
  • Offline

Re: Questions about code documentation

I will answer myself in order to help other people.

Like said before, the script to generate documentation its in scripts/make_docs.sh which makes a call to a tool named NaturalDocs in a folder docs/ that its not there.

Right now, in 0.5.1, when you download source code from http://www.teeworlds.com/files/teeworlds-0.5.1-src.zip there is no docs folder, so its impossible to get it to work.

So in order to get everything right, open terminal and make
svn co svn://svn.teeworlds.com/teeworlds/trunk

Then copy ./trunk/docs to teeworlds_src/docs, and inside teeworlds_src folder exec ./scripts/make_docs . That should generate a folder inside docs/ called output/ where you can find all the docs in html format.

Hope its clear and helpful to some one else
Thanks to irc people for the help

4 Reply by rotsch

  • rotsch
  • Member
  • Offline

Re: Questions about code documentation

Hi Joakin!

Sounds very interesting. At the moment I also study Computer Science and I really would like to know when there is any progress on your project (of course when its finished too big_smile).

Greetings from Switzerland
-rotsch