Merge pull request #10 from pcm720/No-extra-cores0.3

Update

13 files changed, 80 insertions, 34 deletions

diff --git a/README.md b/README.md
index b961bda..084b311 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-### RetroArch module for hakchi ###
+# RetroArch module for hakchi
 
 This is a hakchi/hakchi2 module which adds libretro cores and RetroArch front-end to your NES Mini.
 
@@ -18,12 +18,35 @@ And the following cores are available as additional modules (in core_modules fol
 - mednafen_pce_fast (PC Engine/Turbografx 16)
 - fb_alpha and fb_alpha_cps2 (various arcade machines)
 
+## How to use this
+
+1. Go to "releases" tab and download the newest release.zip 
+2. Unpack release.zip anywhere you want
+3. Copy retroarch.hmod and the cores you want (.hmod files from core_modules and core_modules_extra folders) to user_mods directory of Hakchi2.
+4. Install the modules (all modules can be installed in one go) via Hakchi2's Modules menu.
+5. Add the games as usual
+
+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.
+- 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
+- To use Nestopia instead of FCEUmm, install use_nestopia.hmod module
+
+## Additional information
+
 Executables and arguments for all available cores:
 
         - /bin/retroarch-clover <core> <rom> <clover_args>
           runs RetroArch with specified core,
           designed for executing from clover shell, 
           so it parses all clover arguments (saves, aspect ratio, etc.)
+        - /bin/retroarch-mini [core] [rom] [args]
+          runs RetroArch directly, without clover intergration
+        - /bin/retroarch
+          RetroArch binary
+        - /bin/nes <rom> <clover_args>
+          runs "fceumm" core or "nestopia" core
         - /bin/gb <rom> <clover_args>
           runs "gambatte" core
         - /bin/gbc <rom> <clover_args>
@@ -36,8 +59,6 @@ Executables and arguments for all available cores:
           runs "genesis_plus_gx" core
         - /bin/gg <rom> <clover_args>
           runs "genesis_plus_gx" core
-        - /bin/nes <rom> <clover_args>
-          runs "fceumm" core or "nestopia" core
         - /bin/snes <rom> <clover_args>
           runs "snes9x2010" core
         - /bin/n64 <rom> <clover_args>
@@ -50,32 +71,14 @@ Executables and arguments for all available cores:
           runs "fb_alpha" core
         - /bin/cps2 <rom> <clover_args>
           runs "fb_alpha_cps2" core
-        - /bin/retroarch-mini [core] [rom] [args]
-          runs RetroArch directly, without clover intergration
-        - /bin/retroarch
-          RetroArch binary
 
-Sometimes default emulator of NES Mini is not working with some games when it should. So you can just add "--retroarch" command line argument to use RetroArch.
+## Known issues
 
-Known issues:
-- Nintendo 64 save-states are not working, battery backup working fine
+- Nintendo 64 save-states are not working, battery backups work fine
 - Default CRT filter is not working, scanlines shader added instead but it's not working with all systems.
-- It's recommended to turn your NES Mini off from shell, not during game
-
-The following changes were made in this fork: 
-- Added Stella core for Atari 2600 emulation
-- System dir is now '~/system'
-- Core info dir is now '~/info'
-- RGUI default browser dir is now '/usr/share/games/nes/kachikachi' instead of '/'
-- Disabled bilinear filtering for every preset
-- Enabled integer scaling
-- Greyscale palette for Gambatte core
-- Use mGBA as GBA core
-- Added mednafen_pce_fast as PCE/TG16 core
-- Enter RetroArch in-game menu by pressing Select + Start
-- Added template for adding new cores via hakchi module system
-- Cores are now represented as additional modules
-- Added Final Burn Alpha and Final Burn Alpha CPS2 cores
+- It's recommended to turn your NES Mini off from shell, not during the game
+
+## Credits
 
 NES Mini port by madmonkey
 
diff --git a/core_modules/fb_alpha.hmod/etc/libretro/info/fbalpha_libretro.info b/core_modules/fb_alpha.hmod/etc/libretro/info/fb_alpha_libretro.info
index 8e98b4c..8e98b4c 100755
--- a/core_modules/fb_alpha.hmod/etc/libretro/info/fbalpha_libretro.info
+++ b/core_modules/fb_alpha.hmod/etc/libretro/info/fb_alpha_libretro.info
diff --git a/core_modules/fb_alpha.hmod/readme.txt b/core_modules/fb_alpha.hmod/readme.txt
index 41d20ac..4ee00cb 100644
--- a/core_modules/fb_alpha.hmod/readme.txt
+++ b/core_modules/fb_alpha.hmod/readme.txt
@@ -1,6 +1,7 @@
 === Final Burn Alpha core for RetroArch ===

 

-This module will add support for Atari 2600 games to RetroArch

+This module will add support for various arcade games to RetroArch

+The BIOS files must be inside the game directory.

 

 Available executables and arguments:

 - /bin/fba <rom> <clover_args>

diff --git a/core_modules/fb_alpha_cps2.hmod/etc/libretro/info/fbalpha2012_cps2_libretro.info b/core_modules/fb_alpha_cps2.hmod/etc/libretro/info/fb_alpha_cps2_libretro.info
index 8ff6b6d..8ff6b6d 100755
--- a/core_modules/fb_alpha_cps2.hmod/etc/libretro/info/fbalpha2012_cps2_libretro.info
+++ b/core_modules/fb_alpha_cps2.hmod/etc/libretro/info/fb_alpha_cps2_libretro.info
diff --git a/core_modules/fb_alpha_cps2.hmod/readme.txt b/core_modules/fb_alpha_cps2.hmod/readme.txt
index d63ce5d..8b81067 100644
--- a/core_modules/fb_alpha_cps2.hmod/readme.txt
+++ b/core_modules/fb_alpha_cps2.hmod/readme.txt
@@ -1,6 +1,7 @@
 === Final Burn Alpha CPS2 core for RetroArch ===

 

-This module will add support for Atari 2600 games to RetroArch

+This module will add support for CP System II arcade games to RetroArch

+The BIOS files must be inside the game directory

 

 Available executables and arguments:

 - /bin/cps2 <rom> <clover_args>

diff --git a/core_modules/snes9x2010.hmod/etc/libretro/info/snes9x_libretro.info b/core_modules/snes9x2010.hmod/etc/libretro/info/snes9x2010_libretro.info
index d7b3eb9..ecf195b 100644
--- a/core_modules/snes9x2010.hmod/etc/libretro/info/snes9x_libretro.info
+++ b/core_modules/snes9x2010.hmod/etc/libretro/info/snes9x2010_libretro.info
@@ -1,4 +1,4 @@
-display_name = "SNES / Super Famicom (Snes9x)"
+display_name = "SNES / Super Famicom (Snes9x2010)"
 authors = "Snes9x Team"
 supported_extensions = "smc|sfc|swc|fig"
 corename = "Snes9x"
diff --git a/core_modules/use_nestopia.hmod/bin/nes b/core_modules/use_nestopia.hmod/bin/nes
new file mode 100755
index 0000000..2289bf9
--- /dev/null
+++ b/core_modules/use_nestopia.hmod/bin/nes
@@ -0,0 +1,6 @@
+#!/bin/sh
+if [ ! -f /etc/libretro/system/disksys.rom ]; then
+  cp -f /usr/share/kachikachi/fds_bios.bin /etc/libretro/system/disksys.rom
+fi
+
+exec retroarch-clover nestopia "$@" --ra-allow-crt
diff --git a/core_modules/use_nestopia.hmod/install b/core_modules/use_nestopia.hmod/install
new file mode 100644
index 0000000..6e0a007
--- /dev/null
+++ b/core_modules/use_nestopia.hmod/install
@@ -0,0 +1,4 @@
+transfer_default
+chmod +x $rootfs/bin/*
+chmod +x $rootfs/usr/bin/*
+return 1
diff --git a/core_modules/use_nestopia.hmod/readme.txt b/core_modules/use_nestopia.hmod/readme.txt
new file mode 100644
index 0000000..4cf6952
--- /dev/null
+++ b/core_modules/use_nestopia.hmod/readme.txt
@@ -0,0 +1,13 @@
+=== Use Nestopia instead of FCEUmm ===

+

+This module will patch /bin/nes file to use Nestopia as the only NES emulator (except kachikachi)

+

+Available executables and arguments:

+- /bin/nes <rom> <clover_args>

+  runs "nestopia" core

+

+Core by libretro

+Module by pcm

+Hakchi module system by madmonkey

+NES Mini shell integration by Cluster

+(c) 2016-2017

diff --git a/make_release.sh b/make_release.sh
new file mode 100755
index 0000000..564152b
--- /dev/null
+++ b/make_release.sh
@@ -0,0 +1,16 @@
+#!/bin/sh
+rm -rf ./release
+mkdir -p release/cores
+printf "\nPacking core template and CloverApp\n\n"
+zip -rq release/libretro_core_template.zip libretro_core_template.hmod/*
+zip -rq release/CloverApp.zip CloverApp
+echo "Packing retroarch.hmod"
+cd retroarch.hmod && tar -czf ../release/retroarch.hmod * && cd ..
+printf "\nCores:\n"
+cd core_modules
+for dir in *.hmod; do
+	cd "$dir"
+	echo "$dir"
+    tar -czf "../../release/cores/$dir" *
+    cd ../
+done
diff --git a/makehmod.bat b/makehmod.bat
index 8453cfd..c8ced74 100644
--- a/makehmod.bat
+++ b/makehmod.bat
@@ -1,6 +1,6 @@
 @echo off

-set moddir=retroarch_mod.hmod

-set modname=retroarch_mod.hmod

+set moddir=retroarch.hmod

+set modname=retroarch.hmod

 set outdir=output

 for %%x in (%*) do set outdir=%1

 

diff --git a/makemod.sh b/makemod.sh
index 87ab5f5..22724ba 100755
--- a/makemod.sh
+++ b/makemod.sh
@@ -1,6 +1,6 @@
 #!/bin/sh
-moddir=retroarch_mod.hmod
-modname=retroarch_mod.hmod
+moddir=retroarch.hmod
+modname=retroarch.hmod
 outdir=output
 [ -z "$1" ] || outdir=$1
 cd "$moddir"
diff --git a/retroarch.hmod/bin/nes b/retroarch.hmod/bin/nes
index ca0f380..bf5dfde 100755
--- a/retroarch.hmod/bin/nes
+++ b/retroarch.hmod/bin/nes
@@ -4,7 +4,9 @@ filename="$1"
 extension="${filename##*.}"
 if [ "$extension" == "fds" ]; then
   core=nestopia
-  cp -f /usr/share/kachikachi/fds_bios.bin /tmp/disksys.rom
+  if [ ! -f /etc/libretro/system/disksys.rom ]; then
+    cp -f /usr/share/kachikachi/fds_bios.bin /etc/libretro/system/disksys.rom
+  fi
 fi
 
 exec retroarch-clover "$core" "$@" --ra-allow-crt