Page 1 of 10

ManiaScript Documentation

Posted: 03 Jul 2012, 22:39
by Gugli
Edit Eole:
I made a tutorial on how to generate the ManiaScript API Documentation. It's available here:
http://maniaplanet.github.io/documentat ... e-doc.html

I explain how to generate the documentation from ManiaPlanet.exe, how to create an html version of the documentation with Doxygen and eventually give a batch file who do all of the above in one click.
(Click here to get the batch)

Edit2:
For more info about ManiaScript you can read this page:
http://maniaplanet.github.io/documentation/maniascript/
I'll try to update it over time.

===============================================================================================

Starting in the upcoming version, everyone will be able to generate ManiaScript API documentation. You have to launch ManiaPlanet.exe with the argument /generatescriptdoc=PATH_TO_SOME_FILE.

Exemple : ManiaPlanet.exe /generatescriptdoc=C:\Foobar.h

It will generate a file looking like C++, describing the script API. You can then use a tool such as Doxygen to generate a browsable documentation. There are still lots of blanks, but it will probably be useful anyway.

Here is an doc generated with the upcoming version :
http://files.maniaplanet.com/scriptdoc/2012-07-03.zip

And here is the little tool I use to generate the doc using Doxygen. Feel free to use it or adapt it to your needs.
(Launch the .bat file, it should open Maniaplanet. Close Maniaplanet, and you're set ^_^)
http://files.maniaplanet.com/scriptdoc/Doxygen.zip

Re: ManiaScript Documentation

Posted: 04 Jul 2012, 10:44
by spaii
Tout simplement génial !! :thumbsup:

Re: ManiaScript Documentation

Posted: 05 Jul 2012, 10:09
by NwK
Merci pour l'info ça va déjà bien aidé même si ce n'est pas complet =)

Re: ManiaScript Documentation

Posted: 05 Jul 2012, 13:53
by Gugli
I've generated a new and more accurate version (the previous one had debug API you can not access ^_^).

Re: ManiaScript Documentation

Posted: 05 Jul 2012, 14:36
by spaii
Il manque juste des commentaires et des explications sur les fonctions, etc...
et c'est tout bon ;)

exemple : http://qt-project.org/doc/qt-4.8/classes.html

Sinon joli travail :thumbsup:

Re: ManiaScript Documentation

Posted: 05 Jul 2012, 21:14
by SmokyBird
Merci pour l'outil !

Pour tout ce qui touche aux fichiers Victory.Script à inclure dans le script, on trouve ça où s'il vous plaît ? :)

Re: ManiaScript Documentation

Posted: 05 Jul 2012, 22:30
by spaii
J'ai pas encore ShootMania et je sais pas si ça peut t'aider, j'ai vu un fichier Victory.Script.txt dans :
C:\ProgramData\ManiaPlanet\PacksCache\ManiaPlanet_extras.zip\Scripts\Libs\Nadeo

Il y est aussi dans l'archive du serveur ;)

Re: ManiaScript Documentation

Posted: 05 Jul 2012, 23:43
by SmokyBird
Paaaaaaarfait, merci bien pour ton aide spaii :yes:

Re: ManiaScript Documentation

Posted: 06 Jul 2012, 00:16
by spaii
De rien !! ;) :yes:

Je suis un grand curieux, je peux te demander ce que tu essayes de faire ?

Car je potasse aussi le maniascript pour faire un mode "Stunt" sur Canyon, alors si tu as des informations, elles sont les bienvenues ;)

Re: ManiaScript Documentation

Posted: 12 Jul 2012, 10:11
by w1lla
Uploaded a new Maniascript documentation:

ManiaScript Documentation 2012-07-11