From d74d1501ce607aaecf74e95ec79d7612e4351461 Mon Sep 17 00:00:00 2001 From: TheBrokenRail Date: Sat, 2 Mar 2024 17:16:16 -0500 Subject: [PATCH] Update Sound Warning --- docs/OVERRIDING_ASSETS.md | 6 ++++-- docs/SOUND.md | 9 +++++---- mods/src/sound/sound.cpp | 2 +- 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/OVERRIDING_ASSETS.md b/docs/OVERRIDING_ASSETS.md index c29f584f..1433e0c3 100644 --- a/docs/OVERRIDING_ASSETS.md +++ b/docs/OVERRIDING_ASSETS.md @@ -1,6 +1,8 @@ # Overriding Assets -To make overriding assets easier, MCPI-Reborn provides an overrides folder. Any file located in Minecraft: Pi Edition's `data` folder can be overridden by placing a file with the same name and path in the overrides folder. The overrides folder is located at `~/.minecraft-pi/overrides`. +To make overriding assets easier, MCPI-Reborn provides an overrides folder. Any file located in Minecraft: Pi Edition's `data` folder can be overridden by placing a file with the same name and path in the overrides folder. The overrides folder is located at `~/.minecraft-pi/overrides`[^1]. ## Examples - `data/images/terrain.png` -> `~/.minecraft-pi/overrides/images/terrain.png` -- `data/lang/en_US.lang` -> `~/.minecraft-pi/overrides/lang/en_US.lang` \ No newline at end of file +- `data/lang/en_US.lang` -> `~/.minecraft-pi/overrides/lang/en_US.lang` + +[^1]: On Flatpak, the path is `~/.var/app/com.thebrokenrail.MCPIReborn/.minecraft-pi/overrides`. diff --git a/docs/SOUND.md b/docs/SOUND.md index f438a1d8..fc0f43e8 100644 --- a/docs/SOUND.md +++ b/docs/SOUND.md @@ -1,7 +1,8 @@ # Sound -One of MCPI-Reborn's main modifications is a sound-engine since MCPI doesn't include one by default[^1]. However, it can't be used out-of-box because MCPI doesn't contain any sound data and MCPI-Reborn can't include it because of copyright. +One of MCPI-Reborn's main modifications is a sound-engine since MCPI does not include one by default[^1]. However, it can't be used out-of-box because MCPI does not contain any sound data and MCPI-Reborn can't include it because of copyright. -MCPE's sound data can be extracted from any MCPE v0.6.1[^2] APK file, just place its `libminecraftpe.so` into `~/.minecraft-pi/overrides` and you should have sound! +MCPE's sound data can be extracted from any MCPE v0.6.1[^2] APK file, just place its `libminecraftpe.so` into `~/.minecraft-pi/overrides`[^3] and you should have sound! -[^1]: The mute button is just leftover code from MCPE, it doesn't actually do anything in un-modded MCPI, however it is connected to MCPI-Reborn's sound-engine. -[^2]: This isn't a hard limit, an MCPE v0.8.1 APK would probably work, but don't rely on it. +[^1]: The mute button is just leftover code from MCPE, it does not actually do anything in un-modded MCPI, however it is connected to MCPI-Reborn's sound-engine. +[^2]: This is not a hard limit, an MCPE v0.8.1 APK would probably work, but don't rely on it. +[^3]: On Flatpak, the path is `~/.var/app/com.thebrokenrail.MCPIReborn/.minecraft-pi/overrides`. diff --git a/mods/src/sound/sound.cpp b/mods/src/sound/sound.cpp index d7e4722e..55abd9ab 100644 --- a/mods/src/sound/sound.cpp +++ b/mods/src/sound/sound.cpp @@ -36,7 +36,7 @@ std::string _sound_get_source_file() { // Check If Sound Exists if (access(path, F_OK) == -1) { // Fail - WARN("Audio Source File Doesn't Exist: " SOURCE_FILE_BASE); + WARN("Audio Source File Doesn't Exist: " SOURCE_FILE_BASE " (See: https://gitea.thebrokenrail.com/minecraft-pi-reborn/minecraft-pi-reborn/src/branch/master/docs/SOUND.md)"); source.assign(""); } else { // Set