Favorites Setup - CrashCringle12/Simply-Love-SM5 GitHub Wiki

Favorites

What are Favorites?

Favorites are a single list of songs created by the player when they perform the favorite action in game on a song(s). Performing the favorite action on an already favorited song will remove the song from the player's favorite list.

How to favorite a song?

There are three ways to favorite a song:

  1. Spin pad code on ScreenSelectMusic while hovering over the song.
    Pattern: R D L U R or L D R U L (clockwise / counter‑clockwise)
  2. Spin pad code on the Evaluation Screen right after playing a song.
  3. Sort Menu → Add to Favorites (menu option).

After favoriting a song with the pad codes, you'll receive a message and hear a sound to indicate the song has been added/removed from your favorites.

Favorites.txt File location

ITGMania/Save/LocalProfiles/<ProfileID>/Favorites.txt

The file is created automatically the first time you favorite a song.

File Format

Favorites and Playlists both use "PreferredSort" format. When you first favorite a song, it will create two lines: A line starting with --- which is the name of the "Section" or "Group" as it appears in the music wheel. The theme will by default name this {your profile's display name}'s Favorites. The second line is the song you just favorited.

---Crash Cringle's Favorites
UPS 3/Mouse Dance
UPS 4/Gee
Easy As Pie 6/NoNoNo
FA and Chill 2/BIPP
Cringle Conservation/call me maybe
Unsorted/My Shiny Teeth and Me
J.U.M.P.S./Lips Are Movin
AJAX's Small Assortments/[AJAX] Better Off Alone
Cringle Conservation/Break It
Cringle Conservation/Addicted To A Memory v3
Ben Speirs' SPEIRMIX Galaxy/Thinking Out Loud
chewi pack 2017/My Neck, My Back (Lick It)
Valex's Magical 4-Arrow Adventure 10/Fake!Fake!Fake!
Cringle Asylum/Say So
Cringle Asylum/Dynamite
UPS 4/Daddy
Stupid Doubles Charts/Eskimo
Sharpnelshortz/Bluesky

What if I want to edit my file manually?

You can edit this file manually to add or remove songs. Songs are expected to be written in {PackFolder}/{SongFolder} format where Pack and Song Folder are the explicit names of the song/pack as they are on your device (this may be different from what is displayed to you in-game). Please express caution when modifying the Favorites file in particular as some modifications can break your ability to add/remove favorites in-game. More about that below

Advanced Usage

  • Multiple Sections: Manually add new sections by editing the file with new lines starting with ---.
  • Bulk-Adding Songs: Use SongGroup/* to include all songs from a specific pack.
  • Shorthand: If a song folder name is unique, simply list it without a group name.

In theory, you can modify this file to add in additional Sections which will display your favorites in multiple folders. You could also bulk add groups of songs or implicitly define songs so listing them isn't necessarily tied to pack. There are pros and cons to this:

Limitations

  • Favorites support in-game expects songs to be listed in the format {PackFolder}/{SongFolder}. Listing songs in other ways that are technically supported per Preferred Sort Formatting may break your ability to add/remove favorites ingame.
  • Adding any additional sections to your favorites will cause all future additions and removals to only act on the bottommost section (It will attempt to add/remove the song from the bottom section ignoring the rest making the entire file no longer editable in-game.
  • I have not used the implicit song definitions much, I am unsure how reliable they are and would strongly recommend using {PackFolder}/{SongFolder} format. This may affect sorting in the music wheel (Favorites is sorted alphabetically automatically by the theme)
  • If you're looking to do a lot of customization to this file I would recommend looking at Playlists instead as this may be the area you're looking for.

Playlists

Playlists operate as curated listings of songs and song groups. They can be leveraged to create your own custom groups/folders in-game known as Sections. Prior to the introduction of Playlists and Favorites, the only way to create custom sorting like this was by copying songs into a new folder on your device so the engine treated it like a Pack. The main con to this was redundancy, loss of scores (this was treated as a different leaderboard), and confusion as to which song was the original.

Use Cases for Playlists

  • Tournament Song Pools: Distribute structured lists without needing to create new song packs.
  • Sharing with Community: Easily share .txt files containing curated lists.
  • Multiple Rounds: Create distinct sections like "Round 1," "Semifinals," "Finals".
  • Combine Packs Visually: You can add entire packs with one line in the file under a new section name.

Where to put them?

If you want to add a playlist that is only visible when a specific profile is active, you'll want to drop it into the Playlist folder within that Profile. If you want the playlist to be visible for everyone, regardless of profile, drop it into the Playlist folder within the theme's Other directory. In both cases, the Playlists folder does not exist initially and will need to be created manually.

# Profile‑scoped (only shows when this profile is loaded)
ITGMania/Save/LocalProfiles/<ProfileID>/Playlists/<AnyName>.txt

# Machine‑wide (visible to every player)
Themes/Simply Love/Other/Playlists/<AnyName>.txt   # example path – varies by theme

Create the Playlists folder yourself if it doesn’t exist.

File Format

Favorites and Playlists both use "PreferredSort" format. Please see https://github.com/CrashCringle12/Simply-Love-SM5/wiki/Preferred-Sorting#structure-of-a-preferred-sort-file for more information on how this file is formatted if you wish to make modifications.

---Penn State Local Tournament 1
UPS 3/Mouse Dance
Easy As Pie 6/*
FA and Chill 2/BIPP
Lips Are Movin
---Penn State Local Tournament 2
AJAX's Small Assortments/[AJAX] Better Off Alone
FA and Chill 2/*
Cringle Conservation/call me maybe
J.U.M.P.S. 2/*
---Penn State Local Tournament 3
Cringle Asylum/*
UPS 4/wah-propaganwah (habstrakt remix) (ddrillini remix)

Quick Reference Examples

Full Deets: https://github.com/CrashCringle12/Simply-Love-SM5/wiki/Preferred-Sorting

Objective Syntax Result
New section ---Warm-Up Charts Creates a "Warm-Up Charts" section
Single specific song UPS 3/Mouse Dance Includes one song explicitly
Single song with inferred group Mouse Dance Locates the first song with this as the Song Folder or Song Title + SubTitle combo
Entire pack VibeSonic 5/* Includes all songs from the pack

Limitations of Playlists

  • Playlists must be edited manually (no in-game editing yet) or through a Module.
  • Backwards Compatibility issues with SM5

Favorites vs. Playlists

Both Favorites and Playlists utilize Preferred Sort functionality, but their purposes and behaviors differ. It's not recommended to make manual modifications to your favorites file with the exception of merely bulk adding or removing songs from the list. If you're looking to really customize the file and make it your own "Playlist" with specific sections and all, I recommend using Playlists

Feature Purpose Location Editable In-Game?
Favorites Still Writing this! Save/LocalProfiles/<ID>/Favorites.txt Yes
Playlists Static*, shareable sets of songs (e.g., tournaments) Save/LocalProfiles/<ID>/Playlists/*.txt (or theme folder) No (currently manual edits only)
  • Favorites are automatically sorted alphabetically as new songs are added (even if the file is edited manually)

  • Playlists remain sorted as they are written in the file explicitly

  • Both Favorites and Playlists have support for additional sections; however, adding additional sections to your Favorites at this time will cause all future additions and removals to only act on the bottommost section (It will attempt to add/remove the song from the bottom section ignoring the rest making the entire file no longer editable in-game.

Frequently Asked Questions (FAQ)

  • Q: Can a song exist in multiple sections within my Playlist/Favorites file?
    A: Yes! This was a limitation of SM5, but this is fully supported in ITGMania.

  • Q: How do I share Playlists?
    A: All you have to do is give them the file for that specific playlist and all they must do is drop it into their playlist folder. Done!

  • Q: If both favorites and playlists use preferred sorting...does that mean I could put my Favorites.txt file in my playlist folder?
    A: Yes! If you put your Favorites file in the Playlists folder of your profile...when you go to the Sort Menu you'll see a new playlist called "Favorites" (since that's the name of the file) and it will contain your favorites. The sort menu however already automatically includes your favorites under the list of available playlists so there is no need to copy this file.

  • Q: What is Preferred Sort?
    A: PreferredSort is another Sort order similar to sorting by "Title", "BPM", "Artist", or "Group"...you can also switch to "Preferred". All this means is you're using a custom sort. More information in depth is available here: https://github.com/CrashCringle12/Simply-Love-SM5/wiki/Preferred-Sorting

  • Q: Can I have multiple Favorites files?
    A: No, each profile supports one Favorites.txt file. If you multiple favorites files, it sounds like you might be looking for Playlist functionality!

  • Q: Is there a way to dynamically modify or create playlists?
    A: The benefit of having a folder housing playlists is that all we have to do is drop a file in for it to be read. Themers or overall curious souls can create Modules that generate/modify playlists. An example of one is the ITL Ranking Points Playlist Module found here (Dynamically generates and updates a playlist that sorts ITL songs by your achieved RP)

⚠️ **GitHub.com Fallback** ⚠️