Enhancement: Make an Hscript API in the modding docs

FunkinCrew / Funkin

A rhythm game made with HaxeFlixel

https://www.newgrounds.com/portal/view/770371

Other

2.97k stars 2.29k forks source link

Enhancement: Make an Hscript API in the modding docs #3097

Open Average-FNF-Modder opened 3 months ago

Average-FNF-Modder commented 3 months ago

Issue Checklist

[X] I have properly named the enhancement
[X] I have checked the issues/discussions pages to see if the enhancement has been previously suggested

What is your suggestion, and why should it be implemented?

There is currently know real way to tell how to use the features of Hscript, and seeing as there is dedicated mod documentation, I feel like the book should definitely include an Hscript API section with how to use it, all the functions and variables, etc.

AbnormalPoof commented 3 months ago

This is currently in the works. It's relatively unfinished. Screenshot 2024-08-08 at 12 52 53 AM

biomseed commented 3 months ago

There is currently know real way to tell how to use the features of Hscript,

The source code exists and there's also the already existing polymod documentation. There is no "Hscript API", and in polymod you have access to everything the source code does in hscript anyway. It's not like lua in that way.

Average-FNF-Modder commented 3 months ago

There is currently know real way to tell how to use the features of Hscript,

The source code exists and there's also the already existing polymod documentation. There is no "Hscript API", and in polymod you have access to everything the source code does in hscript anyway. It's not like lua in that way.

All I'm saying is something like that should go in the new and improved modding docs that they are building up to be EVERYTHING you need to know to mod funkin'. Everything you can do with Hscript should be included in that EVERYTHING.