Skip to content

Split the game config into PC and Xbox files - #38

Merged
Joel Baker (XBOX) (joelbaker-xbox) merged 1 commit into
mainfrom
user/joelbaker/split-game-configs
Nov 18, 2026
Merged

Joel Baker (XBOX) (joelbaker-xbox) merged 1 commit into
mainfrom
user/joelbaker/split-game-configs

Conversation

@joelbaker-xbox

Copy link
Copy Markdown
Contributor

The PC and Xbox exports shared one MicrosoftGame.config that declared both executables, and the console preset did not name a metadata folder, so a console package could not find its logos. This change gives each target its own config and makes loose and package exports work for both targets without editing staged files.

Changes

  • MicrosoftGame.config at the root is now PC-only. It declares NetRumblePC.exe and keeps DesktopRegistration.
  • New xbox/MicrosoftGame.config declares only NetRumbleConsole.exe, has no DesktopRegistration and uses bare logo names. An empty .gdignore keeps Godot from importing the folder. The logos stay in the shared storelogos/ folder.
  • The Xbox Series X|S preset sets application/game_config="xbox/MicrosoftGame.config" and packaging/metadata_folder="storelogos". Both presets stay loose with no key.
  • tools/common.ps1 finds each target's config and reads Loose or Package mode from a preset.
  • tools/export.ps1 checks for the loose layout, or in package mode for an .msixvc or .xvc written during the current run.
  • deploy-pc.ps1 and deploy-console.ps1 stop when their preset is set to package output.
  • tools/check-game-config.ps1 checks both configs. It fails when their shared identity, store, title, display or service values drift, a logo does not resolve, or a committed preset names a key or package output. -Path still checks a single file. check-deport.ps1 also scans the Xbox config.
  • docs/configuration.md explains how to build each of the four outputs: PC loose, PC package, Xbox loose and Xbox package.

Testing

Each build ran from a clean output folder. Package builds used a temporary key outside the repository and a temporary preset change, both removed afterward.

  • PC loose (deploy-pc.ps1 -Clean): the staged config declares only NetRumblePC.exe, all logos resolve, and wdapp registered the build.
  • PC package (export.ps1 -Target pc -Clean): makepkg created the .msixvc with NetRumblePC.exe.
  • Xbox loose (export.ps1 -Target console -Clean): the layout has the expected files and folder layout. The staged config declares only NetRumbleConsole.exe.
  • Xbox package (export.ps1 -Target console -Clean): makepkg created the .xvc with NetRumbleConsole.exe
  • check-game-config.ps1 passed and caught each drift case in negative tests. check-deport.ps1 -Detailed passed.

The PC and Xbox exports shared one MicrosoftGame.config that declared
both executables, and the console preset did not name a metadata
folder, so a console package could not find its logos.

- MicrosoftGame.config at the root is now PC-only. It declares
  NetRumblePC.exe and keeps DesktopRegistration.
- New xbox/MicrosoftGame.config declares only NetRumbleConsole.exe,
  has no DesktopRegistration and uses bare logo names. An empty
  .gdignore keeps Godot from importing the folder.
- The console preset names the Xbox config and uses storelogos as its
  metadata folder. Both presets stay loose with no key.
- common.ps1 finds each target's config and reads Loose or Package
  mode from a preset.
- export.ps1 checks for the loose layout, or in package mode for an
  .msixvc or .xvc written during the current run.
- deploy-pc.ps1 and deploy-console.ps1 stop when their preset is set
  to package output.
- check-game-config.ps1 checks both configs. It fails when their shared
  values drift, a logo does not resolve, or a committed preset names a
  key or package output. -Path still checks a single file.
- check-deport.ps1 also scans the Xbox config.
- The docs explain how to build PC loose, PC package, Xbox loose and
  Xbox package outputs.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues remain for the target-specific configuration and export-tooling changes.

No open issues 🎉

What changed in this PR

Separates PC and Xbox game configuration so each export uses the correct executable and logo paths, while extending the build tools to support loose layouts and packages.

Changes:

  • Splits the shared config into target-specific files and connects the Xbox preset to shared logo assets.
  • Adds mode-aware export validation and prevents loose deployment scripts from handling package output.
  • Expands configuration checks and documents all four build outputs.
File Description
xbox/​MicrosoftGame.config Adds the Xbox-only config with bare logo filenames.
xbox/​.gdignore Excludes the Xbox config folder from Godot imports.
tools/​repository-checks.md Documents dual-config validation and single-file checks.
tools/​README.md Explains package exports and deployment restrictions.
tools/​export.ps1 Validates loose artifacts or packages written during the current run.
tools/​deploy-pc.ps1 Blocks loose registration in package mode, except unregister operations.
tools/​deploy-console.ps1 Blocks loose deployment in package mode.
tools/​common.ps1 Adds target-specific config lookup, mode detection and package discovery.
tools/​check-game-config.ps1 Validates both configs, shared values, logos and preset settings.
tools/​check-deport.ps1 Includes the Xbox config in text checks.
MicrosoftGame.config Removes the console executable and documents the PC-only config.
export_presets.cfg Points Xbox exports to their config and shared logo folder.
docs/​xr-compliance.md Updates compliance references to cover both configs.
docs/​glossary.md Clarifies the two config locations.
docs/​gameplay-reference.md Updates the repository layout for target-specific configs.
docs/​configuration.md Documents four build outputs, packaging steps and config relationships.
.github/​workflows/​ci.yml Updates comments and the validation step label for dual-config checks.

Review effort: Balanced

@joelbaker-xbox

Copy link
Copy Markdown
Contributor Author

@microsoft-github-policy-service agree company="Microsoft"

@joelbaker-xbox
Joel Baker (XBOX) (joelbaker-xbox) merged commit 7f682c8 into main Nov 18, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants