Skip to content

Publishing Custom Music to Google Drive

Jump to bottom Edit New page
nikkiwritescode edited this page Feb 1, 2024 · 4 revisions

Table of Contents

This guide walks you through the steps to create a .zip music bundle, and upload it to Google Drive. GDrive is used as a backup when the primary download link does not work, as well as simply a method of getting the music bundle to us to upload to the primary server.

We hope to automate this process to some degree in the future, but in the meantime, this guide is intended to help you through the process of doing this manually.

Warning

Please be mindful of music copyright when creating music for your board. Distributing licensed music is a no-no, so please refrain from doing so. Irrespective of legality, people who want to stream to platforms like Twitch will not appreciate having sections of their VODs muted because you used a copyrighted song. So please keep this in mind when configuring music for your board.

Preparing your .zip Music Bundle

  • Create your custom music, if you have not done so already. If you need guidance on this, please see the our guide, Creating Custom Music for your Board.
  • Gather your custom music (.brstm) files and zip them together. Name this zip file <board_name>.music.zip, where <board_name> matches the folder name containing your actual board files.

Uploading your Music to Google Drive

  • Upload the .zip file to Google Drive.
  • In Google Drive, right-click the .zip file and click Get Link.
  • Go to https://sites.google.com/site/gdocs2direct/ and paste your link in.
  • Copy the resulting output link.
  • Inspect this link. If it does not contain the string &confirm=1, add it to the end of the link, and copy it again. It is now in the format we are looking for.

Updating the Descriptor File

Adding the download link

  • Open your .yaml Descriptor file and add the link you copied at the end of Step 1. The format should look like so, but be sure to swap in your own link:
music:
  download: https://drive.google.com/uc?export=download&id=<some_id_value_here>&confirm=1

Adding music entries

These can be added much in the same way as the download key was. You can add songs to your Descriptor file using keys that describe when they should play, like so:

music:
  download: https://drive.google.com/uc?export=download&id=<some_id_value_here>&confirm=1
  map: rigil_kent.80
  auction: broker.85
  stock: great_red_spot.70

This was covered more thoroughly in the guide, Creating Custom Music for your Board. That guide also contains a full reference for Descriptor keys, which can come in very handy when trying to determine how to customize a specific aspect of your board's presentation.

Fin!

Once you have reached this point, you're good to go! Try loading the bundle into CSMM and creating an image with it to see if it works.

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