ManiaScript Documentation

You can talk about ManiaScript for ManiaPlanet here

Moderator: English Moderator

User avatar
Gugli
Nadeo
Nadeo
Posts: 510
Joined: 14 Jun 2010, 17:35
Location: Mon PC est à Paris, mais mon coeur rode dans les forêts de Lozère

ManiaScript Documentation

Post by Gugli » 03 Jul 2012, 22:39

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
--
(>~_~)> ═╦═ ╔╦╗ <(~_~<)

User avatar
spaii
Posts: 1085
Joined: 19 Jun 2010, 00:04
Location: Rémy - France
Contact:

Re: ManiaScript Documentation

Post by spaii » 04 Jul 2012, 10:44

Tout simplement génial !! :thumbsup:

NwK
Posts: 23
Joined: 04 Jul 2012, 14:49

Re: ManiaScript Documentation

Post by NwK » 05 Jul 2012, 10:09

Merci pour l'info ça va déjà bien aidé même si ce n'est pas complet =)

User avatar
Gugli
Nadeo
Nadeo
Posts: 510
Joined: 14 Jun 2010, 17:35
Location: Mon PC est à Paris, mais mon coeur rode dans les forêts de Lozère

Re: ManiaScript Documentation

Post by Gugli » 05 Jul 2012, 13:53

I've generated a new and more accurate version (the previous one had debug API you can not access ^_^).
--
(>~_~)> ═╦═ ╔╦╗ <(~_~<)

User avatar
spaii
Posts: 1085
Joined: 19 Jun 2010, 00:04
Location: Rémy - France
Contact:

Re: ManiaScript Documentation

Post by spaii » 05 Jul 2012, 14:36

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:

User avatar
SmokyBird
Translator
Translator
Posts: 144
Joined: 15 Jun 2010, 11:02

Re: ManiaScript Documentation

Post by SmokyBird » 05 Jul 2012, 21:14

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 ? :)

User avatar
spaii
Posts: 1085
Joined: 19 Jun 2010, 00:04
Location: Rémy - France
Contact:

Re: ManiaScript Documentation

Post by spaii » 05 Jul 2012, 22:30

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 ;)

User avatar
SmokyBird
Translator
Translator
Posts: 144
Joined: 15 Jun 2010, 11:02

Re: ManiaScript Documentation

Post by SmokyBird » 05 Jul 2012, 23:43

Paaaaaaarfait, merci bien pour ton aide spaii :yes:

User avatar
spaii
Posts: 1085
Joined: 19 Jun 2010, 00:04
Location: Rémy - France
Contact:

Re: ManiaScript Documentation

Post by spaii » 06 Jul 2012, 00:16

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 ;)

User avatar
w1lla
Posts: 2360
Joined: 15 Jun 2010, 11:09
Location: Netherlands
Contact:

Re: ManiaScript Documentation

Post by w1lla » 12 Jul 2012, 10:11

Uploaded a new Maniascript documentation:

ManiaScript Documentation 2012-07-11
Last edited by w1lla on 12 Jul 2012, 11:59, edited 1 time in total.
TM² Info
SM Info
QM Info

OS: Windows 10 x64 Professional
MB: MSI 970A-G46
Processor: AMD FX-6300 3500 mHz
RAM Memory: 16 GB DDR3
Video: SAPPHIRE DUAL-X R9 280X 3GB GDDR5
KB: Logitech G510s
Mouse: Logitech G300s
Mode Creation
ManiaScript Docs

Post Reply

Return to “ManiaScript”

Who is online

Users browsing this forum: No registered users and 1 guest