Frank The Farmer: Sounds like there's a new wiki page

2024-03-07T12:03:23Z

Sounds like there's a new wiki page

New page

{{TOC|right}}
== Preface ==
The <code>sounds</code> JSON is responsible for assigning sound files to any sound events. This file is not exclusive to Cobblemon. You can learn more about it from the [https://minecraft.wiki/w/Sounds.json Minecraft Wiki]. This purpose of this page is to show you how to use it with Cobblemon.
</br>
== File And Folder Format ==
The sounds JSON simply adds more sound events and files for Minecraft to play. It does not overwrite other sounds JSONs in other resourcepacks. Replacements for sound event data would need to be specified inside of the file. You can reference Cobblemon's <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/resources/assets/cobblemon/sounds.json?ref_type=heads sounds.json]</code> to see what sound events and sounds you can manipulate.

There may be times where writing a sounds JSON would be irrelevant. One example would be if you want to replace a sound, but not add any to the sound event. You can simply have your resourcepack formatted to replace the <code>ogg</code> file like you would with [[Tutorials/Texture_replacement| texture replacements]]. You can find the file address for specific sound files by searching in the <code>.jar</code> or by referencing the [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/resources/assets/cobblemon/sounds?ref_type=heads Gitlab folder for sounds.]

</br>Below is an example of how you would arrange a <code>sounds.json</code> and any custom sound files into a resourcepack:
* Minecraft only supports <code>ogg</code> sound files.
* Organization is recommended, but the correct file address is mandatory.
==== Folder Structure ====
<div class="treeview">
*''(addon name)''
** '''pack.mcmeta'''
**assets
***cobblemon
****'''sounds.json'''
****sounds
*****<primary folder>
******'''<sound>.ogg'''
******<secondary folder> (optional for organization)
*******'''<sound>.ogg''' (optional)
</div></br>

== Sounds JSON Breakdown ==
Remember that you can learn more about the <code>sounds.json</code> and its properties from the [https://minecraft.wiki/w/Sounds.json Minecraft Wiki]. Since you can only have one sounds JSON per resourcepack, you either have to group all your sound data together, or make separate resourcepacks if necessary.

</br>Below is a breakdown of a <code>sounds.json</code> performing some relevant functions. Hover over the underlined text to see more information.
{
"<abbr title="This is a specified sound event. In this case, this is the sound event for wild Pokémon escaping the pokéball. ">poke_ball.open</abbr>": {
"<abbr title="Here you will specify if the following data will replace all previously loaded data for this specific sound event. False by default if this line is not written.">replace</abbr>": <abbr title="In this case, the following data will replace previous sound event data.">true</abbr>,
"<abbr title="Here you can write the subtitle for this sound event">subtitle</abbr>": "<abbr title="This text will be displayed in the subtitles whenever a Pokémon escapes. How cruel.">Hahaha</abbr>",
"<abbr title="Here you will list the sound files that this sound event can play.">sounds</abbr>": [
"<abbr title="The file address for the 'open.ogg' sound file">cobblemon:pokeball/open</abbr>",
"<abbr title="The file address for the 'open2.ogg' sound file">cobblemon:pokeball/open2</abbr>",
{
"<abbr title="Because we want to apply the volume property to this sound specifically, it is formatted differently from the previous two. This is where we specify what file will use the following volume property.">name</abbr>": "<abbr title="The file address for the 'open3.ogg' sound file.">cobblemon:pokeball/open3</abbr>",
"<abbr title="One of the few sound json properties. Here we are setting the volume value for the previously specified 'open3.ogg' sound file. Uses a range of 0.0 to 1.">volume</abbr>": <abbr title="A value of 0.5 should let the 'open3.ogg' file play at half of its original volume.">0.5</abbr>
}
]
},
"<abbr title="This is another specified sound event. In this case, this is the sound that gets played during Charizard's cry animation. It's played whenever Charizard is summoned or at the start of a battle.">pokemon.charizard.cry</abbr>": {
"<abbr title="Here you are listing sound files this event can use. Since the mod already has a sound for this event, the listed sounds will be added to Charizard's cry sounds.">sounds</abbr>": [ "<abbr title="The file address for the 'funny.ogg' sound file.">cobblemon:pokemon/charizard/funny</abbr>" ]
}
}
If this file were loaded, it would do the following:
* Replace the data for the <code>poke_ball.open</code> sound event with the data it has here
** Add a subtitle whenever this event plays
*** If subtitles are on, "Hahaha" is what would appear during this sound event.
** Play one of the three listed sound files whenever a Pokémon escapes the pokéball.
*** All three have an equal chance to be played since a <code>weight</code> property was not applied.
*** Only <code>open3.ogg</code> would play at half volume.
* Add a new sound file to play for Charizard's cry animation
** It does not replace the original sound because the <code>replace</code> property is not written for this sound event.
** There would be a 50% chance of playing this <code>funny</code> sound whenever sending out a Charizard.
</br>
== Sounds JSON Examples ==
This section contains a couple examples of a <code>sounds.json</code> for Cobblemon addons.

</br>Below is an example of a sounds JSON that would add a sound for a custom Pokémon cry. This sound event would need to be tied to a cry animation through a sound keyframe in this specific animation. The sounds JSON creates the sound event and the animation plays the sound event. This example is not exclusive to cries. The same process would work for any sound in any animation.
{
"pokemon.tentaquil.cry": {
"sounds": ["cobblemon:pokemon/tentaquil/tentaquil_cry"]
}
}

</br>Below is an example of a sounds JSON that would replace some sound event data. Remember that you would only want to do this if you plan to add more sounds to this sound event. Otherwise, just replace the <code>ogg</code>. You can reference Cobblemon's <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/resources/assets/cobblemon/sounds.json?ref_type=heads sounds.json]</code> to see what sound events and sounds you can manipulate.
{
"poke_ball.open": {
"replace": true,
"sounds": [
"cobblemon:pokeball/open",
"cobblemon:pokeball/open2",
"cobblemon:pokeball/open3"
]
}
}

{{Addon_Creation}}

Sounds - Revision history

Frank The Farmer: Sounds like there's a new wiki page