HeckLib

HeckLib is a TypeScript library intended to be accessible to all Beat Saber modchart creators. It should be easy to set up.

---

Setup

First Time Installation

Node.js

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.

Git

Git is needed for the HeckLib installer to work properly, it can be installed here

Visual Studio Code

You need to have VSC installed on your PC, you can install it from here.

Just follow the installation and after it's installed open it up.

Library

To install the library initialiser, install the VSC extension called "HeckLib" from the extensions market in Visual Studio Code.

After installing the extension, a panel should appear to the sidebar that says "HeckLib". If it doesn't, restart VSC. If it still doesn't, contact me on Discord: Jevk#0004

The side panel should have a button that says "Download HeckLib". This will download the latest version of HeckLib to your map folder. After downloading, a popup should show up in the middle of your screen, just click cancel.

Once you've installed HeckLib to your map, you need to install the dependencies from the "Install Dependencies" button. After that you're ready to go.

If you want to update HeckLib, just click the "Update HeckLib" button. This will update all the files in your map folder to the latest version of HeckLib. Please note that this will not overwrite your script.ts file. If the button says "Download HeckLib", it will overwrite every .ts file in your map folder.

Scripting

Editing

To edit the script, open your map folder in Visual Studio Code and start editing the script.ts. This file already contains the initialisation of the map.

If you need any help with it, ask me on Discord: Jevk#0004

Running The Script

To run the script, press ctrl+1 keycombo or alternatively type nodemon ./script.ts -e ts. This will run the script and automatically restart it when you save a file..

If you want to run the script without restarting it, run node script.ts in the terminal.

For running, you may need to install the dependencies. To do this, press "Download Dependencies" when you have installed HeckLib, it will download the nessacery dependencies.

Documentation

Documentation is built into the library using JSDoc which is a standard for documenting JavaScript and TypeScript code. However, if you prefer to read the documentation online, you can find a work-in-progress version here.

---

If you have any questions, you can contact me on Discord: Jevk#0004