Thank you for downloading! Here are the basics for getting started with the mod...


	Installation:

This is a mod for Deltarune chapter 4, there are a couple ways you can install it.

Mod loader:
This mod supports G3M and Deltamod mod loaders. Follow your mod loader's installation instructions and there shouldn't be an issue. Make sure your mod loader is updated since older versions may not support more recent versions of Deltamod's modding standard.

If installation does not work you may need to double check that the version of the mod is made for the version/chapter of Deltarune you are trying to install it to. (specified in the file descriptions on the mod page)


	How to use

Modifying your chart file
The "New chart" button will generate a new chart in your song list. To modify your chart, open chart settings in the editor menu after selecting your chart.

Author: Name of the charter

Album: Groups the chart with others of the same album. To add multiple, separate names with ",".

Sign file: The image to load over the door when selecting your chart, supports Gamemaker's strip image format.

Sign animspeed: The speed at which to play your strip image.

Track length: The length of your music file in seconds, tells the game when to end the song.

Note speed: How fast the notes move down the screen.

Hit file: Name of the file you want to play in the chart when notes are being hit.

Miss file: Name of the file that plays in the background, heard when notes are missed.

Menu file: File name of the music that loops in the song select menu

Layer music files: if disabled the music files with and without guitar will swap between one another rather than playing simultaneously.

C, B, A, S, T: Minimum scores for each rank.

Track start: sets where the chart begins in the song (in seconds), 0 starts the song immediately while setting it to a negative number adds a delay.

Crowd: Toggles whether applause sound effects play when playing the chart.


Adding Lyrics
To add lyrics to your chart, select the "Lyrics" tab and edit the chart, you can then place lyric notes and edit them with CTRL + LMB. Shown lyric is what is shown first, while Sung lyric is what is sung over in blue. Leaving sung blank will set it to shown, leaving both blank will clear lyrics from the screen.

Adding Events
Only recommended for advanced users.

Used to change the value of a variable at a set time.
To add events to your chart, select the "Events" tab and edit the chart, you can then place event notes and edit them with CTRL + LMB. In the menu you can add and delete events from that timestamp.

Object - The object instance to target.
Variable - The name of the variable to set.
Type - Typecasts the value to avoid crashes.
	"rea" - Real number
	"boo" - For "true" and "false"
	"ind" - Gets the index of the asset of the same name
Anything else will default to string
Value - The value to set the variable to.
On beat - Rounds to beat, -1 to disable.

Hard mode charts:
Modifying a chart when difficulty is set to hard will create a separate hard chart which can be modified freely.

When selecting a charts difficulty, the text will turn red if the chart has a valid hard mode chart.

Importing a custom chart:
To import a custom chart make sure the song you are trying to import is a .zip file.

Enter the rhythm game room
Enter the empty doorframe to enter the editor
Press "Import song"
Select the zip file of the song you wish to import

To import manually:
Create a folder within "Custom songs\Charts" and place the any required files inside
Entering the rhythm game room in castle town will automatically create the root custom song folder if one does not exist yet.

Importing ERS charts:
Placing all the chart's .txt files and music files in a folder in "Custom songs\Charts" will automatically convert it into a neo. You can also import ERS charts if they are in one of the above formats (all files in the same folder)
What isn't converted:
Album cover
What needs to be set manually after import:
Author
Album
Sign
Time signature

Exporting a custom chart:
Navigate to the Custom songs\Charts folder
Compress your chart folder to a zip file.
Name it something unique (recommended to not cause conflicts with other chart folders of the same name)
Share away. (don't forget to fill in the "Author" field with the name you want)

When sharing your custom chart make sure to include all music files used that are not in the base game if they were put in \mus instead of your chart's folder.

You may also include other chart files (and their assets) in your folder to share multiple songs at once. Using the "New chart to folder" and "Import to folder" buttons will let you group charts together for easier exporting later.


If you find any bugs (with the mod or base rhythm game), have any suggestions, or have a question not answered here, don't be afraid to contact me!
Enjoy the mod! :)