DFHack / dfhack

Memory hacking library for Dwarf Fortress and a set of tools that use it
Other
1.84k stars 462 forks source link

dfhack sometimes interferes with streaming using OBS #3077

Open ab9rf opened 1 year ago

ab9rf commented 1 year ago

I have a report from one streamer that adding DFHack to their DF install interfered with OBS connecting with the DF window. I suspect this is related to the full-screen window combined with the DFHack console. It's unusual for a full-screen app to also have a separate console window, and this may be confusing OBS.

While I do not think this is a DFHack bug, it would be worthwhile for us to provide some documentation or other advice to people on how to avoid this problem and other problems like it.

myk002 commented 1 year ago

The advice I've been posting for Steam Deck users, who have similar difficulties with the DFHack console window confusing the system, is to add hide to dfhack-config/init/dfhack.init. Would that advice work for OBS users as well?

myk002 commented 1 year ago

this may become a moot point if we decide to do away with the DFHack console as part of #2935

ab9rf commented 1 year ago

It turns out that it's due to DF using full screen windows and the way OBS captures them. I'll write up a small document with advice for people who are using OBS to stream DF (basically, the advice is "use windowed mode because OBS cannot window-capture a full-screen window"). My understanding is that the SDL2 migration will also mean DF will use (at least optionally) use a borderless window instead of a full-screen window, which will obviate this entire issue.

I'll experiment with using "hide" to hide the dfhack window but note that some tools (notably, tiletypes) cannot be used without the console window.