Создание своих звуков 1.21.8

Вы научите добавлять и использовать новые звуки с реестром.

WARNING

Эта страница написана для версии 1.21.8.
Документация для старых версий может быть неполной.

Создание своих звуков

Нужно отформатировать ваш аудиофайл определённым образом. OGG Vorbis - это открытый формат для мультимедийных данных, например аудио, и используется в качестве звуковых файлов Minecraft. Чтобы избежать проблем с тем, как Minecraft обрабатывает дистанцию, вашему аудио нужно иметь только один канал (Mono).

Многие современные программы ЦЗРС (Цифровая звуковая рабочая станция) могут импортировать и экспортировать файлы этого формата. В следующем примере для приведения файла в правильный формат будет использован "Audacity", или любая другая ЦЗРС программа.

В этом примере звук свисток был импортирован в Audacity. Обычно он сохраняется как файл .wav и имеет два аудио канала (Stereo). Отредактируйте звук по своему вкусу и удалите один из каналов, используя раскрывающийся элемент наверху "track head".

Когда вы экспортируете или рендерите аудиофайл, выберите формат файла OGG. Некоторые ЦЗРС, например REAPER, могут поддерживать несколько форматов слоёв OGG. В этом случае OGG Vorbis должен работать нормально.

Также имейте в виду, что аудиофайлы могут значительно увеличить размер вашего мода. При необходимости сожмите звук, когда редактируйте и экспортируйте файл, чтобы свести размер файла к минимуму.

Загрузка аудиофайла

Добавьте новую директорию resources/assets/mod-id/sounds для звуков в вашем моду, и положите в неё экспортированный аудиофайл metal_whistle.ogg.

Дальше создайте файл resources/assets/mod-id/sounds.json, если он не существует и добавьте ваш звук в звуковые записи.

{
  "metal_whistle": {
    "subtitle": "sound.fabric-docs-reference.metal_whistle",
    "sounds": [
      "fabric-docs-reference:metal_whistle"
    ]
  },
  "engine": {
    "subtitle": "sound.fabric-docs-reference.engine",
    "sounds": [
      "fabric-docs-reference:engine"
    ]
  }
}

Запись подписи предоставляет больше контекста для игрока. Название подписи используется в языковых файлах в директории resources/assets/mod-id/lang и будет показываться, если включена настройка и звук воспроизводиться.

Регистрация своего звука

Чтобы добавить собственный звук в мод, зарегистрируйте SoundEvent в вашем инициализаторе мода.

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

Чистка беспорядка

В зависимости насколько много записей реестра находится, это может превратиться в беспорядок. Чтобы обойти это, мы должны сделать использование нового класса помощника.

Добавьте два новых метода для ранее созданного класса помощника. Первый регистрирует все звуки и используется для инициализации этого класса на первом месте. После этого вы можете добавить в новый статический класс SoundEvent нужные переменные.

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) {
		ResourceLocation identifier = ResourceLocation.fromNamespaceAndPath(FabricDocsReferenceSounds.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() {
		FabricDocsReferenceSounds.LOGGER.info("Registering " + FabricDocsReferenceSounds.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
	}
}

Таким образом, инициализатору мода достаточно реализовать только одну строку для регистрации всех пользовательских SoundEvents.

public class FabricDocsReferenceSounds implements ModInitializer {
	public static final String MOD_ID = FabricDocsReference.MOD_ID;
	public static final Logger LOGGER = FabricDocsReference.LOGGER;

	@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, ResourceLocation.fromNamespaceAndPath(MOD_ID, "metal_whistle_simple"),
				SoundEvent.createVariableRangeEvent(ResourceLocation.fromNamespaceAndPath(MOD_ID, "metal_whistle_simple")));

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

	public static ResourceLocation identifierOf(String path) {
		return ResourceLocation.fromNamespaceAndPath(FabricDocsReference.MOD_ID, path);
	}
}

Используйте собственные SoundEvent'ы

Используйте класс помощник для доступа к собственному SoundEvent. Посетите страницу Playing SoundEvents, чтобы узнать, как воспроизводить звуки.