1

Topic: Code Documentation

Why is there no documentation with the code or on the website?

I've been looking at the Tee Worlds source code to see if I could modify it but without some reference information it's very difficult to see what's going on, much less do anything useful with it.
I used Doxygen to generate an HTML reference showing classes, functions, etc and that seems to work well, I think this might be a helpful thing to have available, especially if it had descriptions from someone who knows what the code does!

If it was easier you might get more people to help (although this is not always a good thing!).

===I take pride in my insanity!===    |    Blender3D    |    What do you think of my post? Rate it!
Admin@SuperSiliconux128:~$quantumphysics --help -mtheory -standardmodel
[quantum_physics]: segmentation fault, core dumped

2

Re: Code Documentation

Wait for the 0.6.0 and learn Lua. Its simple language and you will can learn it very short.
Than you will can modify the code

Goodbye all. Account inactive since March 2011.

3

Re: Code Documentation

Hi,
some of documentation files you can find with the older source (http://teeworlds.com/trac/teeworlds/browser/branches), however, i dont know whether they are relevant
what says khubajsn only applies for modding some server-side functionality

Drowning dwarves lately

4

Re: Code Documentation

Just create the docs/ directory in TW root directory, then make a full bam release and it will generate HTML documentation.

5

Re: Code Documentation

Can you give some more information about Bam creating the documentation, it doesn't seem to do it when I add the folder.

Thanks for your help!

===I take pride in my insanity!===    |    Blender3D    |    What do you think of my post? Rate it!
Admin@SuperSiliconux128:~$quantumphysics --help -mtheory -standardmodel
[quantum_physics]: segmentation fault, core dumped

6

Re: Code Documentation

Just build all targets (bam all).

7

Re: Code Documentation

..\bam\src\bam all ?
With a docs folder ?
Seems don't work hmm .

lordskelethom - want to reach me quickly? https://discord.gg/teeworlds

8

Re: Code Documentation

Hi,
i upload documentation I generated:
jampv.wz.cz/output.zip
hope it helps, it is from trunk about month old

Drowning dwarves lately

9

Re: Code Documentation

You have to upload it to a website like rapidshare.com then copy the link and look at the BBcode section wink

Bye.

10

Re: Code Documentation

Copying that link to adress bar doesn't work for you?
ok,
Documentation
for really lazy ones

Drowning dwarves lately

11

Re: Code Documentation

wen teeworlds is changing to Lua do we need to get a new "bam" and ore a new way to compile ?

MertenNor

->My 24/7 servers: [NOR] Norwegian HUB <- Back Online !! big_smile
( My grammar is getting better ! smile I think.. )
-Norway

12

Re: Code Documentation

i guess not... compiling of 0.6 is no problem at all (at least in linux for now) ^^

uptee - a simple web interface for hosting and maintaining teeworlds servers
teerace - a website gathering results of trusted Race-mod servers providing global ranking and statistics
*gV* rox ^^

13

Re: Code Documentation

Well, i do have a problem compiling trunk right now, but the problem appears in dilate. It is no problem to compile the server or the client.