FAQ

English | 日本語

For players

Do I have to download the framework? Usually not. The mods that need it install it for you. See For players.

How do I know it's installed? The title screen shows "Drag'n Wash ModFramework <version>" and the number of loaded mods above the build number.

I switched a mod off but it still runs. Switching a mod on or off only takes effect the next time the game starts.

The game crashes on Windows. Since framework 1.3.0, a window opens after the crash and tells you what happened, and the report stays in BepInEx/CrashReports (Crash reports). It's also worth checking BepInEx/LogOutput.log. On Windows on ARM, add -force-d3d11 to the launch options. To find out whether a particular mod causes it, switch mods off one at a time.

How do I open the F1 window, or turn on the Inspector? Turn on Developer tools (Options → Mods → Drag'n Wash ModFramework → Developer tools), and then F1 opens the tool window. The Inspector isn't in the installers that mods ship (Drag'n Wash Localization leaves it out), so copy the BepInEx/plugins/DragNWash.ModFramework.Inspector folder from the framework's release zip into the game's BepInEx/plugins. Inspector goes through it step by step.

The game freezes after I switch to another window and come back. This happens on DirectX 12 with Window Mode set to Exclusive, and mods don't cause it. The game's graphics code gets stuck while Windows leaves or re-enters exclusive fullscreen. Add -force-d3d11 to the launch options (tested, it works), or use Fullscreen instead of Exclusive. There's more in Drag'n Wash Localization's README.

Does it work on the Steam Deck? Yes, with the Linux build of BepInEx. The Mods screen and the F1 window work with the controls and trackpad.

Does it work on macOS? Experimentally, yes. The Doorstop in BepInEx's current release can't hook the game's Unity 6.3 on macOS yet. UnityDoorstop has fixed that, but the fix isn't in a release yet. Until then, Drag'n Wash Localization has an experimental install script that puts in the fixed build and runs the game under Rosetta: see the macOS note in its README. On macOS, the Tool window (F1) shows its text from ModFramework 1.6.0. Progress is tracked in #85.

Does it change my game files? No. BepInEx loads mods while the game runs. Verifying the game files in Steam doesn't remove BepInEx or mods, and uninstalling mods leaves the game as it was.

Is it official? No. It's an unofficial fan project and isn't affiliated with Gator Dragon Games.

For mod authors

Why must I load textures in Awake? On Direct3D 12, this Unity version can crash if a texture or font atlas is uploaded while a frame is being presented (UUM-140564). See Assets.

Can I still use Harmony? Yes, for game code the framework doesn't cover. Check the target with GameHooks.Require first, and don't patch anything the framework already hooks (Playing well with others).

Will my mod break when the framework updates? Not within a major version. Since 1.0.0, breaking changes to a public API only come with 2.0.0, and each library has its own version number. See CHANGELOG.md.

Will my mod break when the game updates? Less often. The framework keeps its own hooks up to date with game changes. For your own patches, use GameHooks.Require, so a missing method turns off one feature instead of crashing the game. The game builds we've checked are listed in GAME_BUILDS.md.

Can I ship the framework with my mod? Yes, it's MIT licensed. Ship the release's files unchanged, and have your installer skip them when a newer version is already installed. Drag'n Wash Localization's installers do exactly that.

Can I use the game's text or images in my repository? No. Refer to dialogue by line ID, and let players provide anything that comes from the game.

Where do I ask? Ask in Issues on GitHub.