From d6d142a39d78aafdc62711c45a9380e214158b60 Mon Sep 17 00:00:00 2001 From: juvester Date: Sat, 10 Sep 2016 12:16:34 +0300 Subject: [PATCH] Update README.md --- README.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 150f14e..3bee3a5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,35 @@ # MarI/O FCEUX FCEUX port of [SethBling's MarI/O.][1] -Tested on FCEUX 2.2.2 (Ubuntu 16.04). +![Demonstration](demo.gif) + +##Why FCEUX? +It runs on Linux. + +##Instructions +1. Save neatevolve.lua somewhere on your computer. +2. Open Super Mario Bros. in FCEUX. +3. Go to some level and make a savestate at the beginning of the level. Use savestate slot 1 or edit the settings in the script. +4. Load the script in FCEUX (File -> Load Lua Script) +5. Enjoy! + +If you start FCEUX from the terminal you'll get some usefull debug info. + +Tested on FCEUX 2.2.2 (Ubuntu 16.04). + +###Loading a previous generation +Backups of every generation will be saved in a folder called 'backups'. If you wish to load or continue from a backup, edit the settings in the script, e.g. +``` +LOAD_FROM_FILE = "backups/backup.5.SMB1-1.state.pool" +``` +Value 'nil' will start a new pool. +``` +LOAD_FROM_FILE = nil +``` +###HUD elements +You can toggle the HUD elements ON/OFF by clicking on them. Turning HUD elements (and sound) off will greatly improve performance on fast emulation speeds. There's no external gui like in BizHawk since FCEUX's lua support is more limited. + +##Changes from SethBling's original script +Mostly just some gui/HUD stuff that wasn't supported in FCEUX. Otherwise it's quite vanilla. Super Mario World references were removed since FCEUX is NES only. If you know a SNES emulator that runs on linux and supports lua scripting let me know, I'd love to get this working for SMW! [1]: https://www.youtube.com/watch?v=qv6UVOQ0F44