Author Topic: A new way to look at the scripting documentation  (Read 375 times)

0 Members and 1 Guest are viewing this topic.

Online m!m

  • 211
A new way to look at the scripting documentation
I have been working on improving the scripting documentation because I wanted to learn some web development :p

You can find it here: https://asarium.github.io/scripting-doc/
This works with the relatively new scripting.json output which makes the scripting documentation machine readable. You can enable output of that from FSO by enabling "Output scriping doc to scripting.json" in your launcher similarly to how the previous documentation works. That will generate a scripting.json file in the same directory as scripting.html.
You can then select that file or drag'n'drop it on the page I linked above.

This is a very early version that is also not really optimized for performance.

In the future I would like to generate scripting.json files for each nightly and final release and then have a list of those versions directly on that page so that you don't have to always search for your scripting.json.

Please let me know what you think and what features you can think of that could be added in the future.

 

Offline Goober5000

  • HLP Loremaster
  • Administrator
  • 214
    • Goober5000 Productions
Re: A new way to look at the scripting documentation
Cool. :)

It doesn't work with the Pale Moon browser, FYI.  It works fine with Firefox and Brave.

 

Online m!m

  • 211
Re: A new way to look at the scripting documentation
Thanks for letting me know. Browser Compatibility wasn't really a goal in this version but it should definitely work with Firefox and Chrome since that is what I develop with.

 

Offline wookieejedi

  • 28
  • Intensify Forward Firepower
Re: A new way to look at the scripting documentation
Very neat! I'll be playing around with this in the next few days, seems like a really nice tool update.

  

Online m!m

  • 211
Re: A new way to look at the scripting documentation
I pushed another update that should improve performance a bit. This now only supports the JSON documentation generated by recent nightlies so it will fail if you try to use an earlier version of scripting.json.