Updating boards published on GitHub - FortuneStreetModding/fortunestreetmodding.github.io GitHub Wiki

Table of Contents

Steps

Step 1: Update the custom music you've shared on Google Drive

If you have added or updated custom music and haven't created it yet, please follow the steps in the next guide to create a music .zip archive and upload it to Google Drive:

If the board is not using custom music or if there are no additions or updates to custom music, proceed directly to Step 2.

Step 2: Clean up your board's directory.

Now that the music files are in Google Drive, you can remove those from the directory. The background is also hosted elsewhere, so you can remove those files too. When finished, you should be left with the following files:

  • any number of .frb files representing your board states
  • a matching number of .webp files, which are screenshots of each board state
  • a .yaml descriptor file
  • a .png board icon file

Note

If you've got the files from a background present as well, or if you are making a background to go along with your board, you might have another .webp file that is a thumbnail for the background, and/or .png files that have filenames containing ui_turnlot in them. These files should be discarded -- we only want to keep files that are specific to your board.

Step 3: Store the board in the repository.

  • Go to the fork of the fortunestreetmodding.github.io repository created when publishing the board.
  • If you see the message This branch is <number> commits behind, click Sync fork and then Update branch. The repository will be updated to the latest state.
image
  • then navigate to the _maps subdirectory.
  • Click Add file, then click Upload files.
image
  • Drag and drop your board's folder onto the web browser.
  • Fill out the Add files via upload box with Update: <Board Name>.
  • Select Commit directory to the main branch.
  • Click Commit Changes.

Step 4: Create a Pull Request with your new content

  • Click Contribute, then select Open pull request.
image
  • Enter the name of the pull request in the Add a title field.
  • Click Create pull request. A Pull Request should now be open for your new board!

Step 5: Respond to the Custom Street Board Submission Form

If you have multiple custom music additions or updates, please answer the questions about the board you created using the form at the link below.

Conclusion

Uploading your content is not that difficult, the process just takes some getting used to. If you have trouble, please feel free to reach out on the Custom Street Discord server! We're always happy to help.

Next Steps

If you need help with anything, feel free to reach out! The best place to reach out is on Discord: there are several active communities that can help with the various aspects of mod-making.

Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️