morgan/Grinch-AP
1
0
Fork 0
mirror of https://github.com/MarioSpore/Grinch-AP.git synced 2025-10-21 20:21:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Revise all docs mentioning Lua in EmuHawk (which are in English), and other misc. corrections (#1782)

Browse Source 
* Fix links to TASVideos.org using HTTP

* Revise all docs mentioning Lua in EmuHawk which are in English

resolves TASEmulators/BizHawk#3650

* Correct capitalisation of "BizHawk"

in strings and camelCase identifiers

* Use the term "EmuHawk" when referring to the app, in English docs

---------

Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>
This commit is contained in:
James Groom
2023-06-26 16:53:44 +10:00
committed by GitHub
parent 751e5cec63
commit 1698c17caa
33 changed files with 175 additions and 174 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
worlds/tloz/docs/multiworld_en.md
View File

@@ -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.<HighestVersion\>.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