Skip to content
This repository was archived by the owner on Dec 30, 2023. It is now read-only.

Custom Note Script

skellypupper edited this page Jun 7, 2023 · 10 revisions
Empty Script

An example note script can be found here.

function create(curUi:String) {}
function update(elapsed:Float) {}

How to Use

Make a custom note script at custom-notes/<yourcoolnote>.hxs, the name you choose is what will appear in the charting state. It's recommended you put your note assets somewhere in images/strums but anywhere in the images folder works.

If you've set it up properly your custom note should appear in the charting state, under the Note Data tab.

Please note that custom notes with no graphics currently appear as regular notes in the charting state, it's recommended to make some graphical change for charting.

image

Variables

  • note: the current note class (extended FlxSprite), used to edit the note.

Callbacks (All Optional)

If you want a custom note without any graphical changes, you could just make an empty file.

  • create(curUi:String): Called when creating the note sprite, set your graphics here.
  • update(elapsed:Float): Called every frame.