diff --git a/FF1Client.py b/FF1Client.py
index 6256744222c3..b7c58e206123 100644
--- a/FF1Client.py
+++ b/FF1Client.py
@@ -33,7 +33,7 @@ def _cmd_nes(self):
logger.info(f"NES Status: {self.ctx.nes_status}")
def _cmd_toggle_msgs(self):
- """Toggle displaying messages in bizhawk"""
+ """Toggle displaying messages in EmuHawk"""
global DISPLAY_MSGS
DISPLAY_MSGS = not DISPLAY_MSGS
logger.info(f"Messages are now {'enabled' if DISPLAY_MSGS else 'disabled'}")
diff --git a/OoTClient.py b/OoTClient.py
index f940ce121410..fd93c09338ac 100644
--- a/OoTClient.py
+++ b/OoTClient.py
@@ -100,7 +100,7 @@ async def server_auth(self, password_requested: bool = False):
await super(OoTContext, self).server_auth(password_requested)
if not self.auth:
self.awaiting_rom = True
- logger.info('Awaiting connection to Bizhawk to get player information')
+ logger.info('Awaiting connection to EmuHawk to get player information')
return
await self.send_connect()
diff --git a/PokemonClient.py b/PokemonClient.py
index e78e76fa00cc..e7306d2b8e1f 100644
--- a/PokemonClient.py
+++ b/PokemonClient.py
@@ -78,7 +78,7 @@ async def server_auth(self, password_requested: bool = False):
await super(GBContext, self).server_auth(password_requested)
if not self.auth:
self.awaiting_rom = True
- logger.info('Awaiting connection to Bizhawk to get Player information')
+ logger.info('Awaiting connection to EmuHawk to get Player information')
return
await self.send_connect()
diff --git a/Zelda1Client.py b/Zelda1Client.py
index b30bad51384f..db3d3519aa60 100644
--- a/Zelda1Client.py
+++ b/Zelda1Client.py
@@ -46,7 +46,7 @@ def _cmd_nes(self):
logger.info(f"NES Status: {self.ctx.nes_status}")
def _cmd_toggle_msgs(self):
- """Toggle displaying messages in bizhawk"""
+ """Toggle displaying messages in EmuHawk"""
global DISPLAY_MSGS
DISPLAY_MSGS = not DISPLAY_MSGS
logger.info(f"Messages are now {'enabled' if DISPLAY_MSGS else 'disabled'}")
diff --git a/data/lua/common.lua b/data/lua/common.lua
index 81b450504c7b..c074c63af69d 100644
--- a/data/lua/common.lua
+++ b/data/lua/common.lua
@@ -27,8 +27,8 @@ end
local is23Or24Or25 = (bizhawk_version=="2.3.1") or (bizhawk_major == 2 and bizhawk_minor >= 3 and bizhawk_minor <= 5)
local isGreaterOrEqualTo26 = bizhawk_major > 2 or (bizhawk_major == 2 and bizhawk_minor >= 6)
-local isUntestedBizhawk = bizhawk_major > 2 or (bizhawk_major == 2 and bizhawk_minor > 9)
-local untestedBizhawkMessage = "Warning: this version of bizhawk is newer than we know about. If it doesn't work, consider downgrading to 2.9"
+local isUntestedBizHawk = bizhawk_major > 2 or (bizhawk_major == 2 and bizhawk_minor > 9)
+local untestedBizHawkMessage = "Warning: this version of BizHawk is newer than we know about. If it doesn't work, consider downgrading to 2.9"
u8 = memory.read_u8
wU8 = memory.write_u8
@@ -94,12 +94,12 @@ function drawMessages()
end
end
-function checkBizhawkVersion()
+function checkBizHawkVersion()
if not is23Or24Or25 and not isGreaterOrEqualTo26 then
- print("Must use a version of bizhawk 2.3.1 or higher")
+ print("Must use a version of BizHawk 2.3.1 or higher")
return false
- elseif isUntestedBizhawk then
- print(untestedBizhawkMessage)
+ elseif isUntestedBizHawk then
+ print(untestedBizHawkMessage)
end
return true
end
diff --git a/data/lua/connector_adventure.lua b/data/lua/connector_adventure.lua
index d5b18982843e..3c4c2ec7b858 100644
--- a/data/lua/connector_adventure.lua
+++ b/data/lua/connector_adventure.lua
@@ -457,7 +457,7 @@ end
function main()
memory.usememorydomain("System Bus")
- if not checkBizhawkVersion() then
+ if not checkBizHawkVersion() then
return
end
local playerSlot = memory.read_u8(PlayerSlotAddress)
diff --git a/data/lua/connector_ff1.lua b/data/lua/connector_ff1.lua
index 95f94a06dcce..455b046961f9 100644
--- a/data/lua/connector_ff1.lua
+++ b/data/lua/connector_ff1.lua
@@ -414,7 +414,7 @@ function receive()
end
function main()
- if not checkBizhawkVersion() then
+ if not checkBizHawkVersion() then
return
end
server, error = socket.bind('localhost', 52980)
diff --git a/data/lua/connector_ladx_bizhawk.lua b/data/lua/connector_ladx_bizhawk.lua
index 69ff6ff13731..038971be30f4 100644
--- a/data/lua/connector_ladx_bizhawk.lua
+++ b/data/lua/connector_ladx_bizhawk.lua
@@ -3,8 +3,8 @@
-- SPDX-License-Identifier: MIT
-- This script attempts to implement the basic functionality needed in order for
--- the LADXR Archipelago client to be able to talk to BizHawk instead of RetroArch
--- by reproducing the RetroArch API with BizHawk's Lua interface.
+-- the LADXR Archipelago client to be able to talk to EmuHawk instead of RetroArch
+-- by reproducing the RetroArch API with EmuHawk's Lua interface.
--
-- RetroArch UDP API: https://github.com/libretro/RetroArch/blob/master/command.c
--
@@ -16,19 +16,19 @@
-- commands are supported right now.
--
-- USAGE:
--- Load this script in BizHawk ("Tools" -> "Lua Console" -> "Script" -> "Open Script")
+-- Load this script in EmuHawk ("Tools" -> "Lua Console" -> "Script" -> "Open Script", or drag+drop)
--
-- All inconsistencies (like missing newlines for some commands) of the RetroArch
-- UDP API (network_cmd_enable) are reproduced as-is in order for clients written to work with
-- RetroArch's current API to "just work"(tm).
--
-- This script has only been tested on GB(C). If you have made sure it works for N64 or other
--- cores supported by BizHawk, please let me know. Note that GET_STATUS, at the very least, will
+-- cores supported by EmuHawk, please let me know. Note that GET_STATUS, at the very least, will
-- have to be adjusted.
--
--
-- NOTE:
--- BizHawk's Lua API is very trigger-happy on throwing exceptions.
+-- EmuHawk's Lua API is very trigger-happy on throwing exceptions.
-- Emulation will continue fine, but the RetroArch API layer will stop working. This
-- is indicated only by an exception visible in the Lua console, which most players
-- will probably not have in the foreground.
@@ -82,7 +82,7 @@ while true do
-- "GET_STATUS PLAYING game_boy,AP_62468482466172374046_P1_Lonk,crc32=3ecb7b6f"
-- CRC32 isn't readily available through the Lua API. We could calculate
-- it ourselves, but since LADXR doesn't make use of this field it is
- -- simply replaced by the hash that BizHawk _does_ make available.
+ -- simply replaced by the hash that EmuHawk _does_ make available.
udp:sendto(
"GET_STATUS " .. status .. " game_boy," ..
diff --git a/data/lua/connector_oot.lua b/data/lua/connector_oot.lua
index d4e277032b93..7bec37244b07 100644
--- a/data/lua/connector_oot.lua
+++ b/data/lua/connector_oot.lua
@@ -1862,7 +1862,7 @@ function receive()
end
function main()
- if not checkBizhawkVersion() then
+ if not checkBizHawkVersion() then
return
end
server, error = socket.bind('localhost', 28921)
diff --git a/data/lua/connector_pkmn_rb.lua b/data/lua/connector_pkmn_rb.lua
index 7a1a3d0bd209..3f56435bdbee 100644
--- a/data/lua/connector_pkmn_rb.lua
+++ b/data/lua/connector_pkmn_rb.lua
@@ -167,7 +167,7 @@ function receive()
end
function main()
- if not checkBizhawkVersion() then
+ if not checkBizHawkVersion() then
return
end
server, error = socket.bind('localhost', 17242)
diff --git a/data/lua/connector_tloz.lua b/data/lua/connector_tloz.lua
index 1764f5487cc1..f48e4dfac1f2 100644
--- a/data/lua/connector_tloz.lua
+++ b/data/lua/connector_tloz.lua
@@ -561,7 +561,7 @@ function receive()
end
function main()
- if not checkBizhawkVersion() then
+ if not checkBizHawkVersion() then
return
end
server, error = socket.bind('localhost', 52980)
diff --git a/docs/network diagram/network diagram.md b/docs/network diagram/network diagram.md
index 926c8723a08d..cd61d9fefd19 100644
--- a/docs/network diagram/network diagram.md
+++ b/docs/network diagram/network diagram.md
@@ -35,7 +35,7 @@ flowchart LR
subgraph Final Fantasy 1
FF1[FF1Client]
FFLUA[Lua Connector]
- BZFF[BizHawk with Final Fantasy Loaded]
+ BZFF[EmuHawk with Final Fantasy Loaded]
FF1 <-- LuaSockets --> FFLUA
FFLUA <--> BZFF
end
@@ -45,7 +45,7 @@ flowchart LR
subgraph Ocarina of Time
OC[OoTClient]
LC[Lua Connector]
- OCB[BizHawk with Ocarina of Time Loaded]
+ OCB[EmuHawk with Ocarina of Time Loaded]
OC <-- LuaSockets --> LC
LC <--> OCB
end
diff --git a/docs/network diagram/network diagram.svg b/docs/network diagram/network diagram.svg
index ba29b744d591..b79983d004fc 100644
--- a/docs/network diagram/network diagram.svg
+++ b/docs/network diagram/network diagram.svg
@@ -1 +1 @@
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/host.yaml b/host.yaml
index 463ffc39b301..26123954a7fd 100644
--- a/host.yaml
+++ b/host.yaml
@@ -136,7 +136,7 @@ tloz_options:
# true for operating system default program
# Alternatively, a path to a program to open the .nes file with
rom_start: true
- # Display message inside of Bizhawk
+ # Display message inside of EmuHawk
display_msgs: true
dkc3_options:
# File name of the DKC3 US rom
@@ -178,8 +178,8 @@ adventure_options:
# Alternatively, a path to a program to open the .a26 file with (generally EmuHawk for multiworld)
rom_start: true
# Optional, additional args passed into rom_start before the .bin file
- # For example, this can be used to autoload the connector script in BizHawk
- # (see BizHawk --lua= option)
+ # For example, this can be used to autoload the connector script in EmuHawk
+ # (see EmuHawk --lua= option)
# Windows example:
# rom_args: "--lua=C:/ProgramData/Archipelago/data/lua/connector_adventure.lua"
rom_args: " "
diff --git a/worlds/adventure/Options.py b/worlds/adventure/Options.py
index a8016fc28770..fb09e5329b82 100644
--- a/worlds/adventure/Options.py
+++ b/worlds/adventure/Options.py
@@ -175,7 +175,7 @@ class RhindleMinimumSpeed(Range):
class ConnectorMultiSlot(Toggle):
"""If true, the client and lua connector will add lowest 8 bits of the player slot
to the port number used to connect to each other, to simplify connecting multiple local
- clients to local BizHawks.
+ clients to local EmuHawk instances.
Set in the yaml, since the connector has to read this out of the rom file before connecting.
"""
display_name = "Connector Multi-Slot"
diff --git a/worlds/adventure/docs/setup_en.md b/worlds/adventure/docs/setup_en.md
index 3afa4544b078..10fc564aba51 100644
--- a/worlds/adventure/docs/setup_en.md
+++ b/worlds/adventure/docs/setup_en.md
@@ -2,32 +2,32 @@
## Important
-As we are using Bizhawk, this guide is only applicable to Windows and Linux systems.
+As we are using BizHawk, this guide is only applicable to Windows and Linux systems.
## Required Software
-- Bizhawk: [Bizhawk Releases from TASVideos](https://tasvideos.org/BizHawk/ReleaseHistory)
+- BizHawk: [BizHawk Releases from TASVideos](https://tasvideos.org/BizHawk/ReleaseHistory)
- Version 2.3.1 and later are supported. Version 2.7 is recommended for stability.
- - Detailed installation instructions for Bizhawk can be found at the above link.
+ - Detailed installation instructions for BizHawk can be found at the above link.
- Windows users must run the prereq installer first, which can also be found at the above link.
- The built-in Archipelago client, which can be installed [here](https://github.com/ArchipelagoMW/Archipelago/releases)
(select `Adventure Client` during installation).
- An Adventure NTSC ROM file. The Archipelago community cannot provide these.
-## Configuring Bizhawk
+## Configuring BizHawk
-Once Bizhawk has been installed, open Bizhawk and change the following settings:
+Once BizHawk has been installed, open EmuHawk and change the following settings:
-- Go to Config > Customize. Switch to the Advanced tab, then switch the Lua Core from "NLua+KopiLua" to
- "Lua+LuaInterface". Then restart Bizhawk. This is required for the Lua script to function correctly.
+- (≤ 2.8) Go to Config > Customize. Switch to the Advanced tab, then switch the Lua Core from "NLua+KopiLua" to
+ "Lua+LuaInterface". Then restart EmuHawk. This is required for the Lua script to function correctly.
**NOTE: Even if "Lua+LuaInterface" is already selected, toggle between the two options and reselect it. Fresh installs**
- **of newer versions of Bizhawk have a tendency to show "Lua+LuaInterface" as the default selected option but still load**
+ **of newer versions of EmuHawk have a tendency to show "Lua+LuaInterface" as the default selected option but still load**
**"NLua+KopiLua" until this step is done.**
- Under Config > Customize, check the "Run in background" box. This will prevent disconnecting from the client while
-BizHawk is running in the background.
+EmuHawk is running in the background.
-- It is recommended that you provide a path to BizHawk in your host.yaml for Adventure so the client can start it automatically
-- At the same time, you can set an option to automatically load the connector_adventure.lua script when launching BizHawk
+- It is recommended that you provide a path to EmuHawk in your host.yaml for Adventure so the client can start it automatically
+- At the same time, you can set an option to automatically load the connector_adventure.lua script when launching EmuHawk
from AdventureClient.
Default Windows install example:
```rom_args: "--lua=C:/ProgramData/Archipelago/data/lua/connector_adventure.lua"```
@@ -63,11 +63,10 @@ path as recommended).
### Connect to the Multiserver
-Once both the client and the emulator are started, you must connect them. Within the emulator click on the "Tools"
-menu and select "Lua Console". Click the folder button or press Ctrl+O to open a Lua script.
-
-Navigate to your Archipelago install folder and open `data/lua/connector_adventure.lua`, if it is not
-configured to do this automatically.
+Once both the client and the emulator are started, you must connect them, assuming you didn't set it up to be automatic.
+Navigate to your Archipelago install folder, then to `data/lua`, and drag+drop the `connector_adventure.lua` script onto
+the main EmuHawk window. (You could instead open the Lua Console manually, click `Script` 〉 `Open Script`, and navigate
+to `connector_adventure.lua` with the file picker.)
To connect the client to the multiserver simply put `:` on the textfield on top and press enter (if the
server uses password, type in the bottom textfield `/connect : [password]`)
diff --git a/worlds/alttp/docs/multiworld_de.md b/worlds/alttp/docs/multiworld_de.md
index 417bb8acff47..38009fb58ed3 100644
--- a/worlds/alttp/docs/multiworld_de.md
+++ b/worlds/alttp/docs/multiworld_de.md
@@ -7,7 +7,7 @@
- Hardware oder Software zum Laden und Abspielen von SNES Rom-Dateien fähig zu einer Internetverbindung
- Ein Emulator, der mit SNI verbinden kann
([snes9x rr](https://github.com/gocha/snes9x-rr/releases),
- [BizHawk](http://tasvideos.org/BizHawk.html))
+ [BizHawk](https://tasvideos.org/BizHawk))
- Ein SD2SNES, [FXPak Pro](https://krikzz.com/store/home/54-fxpak-pro.html), oder andere kompatible Hardware
- Die Japanische Zelda 1.0 ROM-Datei, mit folgendem Namen: `Zelda no Densetsu - Kamigami no Triforce (Japan).sfc`
@@ -106,7 +106,7 @@ kommunizieren darf.
##### BizHawk
-1. Stelle sicher, dass der BSNES-Core in Bizhawk geladen wird. Dazu musst du auf das Tools-Menü in Bizhawk klicken und
+1. Stelle sicher, dass der BSNES-Core in BizHawk geladen wird. Dazu musst du auf das Tools-Menü in BizHawk klicken und
folgende Optionen wählen:
`Config --> Cores --> SNES --> BSNES`
2. Lade die entsprechende ROM-Datei, wenn sie nicht schon automatisch geladen wurde.
diff --git a/worlds/alttp/docs/multiworld_en.md b/worlds/alttp/docs/multiworld_en.md
index 13cb9d3e3927..45e8fbedca69 100644
--- a/worlds/alttp/docs/multiworld_en.md
+++ b/worlds/alttp/docs/multiworld_en.md
@@ -6,7 +6,7 @@
- Hardware or software capable of loading and playing SNES ROM files
- An emulator capable of connecting to SNI
([snes9x rr](https://github.com/gocha/snes9x-rr/releases),
- [BizHawk](http://tasvideos.org/BizHawk.html), or
+ [BizHawk](https://tasvideos.org/BizHawk), or
[RetroArch](https://retroarch.com?page=platforms) 1.10.1 or newer). Or,
- An SD2SNES, [FXPak Pro](https://krikzz.com/store/home/54-fxpak-pro.html), or other compatible hardware. **note:
modded SNES minis are currently not supported by SNI**
@@ -88,16 +88,15 @@ the lua you are using in your file explorer and copy the `socket.dll` to the bas
##### BizHawk
-1. Ensure you have the BSNES core loaded. You may do this by clicking on the Tools menu in BizHawk and following these
- menu options:
- `Config --> Cores --> SNES --> BSNES`
- Once you have changed the loaded core, you must restart BizHawk.
+1. Ensure you have the BSNES core loaded. This is done with the main menubar, under:
+ - (≤ 2.8) `Config` 〉 `Cores` 〉 `SNES` 〉 `BSNES`
+ - (≥ 2.9) `Config` 〉 `Preferred Cores` 〉 `SNES` 〉 `BSNESv115+`
2. Load your ROM file if it hasn't already been loaded.
-3. Click on the Tools menu and click on **Lua Console**
-4. Click Script -> Open Script...
-5. Select the `Connector.lua` file you downloaded above
+ If you changed your core preference after loading the ROM, don't forget to reload it (default hotkey: Ctrl+R).
+3. Drag+drop the `Connector.lua` file that you downloaded above onto the main EmuHawk window.
- Look in the Archipelago folder for `/SNI/lua/`.
-
+ - You could instead open the Lua Console manually, click `Script` 〉 `Open Script`, and navigate to `Connector.lua`
+ with the file picker.
##### RetroArch 1.10.1 or newer
diff --git a/worlds/alttp/docs/multiworld_es.md b/worlds/alttp/docs/multiworld_es.md
index ca33f796c262..8576318bb997 100644
--- a/worlds/alttp/docs/multiworld_es.md
+++ b/worlds/alttp/docs/multiworld_es.md
@@ -13,7 +13,7 @@
- Hardware o software capaz de cargar y ejecutar archivos de ROM de SNES
- Un emulador capaz de ejecutar scripts Lua
([snes9x rr](https://github.com/gocha/snes9x-rr/releases),
- [BizHawk](http://tasvideos.org/BizHawk.html), o
+ [BizHawk](https://tasvideos.org/BizHawk), o
[RetroArch](https://retroarch.com?page=platforms) 1.10.1 o más nuevo). O,
- Un flashcart SD2SNES, [FXPak Pro](https://krikzz.com/store/home/54-fxpak-pro.html), o otro hardware compatible
- Tu archivo ROM japones v1.0, probablemente se llame `Zelda no Densetsu - Kamigami no Triforce (Japan).sfc`
@@ -126,7 +126,7 @@ ejecutas, puedes ser que el firewall de Windows te pregunte si le permites la co
1. Asegurate que se ha cargado el nucleo BSNES. Debes hacer esto en el menu Tools y siguiento estas opciones:
`Config --> Cores --> SNES --> BSNES`
- Una vez cambiado el nucleo cargado, Bizhawk ha de ser reiniciado.
+ Una vez cambiado el nucleo cargado, BizHawk ha de ser reiniciado.
2. Carga tu fichero de ROM, si no lo has hecho ya.
3. Haz click en el menu Tools y en la opción **Lua Console**
4. Haz click en el botón para abrir un nuevo script Lua.
diff --git a/worlds/alttp/docs/multiworld_fr.md b/worlds/alttp/docs/multiworld_fr.md
index 380a01023217..329ca6537573 100644
--- a/worlds/alttp/docs/multiworld_fr.md
+++ b/worlds/alttp/docs/multiworld_fr.md
@@ -13,7 +13,7 @@
- Une solution logicielle ou matérielle capable de charger et de lancer des fichiers ROM de SNES
- Un émulateur capable d'éxécuter des scripts Lua
([snes9x rr](https://github.com/gocha/snes9x-rr/releases),
- [BizHawk](http://tasvideos.org/BizHawk.html))
+ [BizHawk](https://tasvideos.org/BizHawk))
- Un SD2SNES, [FXPak Pro](https://krikzz.com/store/home/54-fxpak-pro.html), ou une autre solution matérielle
compatible
- Le fichier ROM de la v1.0 japonaise, sûrement nommé `Zelda no Densetsu - Kamigami no Triforce (Japan).sfc`
diff --git a/worlds/dkc3/docs/setup_en.md b/worlds/dkc3/docs/setup_en.md
index f3ba472599f3..56ef80d4a55f 100644
--- a/worlds/dkc3/docs/setup_en.md
+++ b/worlds/dkc3/docs/setup_en.md
@@ -8,7 +8,7 @@
- Hardware or software capable of loading and playing SNES ROM files
- An emulator capable of connecting to SNI such as:
- snes9x-rr from: [snes9x rr](https://github.com/gocha/snes9x-rr/releases),
- - BizHawk from: [BizHawk Website](http://tasvideos.org/BizHawk.html)
+ - BizHawk from: [TASVideos](https://tasvideos.org/BizHawk)
- RetroArch 1.10.3 or newer from: [RetroArch Website](https://retroarch.com?page=platforms). Or,
- An SD2SNES, FXPak Pro ([FXPak Pro Store Page](https://krikzz.com/store/home/54-fxpak-pro.html)), or other
compatible hardware
@@ -94,16 +94,16 @@ the lua you are using in your file explorer and copy the `socket.dll` to the bas
##### BizHawk
-1. Ensure you have the BSNES core loaded. You may do this by clicking on the Tools menu in BizHawk and following these
- menu options:
- `Config --> Cores --> SNES --> BSNES`
- Once you have changed the loaded core, you must restart BizHawk.
+1. Ensure you have the BSNES core loaded. This is done with the main menubar, under:
+ - (≤ 2.8) `Config` 〉 `Cores` 〉 `SNES` 〉 `BSNES`
+ - (≥ 2.9) `Config` 〉 `Preferred Cores` 〉 `SNES` 〉 `BSNESv115+`
2. Load your ROM file if it hasn't already been loaded.
-3. Click on the Tools menu and click on **Lua Console**
-4. Click the Open Folder icon that says `Open Script` via the tooltip on mouse hover, or click the Script Menu then `Open Script...`, or press `Ctrl-O`.
-5. Select the `Connector.lua` file included with your client
+ If you changed your core preference after loading the ROM, don't forget to reload it (default hotkey: Ctrl+R).
+3. Drag+drop the `Connector.lua` file included with your client onto the main EmuHawk window.
- Look in the Archipelago folder for `/SNI/lua/x64` or `/SNI/lua/x86` depending on if the
emulator is 64-bit or 32-bit. Please note the most recent versions of BizHawk are 64-bit only.
+ - You could instead open the Lua Console manually, click `Script` 〉 `Open Script`, and navigate to `Connector.lua`
+ with the file picker.
##### RetroArch 1.10.3 or newer
diff --git a/worlds/ff1/docs/multiworld_en.md b/worlds/ff1/docs/multiworld_en.md
index a827fb6e7d7b..51fcd9b7bfc4 100644
--- a/worlds/ff1/docs/multiworld_en.md
+++ b/worlds/ff1/docs/multiworld_en.md
@@ -5,7 +5,7 @@
- The FF1Client
- Bundled with Archipelago: [Archipelago Releases Page](https://github.com/ArchipelagoMW/Archipelago/releases)
- The BizHawk emulator. Versions 2.3.1 and higher are supported. Version 2.7 is recommended
- - [BizHawk Official Website](http://tasvideos.org/BizHawk.html)
+ - [BizHawk at TASVideos](https://tasvideos.org/BizHawk)
- Your legally obtained Final Fantasy (USA Edition) ROM file, probably named `Final Fantasy (USA).nes`. Neither
Archipelago.gg nor the Final Fantasy Randomizer Community can supply you with this.
@@ -13,13 +13,13 @@
1. Download and install the latest version of Archipelago.
1. On Windows, download Setup.Archipelago..exe and run it
-2. Assign Bizhawk version 2.3.1 or higher as your default program for launching `.nes` files.
- 1. Extract your Bizhawk folder to your Desktop, or somewhere you will remember. Below are optional additional steps
+2. Assign EmuHawk version 2.3.1 or higher as your default program for launching `.nes` files.
+ 1. Extract your BizHawk folder to your Desktop, or somewhere you will remember. Below are optional additional steps
for loading ROMs more conveniently
1. Right-click on a ROM file and select **Open with...**
2. Check the box next to **Always use this app to open .nes files**
3. Scroll to the bottom of the list and click the grey text **Look for another App on this PC**
- 4. Browse for `EmuHawk.exe` located inside your Bizhawk folder (from step 1) and click **Open**.
+ 4. Browse for `EmuHawk.exe` located inside your BizHawk folder (from step 1) and click **Open**.
## Obtaining your Archipelago yaml file and randomized ROM
@@ -54,14 +54,15 @@ Once the Archipelago server has been hosted:
### Running Your Game and Connecting to the Client Program
-1. Open Bizhawk 2.3.1 or higher and load your ROM OR click your ROM file if it is already associated with the
+1. Open EmuHawk 2.3.1 or higher and load your ROM OR click your ROM file if it is already associated with the
extension `*.nes`
-2. Click on the Tools menu and click on **Lua Console**
-3. Click the folder button to open a new Lua script. (CTL-O or **Script** -> **Open Script**)
-4. Navigate to the location you installed Archipelago to. Open data/lua/connector_ff1.lua
- 1. If it gives a `NLua.Exceptions.LuaScriptException: .\socket.lua:13: module 'socket.core' not found:` exception
+2. Navigate to where you installed Archipelago, then to `data/lua`, and drag+drop the `connector_ff1.lua` script onto
+ the main EmuHawk window.
+ 1. You could instead open the Lua Console manually, click `Script` 〉 `Open Script`, and navigate to
+ `connector_ff1.lua` with the file picker.
+ 2. If it gives a `NLua.Exceptions.LuaScriptException: .\socket.lua:13: module 'socket.core' not found:` exception
close your emulator entirely, restart it and re-run these steps
- 2. If it says `Must use a version of bizhawk 2.3.1 or higher`, double-check your Bizhawk version by clicking **
+ 3. If it says `Must use a version of BizHawk 2.3.1 or higher`, double-check your BizHawk version by clicking **
Help** -> **About**
## Play the game
diff --git a/worlds/ladx/docs/setup_en.md b/worlds/ladx/docs/setup_en.md
index 2fbd67dafa93..538d70d45e4a 100644
--- a/worlds/ladx/docs/setup_en.md
+++ b/worlds/ladx/docs/setup_en.md
@@ -79,10 +79,12 @@ You only have to do these steps once. Note, RetroArch 1.9.x will not work as it
#### BizHawk 2.8 or newer (older versions untested)
-1. With the ROM loaded, click on "Tools" --> "Lua Console"
-2. In the new window, click on "Script" --> "Open Script..."
-3. Navigate to the folder Archipelago is installed in, and choose data/lua/connector_ladx_bizhawk.lua
-4. Keep the Lua Console open during gameplay (minimizing it is fine!)
+1. Load the ROM.
+2. Navigate to the folder Archipelago is installed in, then `data/lua`, and drag+drop `connector_ladx_bizhawk.lua` onto
+ the main EmuHawk window.
+ - You could instead open the Lua Console manually, click `Script` 〉 `Open Script`, and navigate to
+ `connector_ladx_bizhawk.lua` with the file picker.
+3. Keep the Lua Console open during gameplay (minimizing it is fine!)
### Connect to the Archipelago Server
diff --git a/worlds/lufia2ac/docs/setup_en.md b/worlds/lufia2ac/docs/setup_en.md
index 6d14741bc393..f9e0d3725cfb 100644
--- a/worlds/lufia2ac/docs/setup_en.md
+++ b/worlds/lufia2ac/docs/setup_en.md
@@ -6,7 +6,7 @@
- Hardware or software capable of loading and playing SNES ROM files
- An emulator capable of connecting to SNI
([snes9x rr](https://github.com/gocha/snes9x-rr/releases),
- [BizHawk](http://tasvideos.org/BizHawk.html), or
+ [BizHawk](https://tasvideos.org/BizHawk), or
[RetroArch](https://retroarch.com?page=platforms) 1.10.3 or newer). Or,
- An SD2SNES, [FXPak Pro](https://krikzz.com/store/home/54-fxpak-pro.html), or other compatible hardware. **note:
modded SNES minis are currently not supported by SNI**
@@ -89,16 +89,16 @@ the lua you are using in your file explorer and copy the `socket.dll` to the bas
##### BizHawk
-1. Ensure you have the BSNES core loaded. You may do this by clicking on the Tools menu in BizHawk and following these
- menu options:
- `Config --> Cores --> SNES --> BSNES`
- Once you have changed the loaded core, you must restart BizHawk.
+1. Ensure you have the BSNES core loaded. This is done with the main menubar, under:
+ - (≤ 2.8) `Config` 〉 `Cores` 〉 `SNES` 〉 `BSNES`
+ - (≥ 2.9) `Config` 〉 `Preferred Cores` 〉 `SNES` 〉 `BSNESv115+`
2. Load your ROM file if it hasn't already been loaded.
-3. Click on the Tools menu and click on **Lua Console**
-4. Click Script -> Open Script...
-5. Select the `Connector.lua` file you downloaded above
+ If you changed your core preference after loading the ROM, don't forget to reload it (default hotkey: Ctrl+R).
+3. Drag+drop the `Connector.lua` file that you downloaded above onto the main EmuHawk window.
- Look in the Archipelago folder for `/SNI/lua/x64` or `/SNI/lua/x86` depending on if the
emulator is 64-bit or 32-bit. Please note the most recent versions of BizHawk are 64-bit only.
+ - You could instead open the Lua Console manually, click `Script` 〉 `Open Script`, and navigate to `Connector.lua`
+ with the file picker.
##### RetroArch 1.10.3 or newer
diff --git a/worlds/oot/docs/setup_en.md b/worlds/oot/docs/setup_en.md
index 414271d8e6d2..612c5efd8f99 100644
--- a/worlds/oot/docs/setup_en.md
+++ b/worlds/oot/docs/setup_en.md
@@ -2,26 +2,26 @@
## Important
-As we are using Bizhawk, this guide is only applicable to Windows and Linux systems.
+As we are using BizHawk, this guide is only applicable to Windows and Linux systems.
## Required Software
-- Bizhawk: [Bizhawk Releases from TASVideos](https://tasvideos.org/BizHawk/ReleaseHistory)
+- BizHawk: [BizHawk Releases from TASVideos](https://tasvideos.org/BizHawk/ReleaseHistory)
- Version 2.3.1 and later are supported. Version 2.7 is recommended for stability.
- - Detailed installation instructions for Bizhawk can be found at the above link.
+ - Detailed installation instructions for BizHawk can be found at the above link.
- Windows users must run the prereq installer first, which can also be found at the above link.
- The built-in Archipelago client, which can be installed [here](https://github.com/ArchipelagoMW/Archipelago/releases)
(select `Ocarina of Time Client` during installation).
- An Ocarina of Time v1.0 ROM.
-## Configuring Bizhawk
+## Configuring BizHawk
-Once Bizhawk has been installed, open Bizhawk and change the following settings:
+Once BizHawk has been installed, open EmuHawk and change the following settings:
-- Go to Config > Customize. Switch to the Advanced tab, then switch the Lua Core from "NLua+KopiLua" to
- "Lua+LuaInterface". Then restart Bizhawk. This is required for the Lua script to function correctly.
+- (≤ 2.8) Go to Config > Customize. Switch to the Advanced tab, then switch the Lua Core from "NLua+KopiLua" to
+ "Lua+LuaInterface". Then restart EmuHawk. This is required for the Lua script to function correctly.
**NOTE: Even if "Lua+LuaInterface" is already selected, toggle between the two options and reselect it. Fresh installs**
- **of newer versions of Bizhawk have a tendency to show "Lua+LuaInterface" as the default selected option but still load**
+ **of newer versions of EmuHawk have a tendency to show "Lua+LuaInterface" as the default selected option but still load**
**"NLua+KopiLua" until this step is done.**
- Under Config > Customize > Advanced, make sure the box for AutoSaveRAM is checked, and click the 5s button.
This reduces the possibility of losing save data in emulator crashes.
@@ -34,12 +34,12 @@ Once Bizhawk has been installed, open Bizhawk and change the following settings:
- Under N64 enable "Use Expansion Slot". This is required for savestates to work.
(The N64 menu only appears after loading a ROM.)
-It is strongly recommended to associate N64 rom extensions (\*.n64, \*.z64) to the Bizhawk we've just installed.
+It is strongly recommended to associate N64 rom extensions (\*.n64, \*.z64) to the EmuHawk we've just installed.
To do so, we simply have to search any N64 rom we happened to own, right click and select "Open with...", unfold
-the list that appears and select the bottom option "Look for another application", then browse to the Bizhawk folder
+the list that appears and select the bottom option "Look for another application", then browse to the BizHawk folder
and select EmuHawk.exe.
-An alternative Bizhawk setup guide as well as various pieces of troubleshooting advice can be found
+An alternative BizHawk setup guide as well as various pieces of troubleshooting advice can be found
[here](https://wiki.ootrandomizer.com/index.php?title=Bizhawk).
## Configuring your YAML file
@@ -411,10 +411,9 @@ to the emulator as recommended).
### Connect to the Multiserver
-Once both the client and the emulator are started, you must connect them. Within the emulator click on the "Tools"
-menu and select "Lua Console". Click the folder button or press Ctrl+O to open a Lua script.
-
-Navigate to your Archipelago install folder and open `data/lua/connector_oot.lua`.
+Once both the client and the emulator are started, you must connect them. Navigate to your Archipelago install folder,
+then to `data/lua`, and drag+drop the `connector_oot.lua` script onto the main EmuHawk window. (You could instead open
+the Lua Console manually, click `Script` 〉 `Open Script`, and navigate to `connector_oot.lua` with the file picker.)
To connect the client to the multiserver simply put `:` on the textfield on top and press enter (if the
server uses password, type in the bottom textfield `/connect : [password]`)
diff --git a/worlds/oot/docs/setup_es.md b/worlds/oot/docs/setup_es.md
index d67d73205f38..8d0ba8e308ca 100644
--- a/worlds/oot/docs/setup_es.md
+++ b/worlds/oot/docs/setup_es.md
@@ -2,7 +2,7 @@
## Nota importante
-Al usar el cliente y bizhawk, esta guia solo es aplicable en Windows.
+Al usar el cliente y BizHawk, esta guia solo es aplicable en Windows.
## Software Requerido
@@ -11,13 +11,13 @@ Al usar el cliente y bizhawk, esta guia solo es aplicable en Windows.
## Instala emulador y cliente
-Descarga el fichero getBizhawk.ps1 del enlace anterior. Colocalo en la carpeta donde desees instalar el emulador, haz
+Descarga el fichero getBizHawk.ps1 del enlace anterior. Colocalo en la carpeta donde desees instalar el emulador, haz
click derecho en él y selecciona "Ejecutar con PowerShell". Esto descargará todas las dependencias necesarias para el
emulador. Puede tardar un rato.
-Es recomendable asociar la extensión de las roms de N64 (\*.n64) al bizhawk que hemos instalado anteriormente. Para
+Es recomendable asociar la extensión de las roms de N64 (\*.n64) al BizHawk que hemos instalado anteriormente. Para
hacerlo simplemente debemos buscar alguna rom de n64 que tengamos, hacer click derecho, seleccionar "Abrir con...",
-desplegar la lista y buscar la opción "Buscar otra aplicación", navegar hasta el directorio de bizhawk y seleccionar
+desplegar la lista y buscar la opción "Buscar otra aplicación", navegar hasta el directorio de BizHawk y seleccionar
EmuHawk.exe
Situa el fichero ootMulti.lua del enlace anterior en la carpeta "lua" del emulador recien instalado.
diff --git a/worlds/oot/docs/setup_fr.md b/worlds/oot/docs/setup_fr.md
index 37df146def7c..57099cdf2e01 100644
--- a/worlds/oot/docs/setup_fr.md
+++ b/worlds/oot/docs/setup_fr.md
@@ -2,26 +2,26 @@
## Important
-Comme nous utilisons Bizhawk, ce guide ne s'applique qu'aux systèmes Windows et Linux.
+Comme nous utilisons BizHawk, ce guide ne s'applique qu'aux systèmes Windows et Linux.
## Logiciel requis
-- Bizhawk : [Bizhawk sort de TASVideos] (https://tasvideos.org/BizHawk/ReleaseHistory)
+- BizHawk : [BizHawk sort de TASVideos] (https://tasvideos.org/BizHawk/ReleaseHistory)
- Les versions 2.3.1 et ultérieures sont prises en charge. La version 2.7 est recommandée pour la stabilité.
- - Des instructions d'installation détaillées pour Bizhawk peuvent être trouvées sur le lien ci-dessus.
+ - Des instructions d'installation détaillées pour BizHawk peuvent être trouvées sur le lien ci-dessus.
- Les utilisateurs Windows doivent d'abord exécuter le programme d'installation prereq, qui peut également être trouvé sur le lien ci-dessus.
- Le client Archipelago intégré, qui peut être installé [ici](https://github.com/ArchipelagoMW/Archipelago/releases)
(sélectionnez `Ocarina of Time Client` lors de l'installation).
- Une ROM Ocarina of Time v1.0.
-## Configuration de Bizhawk
+## Configuration de BizHawk
-Une fois Bizhawk installé, ouvrez Bizhawk et modifiez les paramètres suivants :
+Une fois BizHawk installé, ouvrez BizHawk et modifiez les paramètres suivants :
- Allez dans Config > Personnaliser. Basculez vers l'onglet Avancé, puis basculez le Lua Core de "NLua+KopiLua" vers
- "Interface Lua+Lua". Redémarrez ensuite Bizhawk. Ceci est nécessaire pour que le script Lua fonctionne correctement.
+ "Interface Lua+Lua". Redémarrez ensuite BizHawk. Ceci est nécessaire pour que le script Lua fonctionne correctement.
**REMARQUE : Même si "Lua+LuaInterface" est déjà sélectionné, basculez entre les deux options et resélectionnez-le. Nouvelles installations**
- ** des versions plus récentes de Bizhawk ont tendance à afficher "Lua+LuaInterface" comme option sélectionnée par défaut mais se chargent toujours **
+ ** des versions plus récentes de BizHawk ont tendance à afficher "Lua+LuaInterface" comme option sélectionnée par défaut mais se chargent toujours **
**"NLua+KopiLua" jusqu'à ce que cette étape soit terminée.**
- Sous Config > Personnaliser > Avancé, assurez-vous que la case pour AutoSaveRAM est cochée et cliquez sur le bouton 5s.
Cela réduit la possibilité de perdre des données de sauvegarde en cas de plantage de l'émulateur.
@@ -34,12 +34,12 @@ Une fois Bizhawk installé, ouvrez Bizhawk et modifiez les paramètres suivants
- Sous N64, activez "Utiliser l'emplacement d'extension". Ceci est nécessaire pour que les sauvegardes fonctionnent.
(Le menu N64 n'apparaît qu'après le chargement d'une ROM.)
-Il est fortement recommandé d'associer les extensions de rom N64 (\*.n64, \*.z64) au Bizhawk que nous venons d'installer.
+Il est fortement recommandé d'associer les extensions de rom N64 (\*.n64, \*.z64) au BizHawk que nous venons d'installer.
Pour ce faire, nous devons simplement rechercher n'importe quelle rom N64 que nous possédons, faire un clic droit et sélectionner "Ouvrir avec ...", dépliez
-la liste qui apparaît et sélectionnez l'option du bas "Rechercher une autre application", puis naviguez jusqu'au dossier Bizhawk
+la liste qui apparaît et sélectionnez l'option du bas "Rechercher une autre application", puis naviguez jusqu'au dossier BizHawk
et sélectionnez EmuHawk.exe.
-Un guide de configuration Bizhawk alternatif ainsi que divers conseils de dépannage peuvent être trouvés
+Un guide de configuration BizHawk alternatif ainsi que divers conseils de dépannage peuvent être trouvés
[ici](https://wiki.ootrandomizer.com/index.php?title=Bizhawk).
## Configuration de votre fichier YAML
diff --git a/worlds/pokemon_rb/docs/setup_en.md b/worlds/pokemon_rb/docs/setup_en.md
index 92c12de1bd0e..488f3fdc0791 100644
--- a/worlds/pokemon_rb/docs/setup_en.md
+++ b/worlds/pokemon_rb/docs/setup_en.md
@@ -2,13 +2,13 @@
## Important
-As we are using Bizhawk, this guide is only applicable to Windows and Linux systems.
+As we are using BizHawk, this guide is only applicable to Windows and Linux systems.
## Required Software
-- Bizhawk: [Bizhawk Releases from TASVideos](https://tasvideos.org/BizHawk/ReleaseHistory)
+- BizHawk: [BizHawk Releases from TASVideos](https://tasvideos.org/BizHawk/ReleaseHistory)
- Version 2.3.1 and later are supported. Version 2.7 is recommended for stability.
- - Detailed installation instructions for Bizhawk can be found at the above link.
+ - Detailed installation instructions for BizHawk can be found at the above link.
- Windows users must run the prereq installer first, which can also be found at the above link.
- The built-in Archipelago client, which can be installed [here](https://github.com/ArchipelagoMW/Archipelago/releases)
(select `Pokemon Client` during installation).
@@ -19,23 +19,23 @@ As we are using Bizhawk, this guide is only applicable to Windows and Linux syst
- [Pokémon Red and Blue Archipelago Map Tracker](https://github.com/j-imbo/pkmnrb_jim/releases/latest), for use with [PopTracker](https://github.com/black-sliver/PopTracker/releases)
-## Configuring Bizhawk
+## Configuring BizHawk
-Once Bizhawk has been installed, open Bizhawk and change the following settings:
+Once BizHawk has been installed, open EmuHawk and change the following settings:
-- Go to Config > Customize. Switch to the Advanced tab, then switch the Lua Core from "NLua+KopiLua" to
- "Lua+LuaInterface". Then restart Bizhawk. This is required for the Lua script to function correctly.
+- (≤ 2.8) Go to Config > Customize. Switch to the Advanced tab, then switch the Lua Core from "NLua+KopiLua" to
+ "Lua+LuaInterface". Then restart EmuHawk. This is required for the Lua script to function correctly.
**NOTE: Even if "Lua+LuaInterface" is already selected, toggle between the two options and reselect it. Fresh installs**
- **of newer versions of Bizhawk have a tendency to show "Lua+LuaInterface" as the default selected option but still load**
+ **of newer versions of EmuHawk have a tendency to show "Lua+LuaInterface" as the default selected option but still load**
**"NLua+KopiLua" until this step is done.**
- Under Config > Customize > Advanced, make sure the box for AutoSaveRAM is checked, and click the 5s button.
This reduces the possibility of losing save data in emulator crashes.
- Under Config > Customize, check the "Run in background" box. This will prevent disconnecting from the client while
-BizHawk is running in the background.
+EmuHawk is running in the background.
-It is strongly recommended to associate GB rom extensions (\*.gb) to the Bizhawk we've just installed.
+It is strongly recommended to associate GB rom extensions (\*.gb) to the EmuHawk we've just installed.
To do so, we simply have to search any Gameboy rom we happened to own, right click and select "Open with...", unfold
-the list that appears and select the bottom option "Look for another application", then browse to the Bizhawk folder
+the list that appears and select the bottom option "Look for another application", then browse to the BizHawk folder
and select EmuHawk.exe.
## Configuring your YAML file
@@ -83,10 +83,10 @@ to the emulator as recommended).
### Connect to the Multiserver
-Once both the client and the emulator are started, you must connect them. Within the emulator click on the "Tools"
-menu and select "Lua Console". Click the folder button or press Ctrl+O to open a Lua script.
-
-Navigate to your Archipelago install folder and open `data/lua/connector_pkmn_rb.lua`.
+Once both the client and the emulator are started, you must connect them. Navigate to your Archipelago install folder,
+then to `data/lua`, and drag+drop the `connector_pkmn_rb.lua` script onto the main EmuHawk window. (You could instead
+open the Lua Console manually, click `Script` 〉 `Open Script`, and navigate to `connector_pkmn_rb.lua` with the file
+picker.)
To connect the client to the multiserver simply put `:` on the textfield on top and press enter (if the
server uses password, type in the bottom textfield `/connect : [password]`)
diff --git a/worlds/sm/docs/multiworld_en.md b/worlds/sm/docs/multiworld_en.md
index 77ec660dfeca..20c055bc91bf 100644
--- a/worlds/sm/docs/multiworld_en.md
+++ b/worlds/sm/docs/multiworld_en.md
@@ -8,7 +8,7 @@
- Hardware or software capable of loading and playing SNES ROM files
- An emulator capable of connecting to SNI such as:
- snes9x-rr from: [snes9x rr](https://github.com/gocha/snes9x-rr/releases),
- - BizHawk from: [BizHawk Website](http://tasvideos.org/BizHawk.html)
+ - BizHawk from: [TASVideos](https://tasvideos.org/BizHawk)
- RetroArch 1.10.1 or newer from: [RetroArch Website](https://retroarch.com?page=platforms). Or,
- An SD2SNES, FXPak Pro ([FXPak Pro Store Page](https://krikzz.com/store/home/54-fxpak-pro.html)), or other
compatible hardware
@@ -94,16 +94,16 @@ the lua you are using in your file explorer and copy the `socket.dll` to the bas
##### BizHawk
-1. Ensure you have the BSNES core loaded. You may do this by clicking on the Tools menu in BizHawk and following these
- menu options:
- `Config --> Cores --> SNES --> BSNES`
- Once you have changed the loaded core, you must restart BizHawk.
+1. Ensure you have the BSNES core loaded. This is done with the main menubar, under:
+ - (≤ 2.8) `Config` 〉 `Cores` 〉 `SNES` 〉 `BSNES`
+ - (≥ 2.9) `Config` 〉 `Preferred Cores` 〉 `SNES` 〉 `BSNESv115+`
2. Load your ROM file if it hasn't already been loaded.
-3. Click on the Tools menu and click on **Lua Console**
-4. Click the Open Folder icon that says `Open Script` via the tooltip on mouse hover, or click the Script Menu then `Open Script...`, or press `Ctrl-O`.
-5. Select the `Connector.lua` file included with your client
+ If you changed your core preference after loading the ROM, don't forget to reload it (default hotkey: Ctrl+R).
+3. Drag+drop the `Connector.lua` file included with your client onto the main EmuHawk window.
- Look in the Archipelago folder for `/SNI/lua/x64` or `/SNI/lua/x86` depending on if the
emulator is 64-bit or 32-bit. Please note the most recent versions of BizHawk are 64-bit only.
+ - You could instead open the Lua Console manually, click `Script` 〉 `Open Script`, and navigate to `Connector.lua`
+ with the file picker.
##### RetroArch 1.10.1 or newer
diff --git a/worlds/smw/docs/setup_en.md b/worlds/smw/docs/setup_en.md
index a8f67592277f..2a9435c95d42 100644
--- a/worlds/smw/docs/setup_en.md
+++ b/worlds/smw/docs/setup_en.md
@@ -8,7 +8,7 @@
- Hardware or software capable of loading and playing SNES ROM files
- An emulator capable of connecting to SNI such as:
- snes9x-rr from: [snes9x rr](https://github.com/gocha/snes9x-rr/releases),
- - BizHawk from: [BizHawk Website](http://tasvideos.org/BizHawk.html)
+ - BizHawk from: [TASVideos](https://tasvideos.org/BizHawk)
- RetroArch 1.10.3 or newer from: [RetroArch Website](https://retroarch.com?page=platforms). Or,
- An SD2SNES, FXPak Pro ([FXPak Pro Store Page](https://krikzz.com/store/home/54-fxpak-pro.html)), or other
compatible hardware
@@ -84,16 +84,16 @@ the lua you are using in your file explorer and copy the `socket.dll` to the bas
##### BizHawk
-1. Ensure you have the BSNES core loaded. You may do this by clicking on the Tools menu in BizHawk and following these
- menu options:
- `Config --> Cores --> SNES --> BSNES`
- Once you have changed the loaded core, you must restart BizHawk.
+1. Ensure you have the BSNES core loaded. This is done with the main menubar, under:
+ - (≤ 2.8) `Config` 〉 `Cores` 〉 `SNES` 〉 `BSNES`
+ - (≥ 2.9) `Config` 〉 `Preferred Cores` 〉 `SNES` 〉 `BSNESv115+`
2. Load your ROM file if it hasn't already been loaded.
-3. Click on the Tools menu and click on **Lua Console**
-4. Click the Open Folder icon that says `Open Script` via the tooltip on mouse hover, or click the Script Menu then `Open Script...`, or press `Ctrl-O`.
-5. Select the `Connector.lua` file included with your client
+ If you changed your core preference after loading the ROM, don't forget to reload it (default hotkey: Ctrl+R).
+3. Drag+drop the `Connector.lua` file included with your client onto the main EmuHawk window.
- Look in the Archipelago folder for `/SNI/lua/x64` or `/SNI/lua/x86` depending on if the
emulator is 64-bit or 32-bit. Please note the most recent versions of BizHawk are 64-bit only.
+ - You could instead open the Lua Console manually, click `Script` 〉 `Open Script`, and navigate to `Connector.lua`
+ with the file picker.
##### RetroArch 1.10.3 or newer
diff --git a/worlds/smz3/docs/multiworld_en.md b/worlds/smz3/docs/multiworld_en.md
index f375cd55e1e8..27c8a507e3df 100644
--- a/worlds/smz3/docs/multiworld_en.md
+++ b/worlds/smz3/docs/multiworld_en.md
@@ -9,7 +9,7 @@
- Hardware or software capable of loading and playing SNES ROM files
- An emulator capable of connecting to SNI such as:
- snes9x-rr from: [snes9x rr](https://github.com/gocha/snes9x-rr/releases),
- - BizHawk from: [BizHawk Website](http://tasvideos.org/BizHawk.html), or
+ - BizHawk from: [TASVideos](https://tasvideos.org/BizHawk), or
- RetroArch 1.10.3 or newer from: [RetroArch Website](https://retroarch.com?page=platforms). Or,
- An SD2SNES, FXPak Pro ([FXPak Pro Store Page](https://krikzz.com/store/home/54-fxpak-pro.html)), or other
compatible hardware
@@ -92,16 +92,16 @@ the lua you are using in your file explorer and copy the `socket.dll` to the bas
##### BizHawk
-1. Ensure you have the BSNES core loaded. You may do this by clicking on the Tools menu in BizHawk and following these
- menu options:
- `Config --> Cores --> SNES --> BSNES`
- Once you have changed the loaded core, you must restart BizHawk.
+1. Ensure you have the BSNES core loaded. This is done with the main menubar, under:
+ - (≤ 2.8) `Config` 〉 `Cores` 〉 `SNES` 〉 `BSNES`
+ - (≥ 2.9) `Config` 〉 `Preferred Cores` 〉 `SNES` 〉 `BSNESv115+`
2. Load your ROM file if it hasn't already been loaded.
-3. Click on the Tools menu and click on **Lua Console**
-4. Click the Open Folder icon that says `Open Script` via the tooltip on mouse hover, or click the Script Menu then `Open Script...`, or press `Ctrl-O`.
-5. Select the `Connector.lua` file included with your client
+ If you changed your core preference after loading the ROM, don't forget to reload it (default hotkey: Ctrl+R).
+3. Drag+drop the `Connector.lua` file included with your client onto the main EmuHawk window.
- Look in the Archipelago folder for `/SNI/lua/x64` or `/SNI/lua/x86` depending on if the
emulator is 64-bit or 32-bit. Please note the most recent versions of BizHawk are 64-bit only.
+ - You could instead open the Lua Console manually, click `Script` 〉 `Open Script`, and navigate to `Connector.lua`
+ with the file picker.
##### RetroArch 1.10.3 or newer
diff --git a/worlds/soe/docs/multiworld_en.md b/worlds/soe/docs/multiworld_en.md
index fcaf339f7b52..f3fcfbb8fede 100644
--- a/worlds/soe/docs/multiworld_en.md
+++ b/worlds/soe/docs/multiworld_en.md
@@ -7,7 +7,7 @@
- Hardware or software capable of loading and playing SNES ROM files
- An emulator capable of connecting to SNI with ROM access. Any one of the following will work:
- snes9x-rr from: [snes9x-rr Releases Page](https://github.com/gocha/snes9x-rr/releases)
- - BizHawk from: [BizHawk Website](http://tasvideos.org/BizHawk.html)
+ - BizHawk from: [TASVideos](https://tasvideos.org/BizHawk)
- bsnes-plus-nwa from: [bsnes-plus GitHub](https://github.com/black-sliver/bsnes-plus)
- RetroArch from: [RetroArch Website](https://retroarch.com?page=platforms). Or,
- Or SD2SNES, FXPak Pro ([FXPak Pro Store Page](https://krikzz.com/store/home/54-fxpak-pro.html)), or other
@@ -79,14 +79,14 @@ you may be prompted to allow it to communicate through the Windows Firewall.
##### BizHawk
-1. Ensure you have the BSNES core loaded. You may do this by clicking on the Tools menu in BizHawk and following these
- menu options:
- `Config --> Cores --> SNES --> BSNES`
- Once you have changed the loaded core, you must restart BizHawk.
+1. Ensure you have the BSNES core loaded. This is done with the main menubar, under:
+ - (≤ 2.8) `Config` 〉 `Cores` 〉 `SNES` 〉 `BSNES`
+ - (≥ 2.9) `Config` 〉 `Preferred Cores` 〉 `SNES` 〉 `BSNESv115+`
2. Load your ROM file if it hasn't already been loaded.
-3. Click on the Tools menu and click on **Lua Console**
-4. Click the Open Folder icon that says `Open Script` via the tooltip on mouse hover, or click the Script Menu then `Open Script...`, or press `Ctrl-O`.
-5. Select any `Connector.lua` file from your SNI installation
+ If you changed your core preference after loading the ROM, don't forget to reload it (default hotkey: Ctrl+R).
+3. Drag+drop the `Connector.lua` file from your SNI installation onto the main EmuHawk window.
+ - You could instead open the Lua Console manually, click `Script` 〉 `Open Script`, and navigate to `Connector.lua`
+ with the file picker.
##### bsnes-plus-nwa
diff --git a/worlds/tloz/docs/multiworld_en.md b/worlds/tloz/docs/multiworld_en.md
index ab3acf0b291c..e5686f7e301e 100644
--- a/worlds/tloz/docs/multiworld_en.md
+++ b/worlds/tloz/docs/multiworld_en.md
@@ -5,7 +5,7 @@
- The Zelda1Client
- Bundled with Archipelago: [Archipelago Releases Page](https://github.com/ArchipelagoMW/Archipelago/releases)
- The BizHawk emulator. Versions 2.3.1 and higher are supported. Version 2.7 is recommended
- - [BizHawk Official Website](http://tasvideos.org/BizHawk.html)
+ - [BizHawk at TASVideos](https://tasvideos.org/BizHawk)
## Optional Software
@@ -16,13 +16,13 @@
1. Download and install the latest version of Archipelago.
- On Windows, download Setup.Archipelago..exe and run it.
-2. Assign Bizhawk version 2.3.1 or higher as your default program for launching `.nes` files.
- - Extract your Bizhawk folder to your Desktop, or somewhere you will remember. Below are optional additional steps
+2. Assign EmuHawk version 2.3.1 or higher as your default program for launching `.nes` files.
+ - Extract your BizHawk folder to your Desktop, or somewhere you will remember. Below are optional additional steps
for loading ROMs more conveniently.
1. Right-click on a ROM file and select **Open with...**
2. Check the box next to **Always use this app to open .nes files**.
3. Scroll to the bottom of the list and click the grey text **Look for another App on this PC**.
- 4. Browse for `EmuHawk.exe` located inside your Bizhawk folder (from step 1) and click **Open**.
+ 4. Browse for `EmuHawk.exe` located inside your BizHawk folder (from step 1) and click **Open**.
## Create a Config (.yaml) File
@@ -76,14 +76,15 @@ Once the Archipelago server has been hosted:
### Running Your Game and Connecting to the Client Program
-1. Open Bizhawk 2.3.1 or higher and load your ROM OR click your ROM file if it is already associated with the
+1. Open EmuHawk 2.3.1 or higher and load your ROM OR click your ROM file if it is already associated with the
extension `*.nes`.
-2. Click on the Tools menu and click on **Lua Console**.
-3. Click the folder button to open a new Lua script. (CTL-O or **Script** -> **Open Script**)
-4. Navigate to the location you installed Archipelago to. Open `data/lua/connector_tloz.lua`.
- 1. If it gives a `NLua.Exceptions.LuaScriptException: .\socket.lua:13: module 'socket.core' not found:` exception
+2. Navigate to where you installed Archipelago, then to `data/lua`, and drag+drop the `connector_ff1.lua` script onto
+ the main EmuHawk window.
+ 1. You could instead open the Lua Console manually, click `Script` 〉 `Open Script`, and navigate to
+ `connector_ff1.lua` with the file picker.
+ 2. If it gives a `NLua.Exceptions.LuaScriptException: .\socket.lua:13: module 'socket.core' not found:` exception
close your emulator entirely, restart it and re-run these steps.
- 2. If it says `Must use a version of bizhawk 2.3.1 or higher`, double-check your Bizhawk version by clicking **
+ 3. If it says `Must use a version of BizHawk 2.3.1 or higher`, double-check your BizHawk version by clicking **
Help** -> **About**.
## Play the game