https://github.com/aexoden/edge
Final Fantasy IV Speedrunning Bot Script for BizHawk
https://github.com/aexoden/edge
bizhawk bot
Last synced: 5 months ago
JSON representation
Final Fantasy IV Speedrunning Bot Script for BizHawk
- Host: GitHub
- URL: https://github.com/aexoden/edge
- Owner: aexoden
- License: mit
- Created: 2015-10-19T23:30:51.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-11-29T03:56:30.000Z (over 2 years ago)
- Last Synced: 2023-11-29T05:35:07.819Z (over 2 years ago)
- Topics: bizhawk, bot
- Language: Lua
- Homepage:
- Size: 1.75 MB
- Stars: 6
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Edge
Edge is a script for the BizHawk emulator to speed run Final Fantasy IV. It
currently can run the following routes:
* Any% No64 (Edge+Excalbur)
* Any% No64 (Rosa)
* Any% NoCW
* Paladin%
It may occasionally get stuck in Any% NoCW runs during the glitch portion.
## Prerequisites
* BizHawk (currently tested with v2.9.1)
* Final Fantasy IV US 1.0 (originally released as Final Fantasy II)
## Configuration
After extracting Edge to a directory, preferably within BizHawk's lua directory,
copy the config.lua.default file to config.lua and open it. There are a few
configuration variables:
### ROUTE
By default, this is set to nil, which will cause the script to choose a random
route for its runs. You can also set this to any valid route to do only runs of
that particular route. Currently supported routes are no64-excalbur, no64-rosa,
and paladin. The route name should be surrounded by double quotation marks.
### ENCOUNTER_SEED
By default, this is set to nil, which will cause the script to choose an
encounter seed randomly. If you instead specify this value, it will only do runs
on that particular encounter seed.
### SEED
By default, this is set to nil, which will cause the script to do random runs.
If you set this to an integer, it will instead do that specific run. Runs are
generally only repeatable with the same version of Edge.
### AUTOMATIC
This controls whether the bot executes a single run or continuously does
automatic runs. By default, it is set to false, which will result in a single
run. If SEED is nil, the bot will continuously do runs for random seeds. If SEED
is set to a particular seed, the bot will do runs incrementally starting from
the given seed. (For example, if SEED is set to 5, the bot will do runs with
seeds 5, 6, 7, etc.)
### LIVESPLIT
Enables or disables LiveSplit integration. By default this is disabled. Enabling
this requires a correctly configured LiveSplit.
### SAVESTATE
When enabled, save states will automatically be created at the start of every
battle for which a battle function exists. (This is generally boss battles and
the grind fight.) This option is disabled by default, as it's primarily useful
for debugging.
### EXTENDED_ENDING
This option only has meaning when AUTOMATIC is enabled. When enabled, the bot
will allow the ending to play out before rebooting to the next seed. This is
useful if streaming the runs. If the bot dies, it will wait five minutes before
rebooting.
### RESET_FOR_TIME
This option will tell the bot to automatically reset if it falls behind its PB
for the current route by too much. It is disabled by default.
### OVERLAY
This option displays an informational overlay to provide some basic information
about the run. It is disabled by default.
## LiveSplit Integration
On the LiveSplit end, you must add the LiveSplit server to your layout, ensure
that it is configured to use port 16834, and then start the server with LiveSplit's
right click menu.
## Usage
1. Configure BizHawk to use BSNES as its SNES core. (Config->Preferred Cores->SNES)
2. Ensure the SRAM file is cleared. (The easiest way to do this is to load the
Final Fantasy II ROM image, right click on the display, and choose "Close and
Clear SRAM".)
3. Open the Final Fantasy II ROM image.
4. Ensure the emulator is not paused.
5. Open the BizHawk Lua Console, and load main.lua.
6. From BizHawk's "Emulation" menu, choose "Reboot Core". The script should
begin a run from the beginning.