Added BIOS module template

4 files changed, 19 insertions, 1 deletions

diff --git a/README.md b/README.md
index 9ef0dcf..76d2afa 100644
--- a/README.md
+++ b/README.md
@@ -29,6 +29,7 @@ The following cores are available as additional modules (in core_modules folder)
 Please note:
 - To add RetroArch shortcut to NES Mini's shell, drag-and-drop CloverApp.zip to Hakchi2
 - To make your own RetroArch modules, use the structure from libretro_core_template.zip. Use exisiting modules as a reference.
+- To add your own BIOS images for custom cores, use bios_template.zip (please read the readme.txt inside).
 - If the file extension of your game is not supported by Hakchi2, you may need to change the path in command line arguments (in Hakchi2's game options) to make it point to the corresponding core
 - To use RetroArch for any NES game, just add "--retroarch" to command line arguments. If you need to specify NES core, use "--retroarch --core fceumm" to use FCEUmm for this game or "--retroarch --core nestopia" to use Nestopia
 - To use Nestopia instead of FCEUmm, install use_nestopia.hmod module
diff --git a/bios_template.hmod/install b/bios_template.hmod/install
new file mode 100755
index 0000000..95bc536
--- /dev/null
+++ b/bios_template.hmod/install
@@ -0,0 +1,2 @@
+transfer_default
+return 1
diff --git a/bios_template.hmod/readme.txt b/bios_template.hmod/readme.txt
new file mode 100755
index 0000000..6977945
--- /dev/null
+++ b/bios_template.hmod/readme.txt
@@ -0,0 +1,14 @@
+Use this template to add BIOS images for custom cores:

+1. Copy BIOS files to <hmod folder>/etc/libretro/system folder

+2. Copy .hmod folder to user_mods and install

+

+You can have multiple BIOS images for any core you want in the same module.

+For the proper names of BIOS images, consult libretro Wiki.

+Be aware that NES Mini's filesystem is case-sensitive which means that "bios.bin" and "BIOS.bin" are different files!

+

+For example, let's add BIOS images required for proper emulation of Mega/Sega CD:

+The required files are bios_CD_U.bin, bios_CD_E.bin and bios_CD_J.bin.

+1. Copy bios_CD_U.bin, bios_CD_E.bin and bios_CD_J.bin to <hmod folder>/etc/libretro/system

+2. Rename the folder to bios_images.hmod (for the sake of convenience)

+3. Copy the folder to user_mods

+4. Install the module via Hakchi 2 as usual

diff --git a/make_release.sh b/make_release.sh
index 564152b..495a875 100755
--- a/make_release.sh
+++ b/make_release.sh
@@ -1,8 +1,9 @@
 #!/bin/sh
 rm -rf ./release
 mkdir -p release/cores
-printf "\nPacking core template and CloverApp\n\n"
+printf "\nPacking core template, BIOS template and CloverApp\n\n"
 zip -rq release/libretro_core_template.zip libretro_core_template.hmod/*
+zip -rq release/bios_template.zip bios_template.hmod/*
 zip -rq release/CloverApp.zip CloverApp
 echo "Packing retroarch.hmod"
 cd retroarch.hmod && tar -czf ../release/retroarch.hmod * && cd ..