[Runtime Issue]: Unable to set temporary directory to a path that contains Japanese characters

Jayman2000 commented 1 week ago

Build Version

v1.5 de75a80ae7564563961c4635ef839fce70944a4c

Operating System Environment

[ ] Microsoft Windows (32-bit)
[X] Microsoft Windows (64-bit)
[ ] Mac OS X
[ ] Linux (specify distribution and version below)

CPU Environment

[ ] x86 (32-bit Intel/AMD)
[X] x86_64 (64-bit Intel/AMD)
[ ] ARM (32-bit)
[ ] ARM64 (64-bit; sometimes called AArch64)
[ ] Other (RISC V, PPC...)

Game Modes Affected

[X] Single player
[X] Anarchy
[X] Hyper-Anarchy
[X] Robo-Anarchy
[X] Team Anarchy
[X] Capture the Flag
[X] Bounty
[X] Entropy
[X] Hoard
[X] Monsterball
[X] Cooperative

Game Environment

I’m using game data from the US Windows Dual-Jewel version of Descent 3 v1.4.

Description

If Descent3.exe is stored in a directory that has Japanese characters in its name, then it will immediately crash if you try launching it:

$Descent 3 Error&NewLine;Error: Unable to set temporary directory to: "D:\VC\Partially mine\Descent3\Encoding bug test\ディセント3\custom\cache"&NewLine;&NewLine;&NewLine;Press OK to exit, CANCEL to ignore this error and continue.$

If you press “Cancel”, then the game will try to continue, but it will immediately give you another similar error. That second error does not give you an option to continue.

You can workaround this problem by enabling Windows’s “Beta: Use Unicode UTF-8 for worldwide language support” setting.

Regression Status

Last commit that doesn’t have this problem: 9263055e730c381b7b2fb9fb32d7cea439daddc2 First commit that does have this problem: 82084e9176bdc36d2c88ec7caab1a0ed69769c25

Steps to Reproduce

Set your system locale to a non-Unicode Japanese locale.
1. Go to Windows Settings > Time & language > Language & region > Administrative language settings > Change system locale.
2. Make sure that “Beta: Use Unicode UTF-8 for worldwide language support” is unchecked.
3. In the “Current system locale” dropdown box, select “Japanese (Japan)”.
4. Click “OK”.
5. Reboot.
Follow the README’s build instructions.
Create a D3-open-source folder with the required files and folders (See the README’s usage section for details).
Try running Descent3.exe. You should be able to get to the title screen without any errors.
Rename the D3-open-source folder to ディセント3.
Try running Descent3.exe. Before the Dolby ad starts, you’ll get an error about not being able to set the working directory to ディセント3\custom\cache.

Lgt2x commented 1 week ago

Make sure that “Beta: Use Unicode UTF-8 for worldwide language support” is unchecked.

Any reason you'd want to do that with a locale like japanese? Does checking this box fix the issue?

Jayman2000 commented 1 week ago

Any reason you'd want to do that with a locale like japanese?

I don’t really know for sure if there are any reasons why you would want to check that box or uncheck that box. I think that checking that box will break some legacy applications that require code page 932, but I haven’t tested that out on Windows. I have run Japanese applications in Wine before, and I’ve had to switch off of my default UTF-8 locale because the application wasn’t working properly. If you want, I can try some of those same applications on Windows to see if that checkbox breaks anything.

That being said, here’s what I do know for sure:

You have to reboot in order to change that setting. Imagine if a user had some applications on their system that required that box to be checked and other applications that required that box to be unchecked. It would be annoying to have to reboot just to open a different application.
That checkbox is for an obscure beta feature. It would be better if Descent 3 didn’t sometimes require that users enabled an obscure beta feature.
That checkbox is unchecked by default. It would be better if Descent 3 didn’t sometimes require you to manually change a Windows setting.
That checkbox is mainly meant for applications that don’t support Unicode properly. The Region Settings window says “Select which language (system locale) to use when displaying text in programs that do not support Unicode.” If an application supports Unicode properly (i.e., by using the -W APIs or making sure that the Windows code page is set to 65001), then the system locale settings won’t affect the application. It would be better if Descent 3 supported Unicode properly.

Does checking this box fix the issue?

Yes. As I wrote previously,

You can workaround this problem by enabling Windows’s “Beta: Use Unicode UTF-8 for worldwide language support” setting.

Lgt2x commented 1 week ago

Thanks for your reply. Don't hesitate to open a PR with a fix if you can while you have a setup ready for reproduction.

winterheart commented 4 days ago

Adding platform-conditional _wfopen() handling should fix this issue.

DescentDevelopers / Descent3