Hard Light Productions Forums

FreeSpace Releases => Scripting Releases => Topic started by: m!m on April 04, 2020, 03:12:47 pm

Title: A new way to look at the scripting documentation
Post by: m!m on April 04, 2020, 03:12:47 pm

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.

Title: Re: A new way to look at the scripting documentation
Post by: Goober5000 on April 04, 2020, 03:22:49 pm

Cool. :)

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

Title: Re: A new way to look at the scripting documentation
Post by: m!m on April 04, 2020, 03:26:50 pm

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.

Title: Re: A new way to look at the scripting documentation
Post by: wookieejedi on April 06, 2020, 02:37:45 pm

Very neat! I'll be playing around with this in the next few days, seems like a really nice tool update.

Title: Re: A new way to look at the scripting documentation
Post by: m!m on April 26, 2020, 09:34:48 am

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.

Title: Re: A new way to look at the scripting documentation
Post by: m!m on January 03, 2021, 10:16:01 am

After some time, I pushed another update to https://asarium.github.io/scripting-doc/

This adds full support for the recent type additions so that this should work properly again with the newest JSON.

Title: Re: A new way to look at the scripting documentation
Post by: wookieejedi on January 03, 2021, 11:00:41 am

Excellent, thanks for the update!

Title: Re: A new way to look at the scripting documentation
Post by: m!m on January 23, 2021, 04:20:19 am

The location for the newest version has changed! It's now https://doc.asarium.dev/

The significant change here is that the loaded documentation is stored locally so after a documentation definition has been loaded once, reloading the page will keep that documentation so no need to load the documentation every time.