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

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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