Creare Suoni Personalizzati 1.20.4

Impara a usare e aggiungere un nuovo suono con la registry.

WARNING

Questa pagina si applica alla versione 1.20.4. La documentazione delle versioni meno recenti potrebbe essere incompleta.

Preparare il File Audio

I tuoi file audio devono essere formattati in un modo specifico. OGG Vorbis è un formato container aperto per dati multimediali, tra cui audio, e viene usato per i file audio di Minecraft. Per evitare problemi nel modo in cui Minecraft gestisce le distanze, il tuo audio deve essere solo su un singolo canale (Mono).

Molti software DAW (Digital Audio Workstation) odierni riescono a importare ed esportare usando questo formato. Nell'esempio seguente il software open-source gratuito "Audacity" sarà usato per portare i file audio al formato corretto, tuttavia qualunque altro DAW sarà più che sufficiente.

In questo esempio, il suono di un fischio viene importato in Audacity. Attualmente questo è salvato come file .wav e ha due canali audio (Stereo). Modifica il suono come preferisci e assicurati di cancellare uno dei canali usando il menu a tendina in cima alla "testina".

Quando devi esportare o renderizzare un file audio, assicurati di scegliere il formato del file OGG. Alcuni DAW, come REAPER, potrebbero supportare formati audio OGG a più strati. In questo caso OGG Vorbis dovrebbe funzionare senza problemi.

Inoltre tieni a mente che un file audio può aumentare drasticamente le dimensioni del file della tua mod. Se necessario, comprimi l'audio quando stai modificando ed esportando il file, per mantenere le sue dimensioni al minimo.

Caricare il File Audio

Aggiungi un nuovo percorso resources/assets/example-mod/sounds per i suoni della tua mod, e trasferisci qui il file audio esportato metal_whistle.ogg.

Se non esiste ancora, crea il file resources/assets/example-mod/sounds.json e aggiungici i tuoi suoni.

{
  "metal_whistle": {
    "subtitle": "sound.example-mod.metal_whistle",
    "sounds": ["example-mod:metal_whistle"]
  },
  "engine": {
    "subtitle": "sound.example-mod.engine",
    "sounds": ["example-mod:engine"]
  }
}

La voce subtitle fornisce un contesto più approfondito per il giocatore. Il nome del sottotitolo è usato nei file di lingua nel percorso resources/assets/example-mod/lang e verrà visualizzato se l'impostazione dei sottotitoli nel gioco è attiva e se questo suono personalizzato viene riprodotto.

Registrare il Suono Personalizzato

Per aggiungere il suono personalizzato alla mod, registra un SoundEvent nella classe che implementa l'entrypoint ModInitializer.

Registry.register(BuiltInRegistriesSOUND_EVENT, new ResourceLocation(MOD_ID, "metal_whistle"),
        SoundEvent.of(new ResourceLocation(MOD_ID, "metal_whistle")));

Ripulire il Disordine

A seconda di quante voci ci sono nella Registry, le cose potrebbero presto sfuggire di mano. Per evitare che ciò accada, possiamo fare uso di una nuova classe di supporto.

Aggiungi due nuovi metodi alla classe di supporto appena creata. Uno che registra tutti i suoni, e uno che viene usato per inizializzare questa classe in primo luogo. Dopo di che, puoi comodamente aggiungere nuovi attributi SoundEvent statici personalizzati a seconda delle necessità.

public class CustomSounds {
	private CustomSounds() {
		// private empty constructor to avoid accidental instantiation
	}

	// ITEM_METAL_WHISTLE is the name of the custom sound event
	// and is called in the mod to use the custom sound
	public static final SoundEvent ITEM_METAL_WHISTLE = registerSound("metal_whistle");
	public static final SoundEvent ENGINE_LOOP = registerSound("engine");

	// actual registration of all the custom SoundEvents
	private static SoundEvent registerSound(String id) {
		Identifier identifier = Identifier.fromNamespaceAndPath(ExampleMod.MOD_ID, id);
		return Registry.register(BuiltInRegistries.SOUND_EVENT, identifier, SoundEvent.createVariableRangeEvent(identifier));
	}

	// This static method starts class initialization, which then initializes
	// the static class variables (e.g. ITEM_METAL_WHISTLE).
	public static void initialize() {
		ExampleMod.LOGGER.info("Registering " + ExampleMod.MOD_ID + " Sounds");
		// Technically this method can stay empty, but some developers like to notify
		// the console, that certain parts of the mod have been successfully initialized
	}
}

Facendo così, la classe entrypoint che implementa ModInitializer deve solo implementare una riga per registrare tutti i SoundEvent personalizzati.

public class ExampleModSounds implements ModInitializer {
	@Override
	public void onInitialize() {
		// This is the basic registering. Use a new class for registering sounds
		// instead, to keep the ModInitializer implementing class clean!
		Registry.register(BuiltInRegistries.SOUND_EVENT, Identifier.fromNamespaceAndPath(ExampleMod.MOD_ID, "metal_whistle_simple"),
				SoundEvent.createVariableRangeEvent(Identifier.fromNamespaceAndPath(ExampleMod.MOD_ID, "metal_whistle_simple")));

		// ... the cleaner approach.
		CustomSounds.initialize(); 
	}

	public static Identifier identifierOf(String path) {
		return Identifier.fromNamespaceAndPath(ExampleMod.MOD_ID, path);
	}
}

Usare il SoundEvent Personalizzato

Usa la classe di supporto per accedere al SoundEvent personalizzato. Consulta la pagina Riprodurre i SoundEvents per imparare come riprodurre i suoni.