Add Steam Integration Options Nitrox: Big Picture and Steam Overlay by Kiaos · Pull Request #2524 · SubnauticaNitrox/Nitrox

Kiaos · 2025-10-14T06:18:25Z

Add Steam Integration Options Nitrox: Big Picture and Steam Overlay

🔗 Related Issue

Steam Integration Options - for future OSK (On Screen Keyboard) support

📋 Problem Summary

Steam Deck users cannot use the on-screen keyboard (OSK) properly with Nitrox due to missing Steam integration options. This creates accessibility issues for handheld gaming and controller-only setups.

🎯 Solution Overview

This PR adds optional Steam integration toggles to the Nitrox launcher options menu, enabling proper Steam Deck OSK functionality while maintaining full backward compatibility.

✅ Features Added

1. Steam Overlay Toggle

Purpose: Enable Steam overlay for API integration and potential OSK support
Default: OFF (preserves existing behavior)
Impact: Changes launch method from direct .exe to steam -applaunch when enabled

2. Big Picture Mode Toggle

Purpose: Enable Big Picture mode for reliable controller OSK functionality
Default: OFF (desktop-first experience)
Impact: Two-stage launch (Big Picture interface first, then game)

3. Configuration Persistence

Storage: Uses existing nitrox.cfg file system
Keys: IsSteamOverlayEnabled, IsBigPictureModeEnabled
Rationale: Consistent with existing launcher settings storage

🔧 Technical Implementation

Files Modified:

KeyValueStoreExtensions.cs - Added Steam option accessors with comprehensive documentation
OptionsViewModel.cs - Added UI properties and change handlers for Steam settings
OptionsView.axaml - Added Steam integration toggles with detailed user tooltips
ConfigFileKeyValueStore.cs - Added default initialization for Steam settings (all OFF)
LaunchGameViewModel.cs - Enhanced Steam launch logic with Big Picture mode support
Steam.cs - Added Big Picture mode integration and overlay environment variables

Key Design Principles:

Backward Compatible: All Steam features disabled by default
Opt-in Only: Users must explicitly enable Steam integration features
Comprehensive Documentation: Detailed comments explaining every feature and technical decision
User-Friendly: Clear tooltips and descriptions in the options UI

🎮 Target Use Cases

Primary: Steam Deck users needing OSK for multiplayer server passwords/usernames
Secondary: Controller users requiring text input capabilities
Future: GameScope integration testing and development

🧪 Testing Performed

✅ Build succeeds with no errors or new warnings
✅ All Steam features disabled by default (backward compatibility)
✅ Options UI displays Steam toggles correctly with proper tooltips
✅ Settings persist correctly in nitrox.cfg
✅ Standard game launch unchanged when Steam features disabled

📚 Documentation Added

STEAM_INTEGRATION_FORK_RATIONALE.md - Detailed explanation of Steam Deck OSK issues
STEAM_OPTIONS_DOCUMENTATION.md - Comprehensive user and developer guide
Extensive inline code documentation with XML comments
Enhanced UI tooltips explaining Steam integration benefits

🔄 Backward Compatibility

✅ No Breaking Changes: All existing functionality preserved
✅ Default Behavior: New Steam features OFF by default
✅ Existing Users: No impact on current installations
✅ Configuration: Graceful handling of missing config keys

🚀 Future Considerations

This implementation provides the foundation for:

Advanced Steam API integration
GameScope optimization for Steam Deck gaming mode
Enhanced Steam Input customization features
Potential OSK implementation improvements

📝 Notes for Reviewers

This PR focuses solely on options menu integration - no OSK implementation included
All Steam features are opt-in only with conservative defaults
Documentation explains why each feature is needed for Steam Deck OSK functionality
Implementation extends existing architecture patterns (KeyValueStore, OptionsViewModel)

Review Focus Areas:

Backward compatibility verification
Documentation clarity and completeness
UI/UX of new Steam integration options
Configuration persistence and default handling

Kiaos · 2025-10-14T06:56:42Z

Btw this works fine someone build it and test it please. My other fork is a mess.

Kiaos · 2025-10-14T13:57:49Z

Now those pesky comments are gone you can test the feature.

Kiaos · 2025-10-14T14:54:32Z

I did a major clean up of commit history. BTW this was my first time doing this so I made alot of errors. This should be simple and easy to setup without all that ai jank that was added to explain everything.

OhmV-IR

overall, this is a bit of a mess. you have a lot of duplicated code, eg redundant checks in Update() and multiple methods like SelectItem(), SelectItemInDirection(), FocusPasswordField() .etc, and you're often catching exceptions and rethrowing them when they should be allowed to bubble up instead, since they are not recoverable.

Nitrox.Launcher/ViewModels/LaunchGameViewModel.cs

Nitrox.Launcher/Views/OptionsView.axaml

NitroxClient/MonoBehaviours/Gui/MainMenu/ServerJoin/MainMenuJoinServerPanel.cs

NitroxModel/Platforms/OS/Shared/ConfigFileKeyValueStore.cs

NitroxModel/Platforms/Store/Steam.cs

Kiaos · 2025-10-14T16:06:29Z

Ok well i will go through all of this i think the last commit did fix some of this. But i will go over everything you mentioned.

This commit addresses all 10 concerns raised by reviewer OhmV-IR on PR SubnauticaNitrox#2524: 1. ✅ Removed OSK implementation scope creep - Removed MainMenuJoinServerPanel.cs OSK code (180+ lines) - Removed MainMenuEnterPasswordPanel.cs OSK code (179+ lines) - This functionality belongs in a separate PR, not in Steam options PR 2. ✅ Removed unreliable Steam Deck detection methods - Removed IsHandheldOrControllerPreferred() method - Removed IsGameFromSteam() method - These used unreliable checks (SteamAppId env var never set by launcher, /home/deck/.steampid false positives) 3. ✅ Simplified ShouldSkipSteam() logic - Now only checks user-controlled toggle options - Removed automatic Steam Deck detection - Cleaner, predictable behavior based on user settings 4. ✅ Removed hard-coded 5-second delay - Removed Task.Delay(5000) from LaunchWithBigPictureMode - Also removed configurable delay via nitrox.cfg - Launcher now responds immediately 5. ✅ Removed catch-rethrow anti-pattern - Removed outer try-catch that was catching and rethrowing - Let exceptions bubble up naturally for proper stack traces 6. ✅ Removed InitializeDefaultSettings method - Removed explicit default value initialization - Defaults now handled by getters as designed - Prevents issues when defaults change in future updates 7. ✅ Removed EnsureSteamAppIdFile method - No longer creates steam_appid.txt in game directory - Follows "no remnants" principle - Game directory stays clean 8. ✅ Fixed "for better performance" tooltip - Removed misleading performance claim from multiple instances tooltip - Now simply states the feature disables Steam integration 9. ✅ Fixed Big Picture mode tooltip - Changed from vague "TV/couch gaming" to specific "Launch Subnautica in Steam Big Picture mode" - Clear and accurate description 10. ✅ Kept core functionality working - Steam overlay toggle still functional - Big Picture mode toggle still functional - nitrox.cfg persistence still working - All builds successfully This PR now focuses solely on adding launcher options for Steam integration without scope creep or unreliable detection methods.

Kiaos

So I removed alot of the osk stuff since i plan on doing a fork for that issue latter. The things that i removed was lots of osk and steam deck relatted stuff I removed the big picutre delay and it worked just fine. I removed the app id file method.

Fixed the tool tips made them super simple for the options.

NitroxModel/Platforms/OS/Shared/ConfigFileKeyValueStore.cs

NitroxModel/Platforms/Store/Steam.cs

- Add Steam overlay toggle option in launcher settings - Add Big Picture mode disable option for better compatibility - Persist Steam settings in nitrox.cfg configuration file - Restore main menu panels to original state (removed OSK modifications) - Add proper configuration accessors for Steam-related settings These options help resolve Steam Deck OSK conflicts and provide better Steam integration control for users.

This commit addresses all 10 concerns raised by reviewer OhmV-IR on PR SubnauticaNitrox#2524: 1. ✅ Removed OSK implementation scope creep - Removed MainMenuJoinServerPanel.cs OSK code (180+ lines) - Removed MainMenuEnterPasswordPanel.cs OSK code (179+ lines) - This functionality belongs in a separate PR, not in Steam options PR 2. ✅ Removed unreliable Steam Deck detection methods - Removed IsHandheldOrControllerPreferred() method - Removed IsGameFromSteam() method - These used unreliable checks (SteamAppId env var never set by launcher, /home/deck/.steampid false positives) 3. ✅ Simplified ShouldSkipSteam() logic - Now only checks user-controlled toggle options - Removed automatic Steam Deck detection - Cleaner, predictable behavior based on user settings 4. ✅ Removed hard-coded 5-second delay - Removed Task.Delay(5000) from LaunchWithBigPictureMode - Also removed configurable delay via nitrox.cfg - Launcher now responds immediately 5. ✅ Removed catch-rethrow anti-pattern - Removed outer try-catch that was catching and rethrowing - Let exceptions bubble up naturally for proper stack traces 6. ✅ Removed InitializeDefaultSettings method - Removed explicit default value initialization - Defaults now handled by getters as designed - Prevents issues when defaults change in future updates 7. ✅ Removed EnsureSteamAppIdFile method - No longer creates steam_appid.txt in game directory - Follows "no remnants" principle - Game directory stays clean 8. ✅ Fixed "for better performance" tooltip - Removed misleading performance claim from multiple instances tooltip - Now simply states the feature disables Steam integration 9. ✅ Fixed Big Picture mode tooltip - Changed from vague "TV/couch gaming" to specific "Launch Subnautica in Steam Big Picture mode" - Clear and accurate description 10. ✅ Kept core functionality working - Steam overlay toggle still functional - Big Picture mode toggle still functional - nitrox.cfg persistence still working - All builds successfully This PR now focuses solely on adding launcher options for Steam integration without scope creep or unreliable detection methods.

- Add Steam overlay toggle to launcher options (STEAM_OVERLAY=1 when enabled) - Add Big Picture mode toggle for dedicated Steam interface launch - Implement persistent settings storage in nitrox.cfg - Update Steam.cs StartGameAsync method with default parameters - Add UI properties and data binding in OptionsViewModel - Update LaunchGameViewModel to handle Steam launch options - Add KeyValueStoreExtensions for Steam settings access - Correct comments and remove unnecessary code per reviewer feedback - Ensure proper architecture with separation of concerns

- OptionsViewModel.cs: 755 → 644 - KeyValueStoreExtensions.cs: 755 → 644 - C# source files should not be executable

OhmV-IR

getting there

Nitrox.Launcher/ViewModels/OptionsViewModel.cs

Nitrox.Launcher/ViewModels/LaunchGameViewModel.cs

.gitignore

NitroxModel/Platforms/Store/Steam.cs

- Move Big Picture interface launching logic from LaunchGameViewModel to Steam.StartGameAsync - Pass bigPictureMode boolean parameter to Steam.StartGameAsync instead of separate handling - Remove LaunchWithBigPictureMode method from LaunchGameViewModel - Maintain existing Big Picture functionality while improving code organization

- Modify Steam.StartGameAsync to accept IKeyValueStore parameter - Move Big Picture mode checking and handling entirely within Steam platform - Remove Big Picture logic from LaunchGameViewModel.ShouldSkipSteam - Steam now internally checks Big Picture setting and forces skipSteam=false when enabled - Improves encapsulation by keeping Steam-specific logic within the Steam class

- Remove outdated comment that was hard to maintain - Developers can search for SteamAppId if needed - Keeps code cleaner and more maintainable

- Remove *.dxvk-cache entry that was accidentally added - Remove any tracked .dxvk-cache files from version control - These files are build artifacts and don't belong in the repository

- Remove unnecessary steamArgs variable in CreateSteamGameStartInfo - Reassign args directly instead of creating new variable - Cleaner and more concise code without losing functionality

- Remove overly verbose comment block about Big Picture mode enhancement - Keep the more specific comment inside the if statement that explains the -silent flag - Cleaner code with better-focused documentation

Nitrox.Launcher/Models/Extensions/KeyValueStoreExtensions.cs

Nitrox.Launcher/ViewModels/OptionsViewModel.cs

Nitrox.Launcher/Views/OptionsView.axaml

… changes

Nitrox.Launcher/Views/OptionsView.axaml

Nitrox.Model/Platforms/Store/Steam.cs

This commit addresses all 10 concerns raised by reviewer OhmV-IR on PR SubnauticaNitrox#2524: 1. ✅ Removed OSK implementation scope creep - Removed MainMenuJoinServerPanel.cs OSK code (180+ lines) - Removed MainMenuEnterPasswordPanel.cs OSK code (179+ lines) - This functionality belongs in a separate PR, not in Steam options PR 2. ✅ Removed unreliable Steam Deck detection methods - Removed IsHandheldOrControllerPreferred() method - Removed IsGameFromSteam() method - These used unreliable checks (SteamAppId env var never set by launcher, /home/deck/.steampid false positives) 3. ✅ Simplified ShouldSkipSteam() logic - Now only checks user-controlled toggle options - Removed automatic Steam Deck detection - Cleaner, predictable behavior based on user settings 4. ✅ Removed hard-coded 5-second delay - Removed Task.Delay(5000) from LaunchWithBigPictureMode - Also removed configurable delay via nitrox.cfg - Launcher now responds immediately 5. ✅ Removed catch-rethrow anti-pattern - Removed outer try-catch that was catching and rethrowing - Let exceptions bubble up naturally for proper stack traces 6. ✅ Removed InitializeDefaultSettings method - Removed explicit default value initialization - Defaults now handled by getters as designed - Prevents issues when defaults change in future updates 7. ✅ Removed EnsureSteamAppIdFile method - No longer creates steam_appid.txt in game directory - Follows "no remnants" principle - Game directory stays clean 8. ✅ Fixed "for better performance" tooltip - Removed misleading performance claim from multiple instances tooltip - Now simply states the feature disables Steam integration 9. ✅ Fixed Big Picture mode tooltip - Changed from vague "TV/couch gaming" to specific "Launch Subnautica in Steam Big Picture mode" - Clear and accurate description 10. ✅ Kept core functionality working - Steam overlay toggle still functional - Big Picture mode toggle still functional - nitrox.cfg persistence still working - All builds successfully This PR now focuses solely on adding launcher options for Steam integration without scope creep or unreliable detection methods.

- Fix critical Big Picture launch exception handling bug where catch blocks were unreachable - Combine Big Picture and Steam startup logic to avoid launching Steam multiple times - Add detailed comments explaining the 1-second delay to prevent focus stealing issues - Remove redundant 'Launching Steam Big Picture interface...' log message - Fix ShouldSkipSteam default logic to use Steam by default, only skip for special cases - Improve error handling and logging consistency throughout Big Picture launch flow - Restructure code with separate try-catch blocks for better organization and maintainability This addresses all reviewer feedback from PR SubnauticaNitrox#2524, ensuring reliable Steam overlay and Big Picture functionality with proper error handling and clean code structure.

Kiaos · 2025-10-15T22:57:06Z

ok i added latest commits and its now in parity with master.

Addresses NinjaPedroX review comment: Show Big Picture mode option but disable it when selected game platform is not Steam, preventing user confusion while still indicating the feature exists.

…ot steam platform

…egration-options

This comment was marked as off-topic.

Sign in to view

Kiaos force-pushed the feature/steam-integration-options branch from b32c201 to ba5b61b Compare October 14, 2025 14:52

OhmV-IR suggested changes Oct 14, 2025

View reviewed changes

Kiaos commented Oct 14, 2025

View reviewed changes

Kiaos changed the title ~~Add Steam Integration Options for Steam Deck OSK Support~~ Add Steam Integration Options Nitrox: Big Picture and Steam Overlay Oct 14, 2025

Kiaos requested a review from OhmV-IR October 15, 2025 01:29

Kiaos marked this pull request as draft October 15, 2025 03:06

OhmV-IR suggested changes Oct 15, 2025

View reviewed changes

Kiaos requested a review from OhmV-IR October 15, 2025 16:43

Kiaos force-pushed the feature/steam-integration-options branch from 7be2c00 to cf6f861 Compare October 15, 2025 16:58

Kiaos added 4 commits October 15, 2025 10:59

fix: Remove executable permissions from C# source files

2b39bd6

- OptionsViewModel.cs: 755 → 644 - KeyValueStoreExtensions.cs: 755 → 644 - C# source files should not be executable

Kiaos force-pushed the feature/steam-integration-options branch from cf6f861 to 2b39bd6 Compare October 15, 2025 16:59

OhmV-IR suggested changes Oct 15, 2025

View reviewed changes

Nitrox.Launcher/ViewModels/OptionsViewModel.cs Outdated Show resolved Hide resolved

Nitrox.Launcher/ViewModels/LaunchGameViewModel.cs Outdated Show resolved Hide resolved

Measurity reviewed Oct 15, 2025

View reviewed changes

Kiaos and others added 8 commits October 15, 2025 11:04

fix: Remove irrelevant UI theme comment from OptionsViewModel

3942e8d

refactor: Remove unnecessary comment about SteamAppId assignment

b8ad7a6

- Remove outdated comment that was hard to maintain - Developers can search for SteamAppId if needed - Keeps code cleaner and more maintainable

fix: Remove unintentional .dxvk-cache from .gitignore

0ded9e6

- Remove *.dxvk-cache entry that was accidentally added - Remove any tracked .dxvk-cache files from version control - These files are build artifacts and don't belong in the repository

refactor: Simplify Steam args handling by reusing args variable

1749f81

- Remove unnecessary steamArgs variable in CreateSteamGameStartInfo - Reassign args directly instead of creating new variable - Cleaner and more concise code without losing functionality

refactor: Remove wordy Big Picture mode comment

0ab7fb2

- Remove overly verbose comment block about Big Picture mode enhancement - Keep the more specific comment inside the if statement that explains the -silent flag - Cleaner code with better-focused documentation

Passed bigPictureMode to steam launch args instead of keyvaluestore

3b88945

Measurity approved these changes Oct 15, 2025

View reviewed changes

Fixed big picture mode not starting if steam is busy starting up

95cfa3c

NinjaPedroX suggested changes Oct 15, 2025

View reviewed changes

Measurity added 3 commits October 15, 2025 23:33

Removed steam overlay option, again

608d0d3

Hidden Steam related settings if Steam platform not selected.

967b007

Fixed platform icon in options not immediately updating when platform…

d395f01

… changes

NinjaPedroX suggested changes Oct 15, 2025

View reviewed changes

Nitrox.Launcher/Views/OptionsView.axaml Outdated Show resolved Hide resolved

Kiaos requested a review from NinjaPedroX October 15, 2025 22:04

NinjaPedroX approved these changes Oct 15, 2025

View reviewed changes

Coding-Hen reviewed Oct 15, 2025

View reviewed changes

Nitrox.Model/Platforms/Store/Steam.cs Show resolved Hide resolved

Fixed RecolorImage not updating when its source changes

f8921c3

Kiaos requested review from Coding-Hen and NinjaPedroX October 15, 2025 22:44

Kiaos force-pushed the feature/steam-integration-options branch from f8921c3 to d078725 Compare October 15, 2025 22:53

Measurity force-pushed the feature/steam-integration-options branch from d078725 to f8921c3 Compare October 15, 2025 23:04

Kiaos and others added 3 commits October 15, 2025 18:54

fix: Disable Big Picture mode checkbox when not using Steam platform

547ce11

Addresses NinjaPedroX review comment: Show Big Picture mode option but disable it when selected game platform is not Steam, preventing user confusion while still indicating the feature exists.

fix: Remove executable permissions from C# source files

28d92f9

Changed UseBigPictureMode to turn InVisible instead of enabled when n…

a745171

…ot steam platform

Kiaos closed this Oct 20, 2025

Kiaos deleted the feature/steam-integration-options branch October 20, 2025 18:45

Kiaos restored the feature/steam-integration-options branch October 20, 2025 18:48

Measurity reopened this Oct 20, 2025

Measurity force-pushed the feature/steam-integration-options branch from 64383f1 to a745171 Compare October 20, 2025 18:55

Merge remote-tracking branch 'upstream/master' into feature/steam-int…

faa0f08

…egration-options

Measurity merged commit 7198539 into SubnauticaNitrox:master Oct 22, 2025

Kiaos deleted the feature/steam-integration-options branch October 22, 2025 19:38

Kiaos mentioned this pull request Dec 22, 2025

Steam Integration Options - for future OSK (On Screen Keyboard) support #2523

Closed

Conversation

Kiaos commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Add Steam Integration Options Nitrox: Big Picture and Steam Overlay

🔗 Related Issue

📋 Problem Summary

🎯 Solution Overview

✅ Features Added

1. Steam Overlay Toggle

2. Big Picture Mode Toggle

3. Configuration Persistence

🔧 Technical Implementation

Files Modified:

Key Design Principles:

🎮 Target Use Cases

🧪 Testing Performed

📚 Documentation Added

🔄 Backward Compatibility

🚀 Future Considerations

📝 Notes for Reviewers

Uh oh!

This comment was marked as off-topic.

Kiaos commented Oct 14, 2025

Uh oh!

Kiaos commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Kiaos commented Oct 14, 2025

Uh oh!

OhmV-IR left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Kiaos commented Oct 14, 2025

Uh oh!

Kiaos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

OhmV-IR left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Kiaos commented Oct 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Kiaos commented Oct 14, 2025 •

edited

Loading

Kiaos commented Oct 14, 2025 •

edited

Loading