BizHawk 2.6.3+ compatibility

authorblues / bizhawk-shuffler-2

A script to randomly shuffle between games played in Bizhawk, with plugins to enhance the experience

MIT License

58 stars 21 forks source link

BizHawk 2.6.3+ compatibility #54

Closed kalimag closed 1 year ago

kalimag commented 2 years ago

WIP support for BizHawk 2.6.3+ in the 2.6.3-compat branch

[x] Basic support
[x] Plugins don't work yet
[x] Script crashes if ROM is loaded while starting a session (frameadvance() mustn't be called from setup form callback)
[ ] Make sure plugins do everything in on_game_load and don't rely on script restarts to clear variables etc.
[x] Update documentation
[x] Remove any remaining comments cursing how client.openrom() works

kalimag commented 2 years ago

@authorblues Can you give the multiworld plugins a go when you have some time?

kalimag commented 2 years ago

Also, at first I thought this was a regression due to the 2.6.3 changes but apparently it's always been this way: Should plugin.on_setup be called when resuming a session?

As is, the color plugin reassigns new colors after resuming a session (which isn't too bad), and the damage shuffler rebuilds its tag cache (which may even be desirable), but I'm wondering if it's okay for the multiworld plugins to overwrite their stuff in data. I don't understand them well enough to tell if that's just cached data that can be rebuild, or if it's important persistent data.

Sophilautia commented 2 years ago

Is this still in development? Really wanting to upgrade my BizHawk to fix some issues I've been encountering with controls. I tested this branch but the plugin we've made doesn't seem to work with it yet.

kalimag commented 2 years ago

As far as I know it should be functional, I just never got around to testing it properly.

What plugin are you having trouble with? Plugins may have to be updated to support the 2.6.3+ changes.

Sophilautia commented 2 years ago

Ah!! I just realised the fault of the plugin was on my end. Looks like it's all good now!

Any particular feedback you need from testing? I'm gonna try using it for my purposes here on out.

kalimag commented 2 years ago

Well, any new bugs really. Especially those related to loading games/states and resuming sessions.

I have tested it during development of course, but haven't done any long running sessions with varied systems etc.