Included sfx example zip and instructions to use it. (#71)

This commit is contained in:
Just Allie 2022-08-08 11:54:39 -04:00 committed by GitHub
parent ea3fa3f1a5
commit 73f8a16efa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 2 additions and 35 deletions

View File

@ -1,33 +0,0 @@
#---------------------------------------------------------------------------------
.SUFFIXES:
#---------------------------------------------------------------------------------
ifeq ($(strip $(DEVKITARM)),)
$(error "Please set DEVKITARM in your environment. export DEVKITARM=<path to>devkitARM")
endif
include $(DEVKITARM)/ds_rules
# define SFX_WRONG 0
# define SFX_LAUNCH 1
# define SFX_STOP 2
# define SFX_SWITCH 3
# define SFX_STARTUP 4
# define SFX_SELECT 5
# define SFX_BACK 6
NAMES := startup.wav wrong.wav launch.wav stop.wav switch.wav select.wav back.wav
TARGETS := sfx.bin
.PHONY: clean all
all: $(TARGETS)
sfx.bin : $(NAMES)
@mmutil $^ -d -v -osfx.bin
clean:
@echo Clean ...
@rm sfx.bin

Binary file not shown.

View File

@ -26,9 +26,9 @@ The sound effect bank (sfx.bin) contains sound effects such as the icon select s
All the files listed above are required to build a custom sound effect bank. If you want a sound to be mute, you can use a silent audio file. The `.wav` format is mandatory and the encoding *must* be PCM.
To build the sound effect bank you need to download [this file](/assets/files/Makefile) and put it next to all the `.wav` files that will be used. After all the files are on the same folder, open your terminal (or command line if you are using Windows), change the current directory (`cd`) to the folder where `Makefile` is, and then run the `make` command.
[This file](/assets/files/sfx-example.zip) includes the sounds used in the default DSi and 3DS themes, along with the makefile used to build them into a valid sfx.bin file. Feel free to edit and change the sound files to make a custom sound effect bank.
You will get a resulting `sfx.bin` file that can be copied to the `sound` subfolder in your theme folder. **This file must be under 512000B = 512 kB**. Any file larger than that will result in either crashes or some sounds not playing fully.
To build your custom sound effect bank, open your terminal (or command line if you are using Windows), change the current directory (`cd`) to the folder where `Makefile` is, and then run the `make` command. You will get a resulting `sfx.bin` file that can be copied to the `sound` subfolder in your theme folder. **This file must be under 512000B = 512 kB**. Any file larger than that will result in either crashes or some sounds not playing fully.
### Startup sound
While the other sound effects will work with any WAV file with PCM encoding, the startup sound must be in a specific format in order to work properly, otherwise there will be a gap between when the startup sound stops and the background music begins.