HeckLib is a JavaScript/TypeScript library intended to be accessible to all Beat Saber modchart creators. It should be easy to set up.
Node.js is the framework used to run the script in the first place, it can be found here. There's two downloads, LTS and Current, it shouldn't matter which one you use but I recommend the Current version.
IDE refers to your development environment, personally I prefer Visual Studio Code due to it's simplicity.
To install the library to your project, you can run
npm i hecklibin your project, this should install all depenedencies to run your code.
To start editing your map with scripts, you can download the template script for either language mentioned below:
To run the script, just run the command
node script.jsif you're on JavaScript. Or the commandtsx script.ts.If the TypeScript command doesn't work, you might need to install
tsxusingnpm i -g tsx. And if it still doesn't work, you might need to run it withnpx tsx script.tsIf you want to run the script everytime you save (or press
ctrl + s), you can run it using nodemon. To install nodemon, just runnpm i -g nodemon.
Documentation is built into the library using
JSDocwhich is a standard for documenting JavaScript and TypeScript code.In Visual Studio Code, the easiest way to see it is to just hover over the component you need documentation for, and an explanation should pop up.
If you have any questions, you can contact me on Discord:
jevk
If you're here to download the Heck mods (Noodle, Vivify, etc.), you're in the wrong place because Google indexing sucks. However, they can be found here:
