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

* 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

View File

@@ -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 `<address>:<port>` on the textfield on top and press enter (if the
server uses password, type in the bottom textfield `/connect <address>:<port> [password]`)

View File

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

View File

@@ -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