Skip to content

Publishing Boards to GitHub

Jump to bottom Edit New page
nikkiwritescode edited this page Feb 18, 2024 · 5 revisions

Table of Contents

Steps

Step 1: Publish any custom music you've created to Google Drive

If you haven't done so already, please follow the steps in the following guide to create a music .zip archive and upload it to Google Drive:

If your board does not use custom music, then you can skip 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: Create a fork of the fortunestreetmodding.github.io repo.

image

  • You should see a message stating that you are creating a fork in your personal account. Click Create fork.

image

  • You are now ready to move onto Step 4!

image

Step 4: Create a Pull Request with your new content

  • Go to your fork of the fortunestreetmodding.github.io repository that you created in Step 3, and navigate to the _maps subdirectory.
  • Drag and drop your board's folder onto the web browser.
  • Fill out the Add files via upload box with New Map: <Board Name>.
  • Click the button next to Create a new branch for this commit and start a pull request.
  • Click Commit Changes.

A Pull Request should now be open for your new board!

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
Clone this wiki locally