Skip to content

Conversation

@tustanivsky
Copy link
Collaborator

This PR updates the script that automates console plugin extension setup for the sample app - platform-specific configs can now be stored in their corresponding private repos and symlinked during script invocation.

#skip-changelog

@tustanivsky tustanivsky force-pushed the chore/ext-config-setup branch from 48303be to 62babc9 Compare November 7, 2025 07:14
Test: add log file path output

Update sample project distinguished name config (#1128)

Revert "Test: add log file path output"

This reverts commit eb32d4b.

Increase shutdown timeout

Revert "Increase shutdown timeout"

This reverts commit 086cefa.
@tustanivsky tustanivsky force-pushed the chore/ext-config-setup branch from 62babc9 to 4b987a2 Compare November 7, 2025 07:15
@tustanivsky tustanivsky marked this pull request as ready for review November 7, 2025 14:57
@tustanivsky tustanivsky requested a review from mujacica November 7, 2025 14:58
Comment on lines +213 to +218
$configFile = "$($config.PlatformFolder)Engine.ini"
$configTarget = Join-Path $sampleConfigDir $configFile

if (Test-Path $configTarget) {
$configLink = Join-Path $targetConfigDir $configFile
New-SymbolicLink -LinkPath $configLink -TargetPath $configTarget
Copy link

Choose a reason for hiding this comment

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

Bug: Script init-console-ext.ps1 symlinks platform config files to sample/Platforms/[Platform]/Config/, but Unreal Engine expects them in sample/Config/[Platform]/.
Severity: CRITICAL | Confidence: 1.00

🔍 Detailed Analysis

The init-console-ext.ps1 script creates symlinks for platform-specific configuration files in sample/Platforms/[Platform]/Config/ (e.g., sample/Platforms/Switch/Config/SwitchEngine.ini). However, Unreal Engine expects these files to be located in sample/Config/[Platform]/ (e.g., sample/Config/Switch/SwitchEngine.ini). As a result, Unreal Engine will not load the symlinked platform-specific configurations, silently falling back to default settings, which can lead to incorrect runtime behavior for platform-specific features.

💡 Suggested Fix

Modify scripts/init-console-ext.ps1 to create symlinks for platform-specific config files in sample/Config/[Platform]/ instead of sample/Platforms/[Platform]/Config/ to align with Unreal Engine's configuration loading hierarchy.

🤖 Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: scripts/init-console-ext.ps1#L213-L218

Potential issue: The `init-console-ext.ps1` script creates symlinks for
platform-specific configuration files in `sample/Platforms/[Platform]/Config/` (e.g.,
`sample/Platforms/Switch/Config/SwitchEngine.ini`). However, Unreal Engine expects these
files to be located in `sample/Config/[Platform]/` (e.g.,
`sample/Config/Switch/SwitchEngine.ini`). As a result, Unreal Engine will not load the
symlinked platform-specific configurations, silently falling back to default settings,
which can lead to incorrect runtime behavior for platform-specific features.

Did we get this right? 👍 / 👎 to inform future reviews.

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.

2 participants