Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
2 tasks done
Average-FNF-Modder opened this issue Aug 8, 2024 · 3 comments
Open
2 tasks done

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

Average-FNF-Modder opened this issue Aug 8, 2024 · 3 comments
Labels
status: pending triage The bug or PR has not been reviewed yet. type: enhancement Provides an enhancement or new feature.

Comments

@Average-FNF-Modder
Copy link

Issue Checklist

  • I have properly named the enhancement
  • 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.

@Average-FNF-Modder Average-FNF-Modder added status: pending triage The bug or PR has not been reviewed yet. type: enhancement Provides an enhancement or new feature. labels Aug 8, 2024
@AbnormalPoof
Copy link

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

@biomseed
Copy link

biomseed commented Aug 9, 2024

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
Copy link
Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: pending triage The bug or PR has not been reviewed yet. type: enhancement Provides an enhancement or new feature.
Projects
None yet
Development

No branches or pull requests

3 participants