Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/ClusterM/retroarch-clover.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexey 'Cluster' Avdyukhin <clusterrr@clusterrr.com>2017-03-19 18:01:25 +0300
committerAlexey 'Cluster' Avdyukhin <clusterrr@clusterrr.com>2017-03-19 18:01:25 +0300
commit400b85a73ace0e2b45b30cdb5060a51b86866651 (patch)
tree626575c683a0b7947266c685a810f8b1cac25038
parent7b62e0aa02551995bd0132a175e3372d10e93927 (diff)
Usage and instructions should be more simple!
-rw-r--r--README.md37
-rwxr-xr-xmake_release.sh13
2 files changed, 32 insertions, 18 deletions
diff --git a/README.md b/README.md
index 2c2f892..f103a51 100644
--- a/README.md
+++ b/README.md
@@ -20,26 +20,32 @@ The following cores are available as additional modules (in core_modules folder)
## 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 "cores" directory) 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
+If you are using hakchi2:
+0. Make sure that you are using hakchi2 version 2.14 or newer.
+1. Go to "releases" tab and download the newest retroarch_with_cores.zip.
+2. Drag-and-drop it on hakchi2 window.
+3. Press "OK" button and follow instructions.
+
+That's all. You can play near all NES games now as well as SNES, Genesis, N64, etc.
+
+### Important notes
+
+- To use RetroArch for any NES game, just add "--retroarch" to command line arguments. Use it if some of your NES games glitches with original NES Mini's emulator.
+- To open RetroArch settings menu press Select + Start in game.
+- To add RetroArch shortcut to NES Mini's shell, download and drag-and-drop CloverApp.zip to hakchi2.
+
+### Additional notes for expert users
+
+- If you need to specify NES core, use "--retroarch --core fceumm" to use FCEUmm for this game or "--retroarch --core nestopia" to use Nestopia. Code fceumm will be used by default.
- 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).
- To load arcade games that come in the form of ZIP archives, you'll need to change /bin/zip in game's command line arguments to /bin/fba or /bin/cps2 depending on the core needed for the game to run (look at "Additional Information" section for all avaiable /bin/<> commands). For some cores like Final Burn Alpha, BIOS image (e.g. neogeo.zip for Neo-Geo) must be in the game directory.
- Since version 0.5, you'll need to upload neogeo.zip only once. Just put neogeo.zip to any Neo-Geo game you want, synchronize and launch it once for every other game to work automatically or just upload neogeo.zip to RA's system folder using BIOS template. You won't have to include neogeo.zip anymore unless you uninstall hakchi and decide to install it again.
-- 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
-- To use PicoDrive for all Genesis/Mega Drive games instead of Genesis Plus GX, install use_picodrive.hmod module. Make sure that picodrive module is installed before installing use_picodrive!
+- 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 Nestopia instead of FCEUmm for all games by default, install use_nestopia.hmod module from additional_mods.zip.
+- To use PicoDrive for all Genesis/Mega Drive games instead of Genesis Plus GX, install use_picodrive.hmod module from additional_mods.zip. Make sure that picodrive module is installed before installing use_picodrive!
- You can re-enable bilinear filtering in RetroArch's settings (Settings —> Video —> Bilinear Filtering)
-- If you want to use RetroArch's XMB UI instead of RGUI, install xmb_assets.hmod and change Menu Driver in Settings —> Driver —> Menu Driver to "xmb"
-
-## Additional information
+- If you want to use RetroArch's XMB UI instead of RGUI, install xmb_assets.hmod from additional_mods.zip and change Menu Driver in Settings —> Driver —> Menu Driver to "xmb"
Executables and arguments for all available cores:
@@ -84,7 +90,6 @@ Executables and arguments for all available cores:
- Nintendo 64 and CP System II 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 the game
## Credits
diff --git a/make_release.sh b/make_release.sh
index 495a875..e1b217e 100755
--- a/make_release.sh
+++ b/make_release.sh
@@ -1,13 +1,13 @@
#!/bin/sh
rm -rf ./release
mkdir -p release/cores
-printf "\nPacking core template, BIOS template and CloverApp\n\n"
+echo "\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 ..
-printf "\nCores:\n"
+printf "\nModules:\n"
cd core_modules
for dir in *.hmod; do
cd "$dir"
@@ -15,3 +15,12 @@ for dir in *.hmod; do
tar -czf "../../release/cores/$dir" *
cd ../
done
+cd ..
+mkdir -p release/additional_mods
+mv release/cores/use_* release/additional_mods
+mv release/cores/xmb_* release/additional_mods
+echo "\nPacking retroarch and main cores"
+cd release
+zip -rqv retroarch_with_cores.zip retroarch.hmod cores
+echo "\nPacking additional modules"
+zip -rqv additional_mods.zip additional_mods/*