Skip to content

Commit

Permalink
docs: about.md
Browse files Browse the repository at this point in the history
  • Loading branch information
FlafyDev committed Apr 6, 2024
1 parent c1f7f2c commit de00663
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions about.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
# Template Mod
# Auto Nong
###### <cr> This mod is still in alpha and may not work as intended. </c>

The mod automagically finds and downloads NONG songs when entering a level.

NONG stands for Not On NewGrounds and refers to any song that is not available on the original game. That means that to play it in-game, it needs to be downloaded externally and imported into the game. This mod aims to simplify that process.

Upon entering a level, a message will appear, offering the option to download the associated NONG song.

Furthermore, a new button will be integrated into levels featuring NONG songs. By clicking this button, a list of available NONG songs for the respective level will be displayed, allowing you to download them conveniently without leaving the game.


## Indexes
The mod knows which levels have NONG songs from "indexes".
You can add/remove indexes in the settings of the mod.

## Credits
Without these the mod wouldn't be possible.

- [Geode](https://github.com/geode-sdk/geode)
- [Jukebox](https://github.com/Fleeym/jukebox)
- This mod intergrates with Jukebox for swapping songs for levels.

Edit about.md to change this

0 comments on commit de00663

Please sign in to comment.