Skip to content

Commit

Permalink
chore: update some metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
Fleeym committed Jan 26, 2025
1 parent e5c9162 commit 7b9a5b9
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 14 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,41 +2,40 @@

<img src="./logo.png" alt="Jukebox logo" />

Jukebox is a song manager for Geometry Dash made with the goal of simplifying the process of swapping Newgrounds (or music library) songs with any NONGs.
Jukebox is a song manager for Geometry Dash made with the goal of simplifying the process of swapping in-game songs with any NONGs.

## What is a NONG, anyway?

NONG stands for **Not On NewGrounds**. Basically, it means any song that is not on Newgrounds / the music library that was replaced manually through the game files.
NONG stands for **Not On NewGrounds**. Basically, it means any song that is not available in-game that was replaced manually through external means.

NONGs have always been a hassle to manage, because some level creators use popular Newgrounds song IDs and replace them with a NONG. So you have to swap those song files around quite a bit if you play a level with the Newgrounds song and a level with a NONG song.

## Start your jukebox!

Jukebox makes the process of managing your songs a breeze. You can download your NONGs using your method of choice. My recommandations are: [Cobalt](https://cobalt.tools/) and [yt-dlp](https://github.com/yt-dlp/yt-dlp), a CLI application. After getting your MP3 file, you can enter a song and author name, for easier management.

> Note that Jukebox copies imported MP3 files in the storage location designated by Geode. You can open this folder from ingame.
> Note that Jukebox copies imported songs in the storage location designated by Geode. You can open this folder from ingame.
Alternatively, you can download songs **ingame** from configurable sources, known as indexes. Jukebox provides the **Song File Hub** index as a base, which is a database of NONGs made specifically for Geometry Dash. Ideally, you should be able to get most of the songs you need from here :)

> You can add your own indexes if you want, more documentation on this will be provided soon!
## So, how do I begin?

You can open up the Jukebox menu from any level page. Just click on the song name, and either a song list (if the level has multiple songs), or the song management screen (if the level only uses 1 song) will open. From here, you can add, remove, download and swap songs.
You can open up the Jukebox menu from any level page. Just click on the song name, and the song management screen will open. From here, you can add, remove, download and swap songs.

## Reporting bugs

You can report bugs on the [Jukebox Discord server](https://discord.gg/SFE7qxYFyU)
You can report bugs on the [Song FIle Hub Discord server](https://discord.gg/SFE7qxYFyU)

## Credits

- The Geode team, for creating such an amazing toolkit
- Flafy, for creating Auto Nong and afterwards becoming a co-developer
- The nice lads over at Song File Hub for managing the biggest NONG database in GD
- hiimjustin, for porting the mod to MacOS
- hiimjasmine, for porting the mod to MacOS
- undefined06855, for helping me with parsing song metadata using FMOD

## Licensing

This mod is licensed under **MIT**, so poke around, everything is free as in speech.

12 changes: 6 additions & 6 deletions about.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,37 @@
# Jukebox

Jukebox is a song manager for Geometry Dash made with the goal of simplifying the process of swapping Newgrounds (or music library) songs with any NONGs.
Jukebox is a song manager for Geometry Dash made with the goal of simplifying the process of swapping in-game songs with any NONGs.

## What is a NONG, anyway?

NONG stands for **Not On NewGrounds**. Basically, it means any song that is not on Newgrounds / the music library that was replaced manually through the game files.
NONG stands for **Not On NewGrounds**. Basically, it means any song that is not available in-game that was replaced manually through external means.

NONGs have always been a hassle to manage, because some level creators use popular Newgrounds song IDs and replace them with a NONG. So you have to swap those song files around quite a bit if you play a level with the Newgrounds song and a level with a NONG song.

## Start your jukebox!

Jukebox makes the process of managing your songs a breeze. You can download your NONGs using your method of choice. My recommandations are: [Cobalt](https://cobalt.tools/) and [yt-dlp](https://github.com/yt-dlp/yt-dlp), a CLI application. After getting your MP3 file, you can enter a song and author name, for easier management.

> Note that Jukebox copies imported MP3 files in the storage location designated by Geode. You can open this folder from ingame.
> Note that Jukebox copies imported songs in the storage location designated by Geode. You can open this folder from ingame.
Alternatively, you can download songs **ingame** from configurable sources, known as indexes. Jukebox provides the **Song File Hub** index as a base, which is a database of NONGs made specifically for Geometry Dash. Ideally, you should be able to get most of the songs you need from here :)

> You can add your own indexes if you want, more documentation on this will be provided soon!
## So, how do I begin?

You can open up the Jukebox menu from any level page. Just click on the song name, and either a song list (if the level has multiple songs), or the song management screen (if the level only uses 1 song) will open. From here, you can add, remove, download and swap songs.
You can open up the Jukebox menu from any level page. Just click on the song name, and the song management screen will open. From here, you can add, remove, download and swap songs.

## Reporting bugs

You can report bugs on the [Jukebox Discord server](https://discord.gg/SFE7qxYFyU)
You can report bugs on the [Song FIle Hub Discord server](https://discord.gg/SFE7qxYFyU)

## Credits

- The Geode team, for creating such an amazing toolkit
- Flafy, for creating Auto Nong and afterwards becoming a co-developer
- The nice lads over at Song File Hub for managing the biggest NONG database in GD
- hiimjustin, for porting the mod to MacOS
- hiimjasmine, for porting the mod to MacOS
- undefined06855, for helping me with parsing song metadata using FMOD

## Licensing
Expand Down
2 changes: 1 addition & 1 deletion mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"description": "A simple song manager for Geometry Dash",
"repository": "https://github.com/Fleeym/jukebox",
"links": {
"community": "https://discord.gg/SFE7qxYFyU",
"community": "https://discord.gg/maSgd4zpEF",
"source": "https://github.com/Fleeym/jukebox"
},
"issues": {
Expand Down

0 comments on commit 7b9a5b9

Please sign in to comment.