Add documentation for flag flipping

[ghostnaps]

First of all, thanks so much for the efforts put into this project to get it operational! After a lot of trial and error I managed to get Jest working with run-in-roblox, but this was quite challenging even for someone that actively deals with flags haha

My 2c: Documentation mentions flipping FFlagEnableLoadModule, but does not supply instructions for how. It would be great to include docs for how to do this on Windows and MacOS.

For Windows, explaining how to navigate to the appropriate version of Roblox Studio in Program Files, and creating the necessary ClientAppSettings.json file. It seems like there's some good info for this online already, so I don't expect Windows users to have as much of a problem, but still good to document

For MacOS, it took me a while to realize that ~/Library/Roblox/ClientSettings is not the correct place for this, and that I had to navigate to Applications/RobloxStudio.app/Contents/MacOS and manually create ClientSettings with ClientAppSettings.json inside it.

I now run a couple commands to do this for me:

mkdir -p /Applications/RobloxStudio.app/Contents/MacOS/ClientSettings
cp -R scripts/ClientAppSettings.json /Applications/RobloxStudio.app/Contents/MacOS/ClientSettings

[MythicalMayhem]

for windows users,

@echo off

set "versions=%LocalAppData%\Roblox\Versions"

for /d %%v in ("%versions%\version-*")  do (
	if exist %%v\RobloxStudioBeta.exe (
		set "version=%%v"
		goto unloop
	)

	echo %%v
)

echo unfound

:unloop

echo %version%





set "targetfile=%version%\ClientSettings\ClientAppSettings.json"

if exist %targetfile% (
	echo delete old config ? ....
	del /P %targetfile%
)

echo.>  %targetfile%
echo { "FFlagEnableLoadModule": true }  > %targetfile%

echo success :3

C:\Windows\System32\attrib +r %targetfile% 

[westurner]

How to flip flags in Roblox Studio with Linux and WINE

Vinegar is a Roblox Studio installer which can be installed as a package, a flatpak, or from source. This is the flatpak configuration:

• Flatpak vinegar:
  $WINEPREFIX/drive_c/users/steamuser/AppData/Local/Roblox/ClientSettings/StudioAppSettings.json doesn't seem to work, presumably because of versions/version-${versionid}:

  cat ~/.var/app/org.vinegarhq.Vinegar/data/vinegar/prefixes/studio/drive_c/users/steamuser/AppData/Local/Roblox/ClientSettings/StudioAppSettings.json \
  | jq '.' | grep FFlagEnableLoadModule

• Flatpak vinegar:
  versions/version-${versionid}/ClientSettings/ClientAppSettings.json does work:

  • cat ~/.var/app/org.vinegarhq.Vinegar/data/vinegar/versions/version-7f0f7a0cd81f40a8/ClientSettings/ClientAppSettings.json \
    | jq '.' | grep FFlagEnableLoadModule

  • | jq '.FFlagEnableLoadModule' but jq wont't modify in place
  • vinegar config supports setting fflags like this;
    vinegar copies from [studio.fflags] in ~/.config/vinegar/config.toml into versions/version-${versionid}/ClientSettings/ClientAppSettings.json

    ## ~/.config/vinegar/config.toml
    # This enables dxvk:
    # dxvk=true
    
    # This machine has an iGPU and an NVIDIA dGPU:
    # gpu="prime-discrete"
    
    # FFlagEnableLoadModule is necessary for jest-lua tests to run
    # until https://github.com/Roblox/jest-roblox/blob/master/CHANGELOG.md#3100-2024-10-02 is merged into jsdotlua/jest-lua IIUC:
    [studio.fflags]
    FFlagEnableLoadModule=true

    • https://vinegarhq.org/Configuration/#example-configuration

• RPM vinegar also copies [studio.fflags] from ~/.config/vinegar/config.toml, but to a different path:

  • cat ~/.local/share/vinegar/versions/version-7f0f7a0cd81f40a8/ClientSettings/ClientAppSettings.json

• Also, The roblox-install package locates the RobloxStudio.exe binary on mac and windows (with a pr for wsl) but not yet on linux e.g. with vinegar:

  • https://github.com/rojo-rbx/run-in-roblox
    • https://github.com/westurner/roblox-install/blob/master/src/lib.rs