FF1: Bizhawk Client and APWorld Support #4448

Rosalie-A · 2025-01-08T16:57:22Z

Please format your title with what portion of the project this pull request is
targeting and what it's changing.

ex. "MyGame4: implement new game" or "Docs: add new guide for customizing MyGame3"

What is this fixing or adding?

Converts FF1 to using the Bizhawk Client instead of its bespoke client and connector, with updated documentation.

Also makes the few changes needed to allow it to be an APWorld instead of a folder in lib/worlds, mostly for my convenience.

How was this tested?

Ran through an entire game, checked every location to make sure it sent. Received items, both naturally and through admin console, and confirmed they arrived properly. Also put this up for testing in the Discord, and no issues have been reported as of the latest version (whether this means no testers or no issues is, as always, up in the air).

If this makes graphical changes, please attach screenshots.

…hipelago into FF1-Bizhawk-Client

qwint

pure code review, did not run the client at all nor play any games, also only briefly reviewed docs changes and full Client.py code

You will also need to update inno_setup.iss to remove the old frozen executable (and likely the old folder since you're moving to .apworld format too) but other than and my pkgutil comments looks good

qwint · 2025-01-08T18:05:03Z

worlds/ff1/Items.py

-                                FF1_PROGRESSION_LIST else ItemClassification.useful if name in FF1_USEFUL_LIST else
-                                ItemClassification.filler) for name, code in items.items()]
-            self._item_table_lookup = {item.name: item for item in self._item_table}
+        file = pkgutil.get_data(__name__, os.path.join("data", "items.json")).decode("utf-8")


Suggested change

file = pkgutil.get_data(__name__, os.path.join("data", "items.json")).decode("utf-8")

file = pkgutil.get_data(__name__, "data/items.json").decode("utf-8")

ref #4232
for this and the other similar suggestion (also there's no need for the os import after this change)

qwint · 2025-01-08T18:05:23Z

worlds/ff1/Locations.py

-            # Hardcode progression and categories for now
-            self._location_table = [LocationData(name, code) for name, code in locations.items()]
-            self._location_table_lookup = {item.name: item for item in self._location_table}
+        file = pkgutil.get_data(__name__, os.path.join("data", "locations.json"))


Suggested change

file = pkgutil.get_data(__name__, os.path.join("data", "locations.json"))

file = pkgutil.get_data(__name__, "data/locations.json")

worlds/ff1/Client.py

…changed the logger in the client to actually do something.

qwint

not certain there aren't more required inno_setup changes, but the updates fixed every issue that existed to my knowledge

worlds/ff1/Client.py

+
+    async def read_ram_value(self, ctx, location):
+        value = ((await bizhawk.read(ctx.bizhawk_ctx, [(location, 1, self.wram)]))[0])
+        return int.from_bytes(value)


worlds/ff1/Client.py

+                if self.consumable_stack_amounts is None:
+                    self.consumable_stack_amounts = {}
+                    self.consumable_stack_amounts["Shard"] = 1
+                    self.consumable_stack_amounts["Tent"] = (await self.read_rom(ctx, 0x47400, 1))[0] + 1


worlds/ff1/Client.py

+                    self.consumable_stack_amounts["Ext1"] = (await self.read_rom(ctx, 0x47406, 1))[0] + 1
+                    self.consumable_stack_amounts["Ext2"] = (await self.read_rom(ctx, 0x47407, 1))[0] + 1
+                    self.consumable_stack_amounts["Ext3"] = (await self.read_rom(ctx, 0x47408, 1))[0] + 1
+                    self.consumable_stack_amounts["Ext4"] = (await self.read_rom(ctx, 0x47409, 1))[0] + 1


worlds/ff1/docs/multiworld_en.md

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

 ## Installation Procedures

 1. Download and install the latest version of Archipelago.
    1. On Windows, download Setup.Archipelago.<HighestVersion\>.exe and run it
-2. Assign EmuHawk version 2.3.1 or higher as your default program for launching `.nes` files.
+2. Assign EmuHawk or higher as your default program for launching `.nes` files.


beauxq · 2025-01-11T14:58:01Z

Rosalie-A#72

ff1 client cleaning

worlds/ff1/Client.py

setup.py

Fixed a bug with extended consumables being switched.

worlds/ff1/Client.py

Zunawe · 2025-02-08T22:16:47Z

You'll want to add the old client and script to the inno_setup script so they get get deleted by the installer.

Rosalie-A · 2025-02-08T22:25:31Z

You'll want to add the old client and script to the inno_setup script so they get get deleted by the installer.

Unless I'm crazy, I already caught the old client, but I did completely miss removing the old Lua script, thank you. Latest commit fixes that.

wildham0

while i can't speak for the specifics of ap, the legacy lua behiavours have been correctly transferred to the client and the appropriate memory addresses and values are queried

Zunawe

Mostly just a quick scroll through. I think the client looks fine from the standpoint of interacting with BizHawk. Comments are basically just suggestions.

Zunawe · 2025-02-09T03:25:08Z

worlds/ff1/Client.py

+        status_b = await self.read_sram_value(ctx, status_b_location)
+        status_c = await self.read_sram_value(ctx, status_c_location)
+
+        # First character's name's first character will never have FF


There's no problem here, I just have to comment on the silliness of this sentence.

worlds/ff1/Client.py

worlds/ff1/docs/multiworld_en.md

worlds/ff1/Client.py

Also implemented item received messages in Bizhawk.

…nto FF1-Bizhawk-Client

Fixed a bug with the guard against writing on title screen. Removed redundant read.

Zunawe

Everything looks fine as far as correctly utilizing BizHawk Client. Didn't test, and couldn't say myself whether it correctly replaces all the necessary behaviors.

beauxq · 2025-02-10T00:46:45Z

worlds/ff1/Client.py

+                current_gold = int.from_bytes(await self.read_sram_values_guarded(ctx, gp_location_low, 3), "little")
+                if current_gold is None:
+                    return


current_gold is not something that needs to be checked for None - It will never be None

What needs to be checked it the result of await self.read_sram_values_guarded(ctx, gp_location_low, 3)

Oops. Fixed.

Rosalie-A added 3 commits January 8, 2025 11:38

Bizhawk client and APWorld support.

7ada5ce

Removed now-unused connector lua.

253a328

Merge branch 'main' into FF1-Bizhawk-Client

b517787

github-actions bot added affects: core Issues/PRs that touch core and may need additional validation. waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. labels Jan 8, 2025

Rosalie-A added 2 commits January 8, 2025 12:03

Forgot to remove the FF1 Client from the launcher.

d42edf0

Merge branch 'FF1-Bizhawk-Client' of https://github.com/Rosalie-A/Arc…

72b6df0

…hipelago into FF1-Bizhawk-Client

qwint suggested changes Jan 8, 2025

View reviewed changes

Removed unnecessary os.path calls, set old client to be removed, and …

4d00b7d

…changed the logger in the client to actually do something.

qwint approved these changes Jan 8, 2025

View reviewed changes

beauxq reviewed Jan 9, 2025

View reviewed changes

worlds/ff1/Client.py Outdated

async def read_ram_value(self, ctx, location):

value = ((await bizhawk.read(ctx.bizhawk_ctx, [(location, 1, self.wram)]))[0])

return int.from_bytes(value)

This comment was marked as resolved.

Sign in to view

beauxq reviewed Jan 9, 2025

View reviewed changes

Rosalie-A added 2 commits January 10, 2025 12:17

Updated according to review comments.

2b57074

Dastardly copy/paste error.

8f61aa7

ScipioWright added the is: enhancement Issues requesting new features or pull requests implementing new features. label Jan 10, 2025

ff1 client cleaning

cc7a33f

Merge pull request #72 from beauxq/ff1-client-cleaning

1fb53ad

ff1 client cleaning

Zunawe reviewed Jan 12, 2025

View reviewed changes

worlds/ff1/Client.py Outdated Show resolved Hide resolved

beauxq reviewed Jan 12, 2025

View reviewed changes

setup.py Show resolved Hide resolved

Changed client to use guarded reads/writes.

c89672a

Fixed a bug with extended consumables being switched.

qwint reviewed Feb 8, 2025

View reviewed changes

worlds/ff1/Client.py Outdated Show resolved Hide resolved

worlds/ff1/Client.py Outdated Show resolved Hide resolved

Updated in accordance with review comments.

bb5e7d4

Remove old connector lua on install.

bfe9125

wildham0 approved these changes Feb 9, 2025

View reviewed changes

Zunawe reviewed Feb 9, 2025

View reviewed changes

Rosalie-A added 3 commits February 9, 2025 12:49

Updated documentation and cleaned up unneeded client code.

315ea54

Also implemented item received messages in Bizhawk.

Merge branch 'main' of https://github.com/ArchipelagoMW/Archipelago i…

78dadea

…nto FF1-Bizhawk-Client

Updated to latest main to use new check_locations function.

60aeb91

Fixed a bug with the guard against writing on title screen. Removed redundant read.

Zunawe approved these changes Feb 9, 2025

View reviewed changes

qwint added waiting-on: core-review Issue/PR has been peer-reviewed and is ready to be merged or needs input from a core maintainer. and removed waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. labels Feb 9, 2025

beauxq reviewed Feb 10, 2025

View reviewed changes

Rosalie-A added 2 commits February 9, 2025 19:49

Current gold is now checked for properly.

58359da

Merge branch 'main' into FF1-Bizhawk-Client

d3df287

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FF1: Bizhawk Client and APWorld Support #4448

FF1: Bizhawk Client and APWorld Support #4448

Rosalie-A commented Jan 8, 2025

qwint left a comment

qwint Jan 8, 2025

qwint Jan 8, 2025

qwint left a comment

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

beauxq commented Jan 11, 2025

Zunawe commented Feb 8, 2025

Rosalie-A commented Feb 8, 2025 •

edited

Loading

wildham0 left a comment

Zunawe left a comment

Zunawe Feb 9, 2025

Zunawe left a comment

beauxq Feb 10, 2025

Rosalie-A Feb 10, 2025

	file = pkgutil.get_data(__name__, os.path.join("data", "items.json")).decode("utf-8")
	file = pkgutil.get_data(__name__, "data/items.json").decode("utf-8")

FF1: Bizhawk Client and APWorld Support #4448

Are you sure you want to change the base?

FF1: Bizhawk Client and APWorld Support #4448

Conversation

Rosalie-A commented Jan 8, 2025

What is this fixing or adding?

How was this tested?

If this makes graphical changes, please attach screenshots.

qwint left a comment

Choose a reason for hiding this comment

qwint Jan 8, 2025

Choose a reason for hiding this comment

qwint Jan 8, 2025

Choose a reason for hiding this comment

qwint left a comment

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

beauxq commented Jan 11, 2025

Zunawe commented Feb 8, 2025

Rosalie-A commented Feb 8, 2025 • edited Loading

wildham0 left a comment

Choose a reason for hiding this comment

Zunawe left a comment

Choose a reason for hiding this comment

Zunawe Feb 9, 2025

Choose a reason for hiding this comment

Zunawe left a comment

Choose a reason for hiding this comment

beauxq Feb 10, 2025

Choose a reason for hiding this comment

Rosalie-A Feb 10, 2025

Choose a reason for hiding this comment

Rosalie-A commented Feb 8, 2025 •

edited

Loading