Any tutorials or links to tutorials on how to add custom sound effects wit Minecraft Forge? I see the ISoundHandler but I am not sure how to use it.

We need one.  Want to figure it out and post it to the wiki?

Yes once I figure it out. Any hints on how to use it?

once you figure it out tell me i want to add some sounds too my steam power addon and really don't want to use audioMod.

https://github.com/pahimar/Equivalent-Exchange-3/blob/master/ee3_client/ee3/client/SoundHandler.java

https://github.com/pahimar/Equivalent-Exchange-3/blob/master/ee3_client/ee3/client/SoundHandler.java

Much easier than the old way i used before forge

Figured it out. It is a lot simpler than it looks. Thanks for the help and the links!

 

EDIT: I would I distribute my sounds? The sounds should be placed in the resource file but how I can include the sounds in my ZIP and having them work? Also, I am not sure how would I get an entity to keep playing this ambient sound while it is alive. I saw there is this thing called sound streaming and I am not sure how to use it. I tried calling play sound every tick but it just made REALLY LOUD overlapping sound fxs.

I saw Industrialcraft have their sounds in their zip file. How does that work without putting the sound files in the resource file?

https://github.com/pahimar/Equivalent-Exchange-3/blob/master/ee3_client/ee3/client/SoundHandler.java

I already read that link. That's for the help. From what I see, they seem to have their sound files in a "sound" directory in the zip. I will try using that.

 

And another question: How can I make a block to constantly play an ambient sound (when specified to do so by it's tile entity of course)? Industrialcraft has these machines that will keep playing noise as long as they're working. I can not use the world.playSoundEffect function since it doesn't really work well for this. I have a loop able sound track for some of my machines that I would like to have them used.

Likely the tick function just replays the sound effect every %something ticks while it is working, based on the length of the sound.

Oh.. Why didn't I think of that =_=

I ran into a problem. Let's say my block/entity gets destroyed. The sound will keep playing even when it is gone.

I ran into a problem. Let's say my block/entity gets destroyed. The sound will keep playing even when it is gone.

IC2 has that problem as well.

https://github.com/pahimar/Equivalent-Exchange-3/blob/master/ee3_client/ee3/client/SoundHandler.java

 

I looked at their code and did the exact same thing but the audio files don't seem to get recognized when I obfuscated it (it works no problem when I place it in the resource folder).

 

        static final String soundPrefix = "/icbm/sound/";
static final String[] soundFiles = {"airstrike", "missilelaunch", "emp", "explosion1", "machinehum", "missileinair", "targetlocked"};

@Override
public void onLoadSoundSettings(SoundManager soundManager)
{
	for(int i = 0; i < soundFiles.length; i++)
	{
		URL url = ICBMSound.class.getClassLoader().getResource(soundPrefix+soundFiles[i]+".ogg");

	    if(url != null)
	    {
			soundManager.getSoundsPool().addSound("icbm.sound."+soundFiles[i], this.getClass().getResource(soundPrefix+soundFiles[i]+".ogg"));
	    }
	    else
	    {
	    	System.out.println("Invalid sound file: " + soundFiles[i]);
	    }
	}
}

 

The directory of my sound files are at /icbm/sound/... inside of my zip. What am I doing wrong?

Edit: I did a print line in the function onPlaySound and I found out for some reason the entry is always null...

So I fiddled around with this a bit and took notes. Maybe it could become a tutorial eventually.

 

Notes about how Forge handles custom sounds:

 

1) The modder overrides getLivingSound() in Entity class to return a string (let’s call it soundString) that represents the sound.

 

2) EntityLiving.playLivingSound() reads getLivingSound() of the Entity and calls World.playSoundAtEntity() with the Entity and soundString as arguments

 

3) World.playSoundAtEntity() passes the soundString to the static method ForgeHooksClient.onPlaySoundAtEntity, and asks for a string back. The string it receives depends on your implementation of ISoundHandler. Most of the time, it will just be soundString (see 5a).

 

4) ForgeHooksClient.onPlaySoundAtEntity checks static variable ForgeHooksClient.soundHandlers2, which is a linked list that contains objects of classes that implement ISoundHandler. If there are no entries in soundHandlers2 the method will return soundString. If there are entries in soundHandlers2 it will go through them and call ISoundHandler.onPlaySoundAtEntity() on each. If any of those handlers return null (even handlers declared by other mods for whatever reason), this method will return null as well. If not, method will return the result of onPlaySoundAtEntity() for the last entry in the list.

 

5a) The unimplemented method, ISoundHandler.onPlaySoundAtEntity() generally should return the namestring it is given--in other words, soundString will usually just propagate up to World.playSoundAtEntity if Forge has loaded no SoundHandlers (because you aren't using custom sounds) or your SoundHandler doesn't do anything fancy.

 

5b) soundHandlers2 is only altered by the method MinecraftForgeClient.registerSoundHandler(), which must be called by the modder. this method will add the given sound handler to soundHandlers2 ONLY if the method onPlaySoundAtEntity() has been declared in the sound handler class.

 

6) registerSoundHandler() also adds any soundHandler it is given to the linked list soundHandlers. When SoundManager invokes loadSoundSettings(), it calls onLoadSoundSettings for all registered soundHandlers.

 

7) The unimplemented ISoundHandler.onLoadSoundSettings() is invoked on all registered soundhandlers when the method SoundManager.loadSoundSettings() is called. The modder should put the sound file import code (as per LexManos’s example) in this method, in a class that implements ISoundHandler or extends SoundHandlerAdaptor, and then register the new SoundHandler.

 

That about right?

Thats about right. But it doesn't really answer my question (although it makes everything more clear). The problem I am having is that I have to get my players to manually place the sound files in resources/mods/sounds/ directory in order for the sound to be actually found. I can't figure out a way to make the sound play when I store my xxx.ogg files in my mod distribution zip package. Industrialcraft seems to be able to do this with no problem but they are not using the Forge sound handler.

Yeah, that does seem odd, though I haven't tried it myself. 

 

I do know that Atomicstryker does the same thing with his mods. His workaround isn't actually not that bad although it probably keeps the mod from being loadable via "automatic installers" or whatever.

btw, is there a reason why you used "Method.class.getClassLoader().getResource()" instead of the way the example did it? I don't know enough Java to know what the difference would be, but I was able to load sounds just fine in my zip file using the example code.

btw, is there a reason why you used "Method.class.getClassLoader().getResource()" instead of the way the example did it? I don't know enough Java to know what the difference would be, but I was able to load sounds just fine in my zip file using the example code.

 

I used .getClassLoader().getResource() but it didn't seem to work. Does the name of the sound file (e.g "random.explosion") matter?

Yeah, it does. Actually, the name you give assign it in the sound pool matters too. Check out SoundPool.addSound(). It appears to creates its own reference from the name you give it. It creates this reference as follows:

 

1) cuts off everything after the first "." character.

2) cuts off any digits at the end (this is so all similar sounds will be saved under the same reference)

3) transmutes all "/" to "."

 

So if you give it the string mod/sound/hey.wav the reference it creates will be mod.sound.hey; it'll be that reference which you'll need to access later.

 

Not only that, but it will save the "original" name you gave it as a SoundEntry field, and which will be read in the method SoundManager.playSound(). I think this is so that it can correctly choose a codec for the sound file.

 

This is my code, which works with my files, even in the zip:

 

// Initializes our entries into the Sound Pool
	public void onLoadSoundSettings(SoundManager soundManager) {
		String [] soundFiles = {
				"horse/whinny3.wav",
				"horse/whinny4.wav",
				"horse/snort.wav",
				"horse/snort2.wav",
				"horse/death.wav",
				"horse/hurt.wav"};
		for (int i = 0; i < soundFiles.length; i++){
			soundManager.getSoundsPool().addSound(soundFiles[i], this.getClass().getResource("/MountsMod/sound/" + soundFiles[i]));
		}
	}

 

So to access a random whinny noise, I just reference "horse.whinny".

Yeah, it does. Actually, the name you give assign it in the sound pool matters too. Check out SoundPool.addSound(). It appears to creates its own reference from the name you give it. It creates this reference as follows:

 

1) cuts off everything after the first "." character.

2) cuts off any digits at the end (this is so all similar sounds will be saved under the same reference)

3) transmutes all "/" to "."

 

So if you give it the string mod/sound/hey.wav the reference it creates will be mod.sound.hey; it'll be that reference which you'll need to access later.

 

Not only that, but it will save the "original" name you gave it as a SoundEntry field, and which will be read in the method SoundManager.playSound(). I think this is so that it can correctly choose a codec for the sound file.

 

This is my code, which works with my files, even in the zip:

 

// Initializes our entries into the Sound Pool
	public void onLoadSoundSettings(SoundManager soundManager) {
		String [] soundFiles = {
				"horse/whinny3.wav",
				"horse/whinny4.wav",
				"horse/snort.wav",
				"horse/snort2.wav",
				"horse/death.wav",
				"horse/hurt.wav"};
		for (int i = 0; i < soundFiles.length; i++){
			soundManager.getSoundsPool().addSound(soundFiles[i], this.getClass().getResource("/MountsMod/sound/" + soundFiles[i]));
		}
	}

 

So to access a random whinny noise, I just reference "horse.whinny".

 

Thanks for the help! I understand about sound a lot more now thanks to your explainations! While I am developing my mod (and I don't have a mod zip file), do I just place all sound files in the jar like how I put all textures in the jar?

Yup, same idea.

Yup, same idea.

 

AHHH No wonder it didn't work. I forgot to type .ogg behind the file name. *FACEPALM* for few hours of trying to solve this. Thank you for your help!