This page explains how to create a resource pack compatible with Music Interface to add your own music into Minecraft. The mod uses a standard Minecraft resource pack structure, with a few specific files that must be provided.
{% endhint %} *** ## ๐ฆ Minimum Pack Structure Your pack must follow this structure: ``` My Music Pack/ |-- pack.mcmeta |-- pack.png <- optional, but recommended \-- assets/ \-- musicinterface/ |-- music_data.json |-- sounds.json |-- sounds/ | \-- custom/ | |-- my_first_music.ogg | \-- my_battle_theme.ogg \-- textures/ \-- covers/ |-- my_first_music.png \-- my_battle_theme.png ``` ๐ The namespace used by the mod is **`musicinterface`** โ this must be respected exactly. *** ## ๐ Pack Location Place your pack folder inside: ``` .minecraft/resourcepacks/ ``` *** ## โ๏ธ 1. The `pack.mcmeta` File Simple example: ``` { "pack": { "pack_format": 34, "description": "My Music Interface music pack" } } ``` ### ๐งพ Notes * `pack_format` must match the targeted Minecraft version * If unsure, use the version matching your modpack *** ## ๐ง 2. Audio Files Music files must be placed here: ``` assets/musicinterface/sounds/custom/ ``` Example: ``` assets/musicinterface/sounds/custom/my_first_music.ogg ``` โ Recommendations * Use the **`.ogg`** format * Avoid spaces and accents in file names * Prefer simple names such as: * `legendary_theme.ogg` * `battle_theme.ogg` * `route_01.ogg` *** ## ๐ 3. The `sounds.json` File This file registers sounds on the Minecraft side. ``` { "custom/my_first_music": { "sounds": [ { "name": "musicinterface:custom/my_first_music", "stream": true } ] }, "custom/my_battle_theme": { "sounds": [ { "name": "musicinterface:custom/my_battle_theme", "stream": true } ] } } ``` ๐ Important points * The key on the left must match the declared music entry * The `name` field must point to the correct audio file * For a file located at `sounds/custom/my_first_music.ogg`, the correct value is: * `musicinterface:custom/my_first_music` * Keeping `stream: true` is recommended for long music tracks *** ## ๐ผ 4. The `music_data.json` File This file is used by **Music Interface** to display music tracks in-game. ``` [ { "id": "my_first_music", "title": "My First Music", "author": "Your Name", "album": "My Album", "sound": "musicinterface:custom/my_first_music", "cover": "musicinterface:textures/covers/my_first_music.png", "enabled": true, "weight": 1 }, { "id": "my_battle_theme", "title": "My Battle Theme", "author": "Your Name", "album": "My Album", "sound": "musicinterface:custom/my_battle_theme", "cover": "musicinterface:textures/covers/my_battle_theme.png", "enabled": true, "weight": 1 } ] ``` ### ๐งฉ Field Explanations * `id`: Unique identifier * `title`: Displayed title in-game * `author`: Author / Composer * `album`: Album or collection * `sound`: Sound resource declared in `sounds.json` * `cover`: Cover image * `duration`: Displayed duration, free text field * `enabled`: Enables or disables the track by default * `weight`: Selection weight if the system randomly chooses between multiple tracks **โ ๏ธ Reminder:** * Each `id` must be unique * Each `sound` value must correspond to a valid entry * If you do not want to manage duration, you can leave it as an empty string *** ## ๐ผ๏ธ 5. Covers Cover images must be placed here: ``` assets/musicinterface/textures/covers/ ``` Example: ``` assets/musicinterface/textures/covers/my_first_music.png ``` Then reference them like this inside `music_data.json`: ``` "cover": "musicinterface:textures/covers/my_first_music.png" ``` ๐ If a cover is missing or invalid, the mod may use a fallback image, but it is **recommended** to **always** provide one. *** ## ๐งช Complete Copy-Paste Example ### ๐ Folder Structure ``` My Music Pack/ |-- pack.mcmeta \-- assets/ \-- musicinterface/ |-- music_data.json |-- sounds.json |-- sounds/ | \-- custom/ | \-- route_01.ogg \-- textures/ \-- covers/ \-- route_01.png ``` ### โ๏ธ `pack.mcmeta` ``` { "pack": { "pack_format": 34, "description": "Route 01 Music Pack" } } ``` ### ๐ `sounds.json` ``` { "custom/route_01": { "sounds": [ { "name": "musicinterface:custom/route_01", "stream": true } ] } } ``` ### ๐ผ `music_data.json` ``` [ { "id": "route_01", "title": "Route 01", "author": "Your Name", "album": "My Pack", "sound": "musicinterface:custom/route_01", "cover": "musicinterface:textures/covers/route_01.png", "enabled": true, "weight": 1 } ] ``` *** ## โถ๏ธ Enable the Pack In-Game 1. Place the pack inside the `resourcepacks` folder. 2. Launch Minecraft with the mod installed. 3. Enable the resource pack in the resource packs menu. 4. Then check the mod interface to verify that the tracks appear correctly. *** ## โ ๏ธ Common Errors ### ๐ต Music Does Not Appear Make sure: * `music_data.json` is correctly placed inside `assets/musicinterface/` * the JSON is valid * the `id` is unique * the pack is **properly enabled** in-game ### ๐ Music Appears but Does Not Play Make sure: * the `.ogg` file actually exists * the filename exactly matches the entry in `sounds.json` * `sound` inside `music_data.json` correctly matches the declared entry Correct example: ``` "sound": "musicinterface:custom/route_01" ``` ### ๐ผ๏ธ Cover Does Not Display Make sure: * the image is inside `assets/musicinterface/textures/covers/` * the path in `cover` is correct * the file is a `.png` *** ## ๐ง Best Practices * Keep filenames lowercase * Replace spaces with underscores `_` * Use one cover image per track whenever possible * Test with a single track first before adding many *** ## ๐งฑ Recommended Workflow The easiest approach is to create a new pack folder, then gradually add: * The `pack.mcmeta` file * Your `.ogg` audio files * The `sounds.json` file * The `music_data.json` file * Your `.png` cover images *** ## ๐งพ Summary For a pack to work, you need at minimum: * One `pack.mcmeta` * One or more `.ogg` files * A `sounds.json` * A `music_data.json` * Ideally one `.png` image per track If you follow the structure and paths shown on this page, your pack will be compatible with **Music Interface**. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://our-story-network.gitbook.io/cr-wiki/cr-en/mod-guides/musicinterface.md?ask=