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
ManiaScript Documentation
Moderator: English Moderator
- Gugli
- Nadeo
- Posts: 536
- Joined: 14 Jun 2010, 17:35
- Location: Mon PC est à Paris, mais mon coeur rode dans les forêts de Lozère
ManiaScript Documentation
--
(>~_~)> â•â•¦â• ╔╦╗ <(~_~<)
(>~_~)> â•â•¦â• ╔╦╗ <(~_~<)
Re: ManiaScript Documentation
Tout simplement génial !!
Re: ManiaScript Documentation
Merci pour l'info ça va déjà bien aidé même si ce n'est pas complet =)
- Gugli
- Nadeo
- Posts: 536
- 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
I've generated a new and more accurate version (the previous one had debug API you can not access ^_^).
--
(>~_~)> â•â•¦â• ╔╦╗ <(~_~<)
(>~_~)> â•â•¦â• ╔╦╗ <(~_~<)
Re: ManiaScript Documentation
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
et c'est tout bon
exemple : http://qt-project.org/doc/qt-4.8/classes.html
Sinon joli travail
Re: ManiaScript Documentation
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 ?
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
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
C:\ProgramData\ManiaPlanet\PacksCache\ManiaPlanet_extras.zip\Scripts\Libs\Nadeo
Il y est aussi dans l'archive du serveur
Re: ManiaScript Documentation
Paaaaaaarfait, merci bien pour ton aide spaii
Re: ManiaScript Documentation
De rien !!
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
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
- w1lla
- Posts: 2396
- Joined: 15 Jun 2010, 11:09
- Manialink: maniaplanetblog
- Location: Netherlands
- Contact:
Re: ManiaScript Documentation
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
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
Who is online
Users browsing this forum: No registered users and 1 guest