[Linux] [Sonic Frontiers] Codes utilizing LUA cause instability and crashes

[jSQrD-dev]

hedge-dev/HedgeModManager#82
This issue was incorrectly attributed to the Mod Manager itself however further testing by @Zelly9191
hedge-dev/HedgeModManager#82 (comment)

Shows that any code or mods utilizing codes that use Lua causes instability and crashes in many instances.

One hypothesis as to why are the offsets in the codes are not hitting the memory address that it wants is possibly due to some memory mapping differences between proton and Windows.

[Zelly9191]

To copy my comment from the other thread:

FINALLY

I had a breakthrough and I think I've roughly nailed down what the actual issue is.

I'm going to do my best to show what the actual core of the issue is while providing image proof. I'm also going to summarize everything in this thread for those who come after and are looking for the solution.

Something with Lua isn't working right.
I'm not sure exactly what it is but consistently when an activated code uses Lua the tutorial and other scripted events break.

The debug log was the key to figuring this out as whenever the bug would occur the log would be sprinkled with stuff like this:

and this:

and when it DIDN'T happen it would look like this:

Now I cant nail down WHY Lua is breaking stuff all I know is something isn't working quite right. Turning off the codes that used Lua seems to have fixed it for now.

For those that are doing testing after me: The first time something goes wrong is after you destroy the first group of over world enemies. The tutorial dialog box regarding their drops doesn't pop up afterwards. If that box doesn't pop up you can be 90% sure something broke. No need to fight the boss or walk up to the temple. (I never had a situation where one thing worked but the others didn't but i could be wrong.)

It's also important to note that the reason why a code may seem okay sometimes but not other times is because often the codes that use Lua have to do with sounds and those codes don't always trigger due to the nature of being sound based. Other times its due to the nature of some codes being conditional they don't always activate.

Ive got two temporary solutions for users. A thorough solution, and the nuclear solution.

So for those looking for a thorough solution do the following:

1. Look through all of your mod folders for .hmm files move them out of your mods folder and into their own folder. Additionally, make a copy of the default Codes.hmm file you'll need it later.

2. Copy the contents of every file (Except the default .hmm) into one file.

3. Close hedge mod manager if it's open. Then delete the Codes.hmm file from the mods folder and replace it with the file you made that contains all the codes from all your mods.

4. Open hedge mod manager and enable every code (feel free to not turn on ones you don't want) The list that will be in hedge mod manager will be only the codes you copied into that file and as a result be all the codes your mods expect.

5. Go through and disable every code that has the (#lib "Lua") line (without the brackets) in its section within the file. Additionally, you also need to check for any other libraries in the codes file that have the (#lib "Lua") line as any codes using those libraries will also have issues. PhotoMode is one such example so disabling codes that use that library is also important.

6. Save Hedge mod manager and close it.

7. Copy the contents from the default Codes.hmm file into your new Codes.hmm file.

8. Enable whichever codes you want and then repeat step 5.

Alternatively, if you want to take the nuclear option and you don't want any codes (keep in mind that some mods enable their features with codes) you can delete the Codes.dll file in your SonicFrontiers/mods folder. Just be sure after doing this that you launch the game through steam and not hedge mod manager as doing so will recreate the dll file

An easy mod to test this with is the Vanilla + Experience mod

[github-actions]

This issue is stale because it has been open for 30 days with no activity. Please comment on this issue if you don't want it to automatically close in 14 days.

[github-actions]

This issue was closed because it has been inactive for 14 days since being marked as stale.