Creating an Asset Replacement mod

This guide will walk you through the process of creating an asset replacement mod for custom songs.

Prerequisites

Before you start, ensure you have the following:

• Basic knowledge of handling files and folders on your computer.
• A software to zip files (e.g., WinRAR, 7-Zip).
• Your music files in MP3, WAV, or OGG format.
• Permission from the creator to upload their music onto Thunderstore (do NOT just violate copyright)

Step 1: Create Your Mod Folder

Begin by creating a new folder for your mod. This is where all your mod files will be stored. You can name this folder anything.

Step 2: Add a Manifest File

Create a manifest.json file in your mod folder. Open it with any text editor and paste in this template:

{
    "name": "Your Mod Name",
    "version_number": "1.0.0",
    "website_url": "",
    "description": "Describe your mod here",
    "dependencies": [
        "CodeEnder-Custom_Boombox_Fix-1.2.3"
    ]
}

Modify the manifest to add your mod name and a description.

Step 3: Add a README File.

Add a README.md file and open it with any text editor. Write anything that you would like displayed on your mod's page. This is in markdown format, so get creative!

Step 4: Create the Custom Songs Folder

Inside your mod folder, create the path plugins/Custom Songs. This is where you'll place all your music files.

Step 5: Add Your Music Files

Place your music files (MP3, WAV, or OGG) into theplugins/Custom Songs folder.

Step 6: Create an icon

This will be the image displayed in the Thunderstore. it can be any 256x256 image and must be named icon.png.

Step 7: Zip the Files

Select the files (the plugins folder, the README, the icon, and the manifest) and then right click -> send to -> compressed (zip) folder. IMPORTANT: you are zipping the FILES, not the parent folder.

Step 8: Upload to Thunderstore

Finally, upload your .zip file to Thunderstore. Make sure to tag your mod as an asset replacement to categorize it correctly.

Extra

Special credit to Uber_Dragon for suggesting multiple fixes and improvements