spenser/YARGArchipelago
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions
The APWorld for the YARG Archipelago Integration
85 commits 11 branches 12 tags 687 KiB
  • Python 100%
Find a file
Exact
Spenser Haddad 28b204347e Bugfix: forgot to return the filler item name
2026-03-06 18:58:02 -05:00
YARG Bugfix: forgot to return the filler item name 2026-03-06 18:58:02 -05:00
.gitignore better-options-and-big-refactor (#1) 2026-03-06 03:29:43 +00:00
generate_song_info.py better-options-and-big-refactor (#1) 2026-03-06 03:29:43 +00:00
LICENSE added MIT liscence 2025-12-22 14:35:00 -05:00
pyproject.toml better-options-and-big-refactor (#1) 2026-03-06 03:29:43 +00:00
README.md Change goal logic to be based on stars (#3) 2026-03-06 23:44:10 +00:00

README.md

This is an Archipelago implementation for the open source, plastic band rhythm game, YARG!

This is private fork by Spenser which both changes how the AP world works and adds his his personal collection of songs from the official Guitar Hero/Rock Band games. This includes all songs from:

  • Rock Band
  • Rock Band 2
  • Rock Band 3
  • Green Day Rock Band
  • Rock Band 4
  • Lego Rock Band
  • Rock Band Blitz
  • Rock Band AC/DC
  • The Beatles Rock Band

And, coming soon:

  • Guitar Hero
  • Guitar Hero 2
  • Guitar Hero 3
  • Guitar Hero Warriors of Rock
  • Guitar Hero World Tour
  • Guitar Hero 5
  • Guitar Hero Smash Hits
  • Guitar Hero Metallica
  • Guitar Hero Van Halen

As well as most/all the DLC from each game. Rock Band 4 has no DLC available and the other Rock Bands may have gaps. There is also an incomplete set of songs from Rock Band Network.

AP world Changes

The AP world has been practically entirely rewritten, both to refactor and also to change how the game plays to my preference. The code is simpler and formatted to my liking, and there's actually unit tests now.

But, the bigger change is that playing with this fork is quite different from the original:

  • Goal is now based on obtaining a certain number of stars when playing songs.
  • There are per-difficulty modifiers to make it so harder songs have less of their stars in logic, and to disable higher difficulties entirely.
  • You can choose whether how stars are counted:
    • Per Song: Play the song with any instrument.
    • Per Instrument: Play the song with a specific instrument.
    • Bandasanity: Play the song with ALL enabled instruments.
  • Options to choose the number of starting instruments and songs.
    • The logic for choosing starting songs is smarter now to ensure that the starting instruments chosen have enough tracks for a starting setlist.

Setup

  1. Download the YARC Launcher from https://yarg.in/
  2. Inside the YARC Launcher download "YARG Nightly" and the "YARG Official Setlist"
  3. Download the YARGAPClient from https://github.com/energymaster22/YARGAPClient/releases/latest
  4. Download Archipelago from https://github.com/ArchipelagoMW/Archipelago/releases/latest
  5. Set up Archipelago
  6. Download the YARG.apworld from https://github.com/energymaster22/YARGArchipelago/releases/latest
  7. Double click yarg.apworld to install it into Archipelago
  8. Select "Generate Template Options" from within Archipelago to get a default YAML
  9. Edit YARG.yaml to your liking and put it in your "Players" folder (should be one folder up from the "Templates" folder the previous step opened)
  10. Select "Generate" from within Archipelago
  11. Host your outputed multiworld either on https://archipelago.gg/ or locally
  12. Launch the YARGAPClient
  13. Click "Archipelago" on the main menu to open the login screen
  14. Input the host address, port and slot name and press connect! (Game ID should be left blank if not playing on a fork) (Leave blank if unsure)

Gameplay

  1. Your goal in YARG AP is to find and complete your goal song!
  2. The goal song may or may not be known depending on yaml settings.
  3. Go into "Quickplay"
  4. All of your collected songs will appear at the top in an "AP Songs" catagory
  5. Play the songs that appear there to get checks for your multiworld!
  6. When you get your goal song it will appear in an "AP Goal Song" catagory along with details on what you still need.
  7. Collect the rest of the YARG Gems in the multiworld to fully unlock the goal song.
  8. Play that song to finish the seed!

Current Notes

"Star Power Bonus" items grant 25% Star Power upon collection

If a song does not support your current instrument, or you otherwise cannot complete the song, you can use a bot player to clear it

Common Problems

My songs are not loading!

  • This can be caused by a few things. First make sure that you have downloaded the setlists from the YARC launcher.

  • Sometimes YARG needs to rescan of your library, to do so, go to Settings> Songs and click "Scan songs" up at the top

  • Other times YARG forks do not find the YARC setlists automatically. This is a slightly more involved fix:

  1. Open the YARC Launcher
  2. Scroll all the way down the left panel
  3. Click the Settings button on the bottom left
  4. Note the directory under "File Management"
  5. In the YARGAPClient go to Settings> Songs
  6. Click "Add New Folder"
  7. Click "Browse" on the new entry
  8. Navigate to the folder you saw in the YARC Launcher settings
  9. Within the YARC install folder selct the "Setlists" folder
  10. Click "Scan Songs"