Skip to content

chore: Add config files symlink step to plugin extension setup script #1140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+65 −36
Open

chore: Add config files symlink step to plugin extension setup script #1140

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b987a2
Add config files symlink step to plugin extension setup script
tustanivsky Nov 5, 2025
1cea335
Merge branch 'main' into chore/ext-config-setup
tustanivsky Nov 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 65 additions & 36 deletions scripts/init-console-ext.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,37 @@ param(
Set-StrictMode -Version Latest
$ErrorActionPreference = "Stop"

# Helper function to create symlink/junction
function New-SymbolicLink {
param(
[string]$LinkPath,
[string]$TargetPath
)

# Remove existing link if it exists
if (Test-Path $LinkPath) {
$item = Get-Item $LinkPath
if ($item.LinkType -eq "Junction" -or $item.LinkType -eq "SymbolicLink") {
$item.Delete()
} else {
Remove-Item -Path $LinkPath -Recurse -Force
}
}

# Create parent directory if needed
$parentDir = Split-Path -Parent $LinkPath
if (-not (Test-Path $parentDir)) {
New-Item -ItemType Directory -Path $parentDir -Force | Out-Null
}

# Create junction (works cross-platform with PowerShell)
if (Test-Path $TargetPath -PathType Container) {
New-Item -ItemType Junction -Path $LinkPath -Target $TargetPath | Out-Null
} else {
New-Item -ItemType SymbolicLink -Path $LinkPath -Target $TargetPath | Out-Null
}
}

# Platform-specific configuration
$platformConfig = @{
'Switch' = @{
Expand Down Expand Up @@ -45,7 +76,7 @@ Write-Host "Setting up $Platform console extension..." -ForegroundColor Cyan
Write-Host "Extension path: $ExtensionPath"

# Step 1: Validate extension path
Write-Host "`n[1/5] Validating extension path..." -ForegroundColor Yellow
Write-Host "`n[1/6] Validating extension path..." -ForegroundColor Yellow

if (-not (Test-Path $ExtensionPath)) {
throw "Extension path does not exist: $ExtensionPath"
Expand All @@ -70,7 +101,7 @@ if (-not (Test-Path $sourceDir)) {
Write-Host " ✓ Extension path validated" -ForegroundColor Green

# Step 2: Build extension
Write-Host "`n[2/5] Building extension..." -ForegroundColor Yellow
Write-Host "`n[2/6] Building extension..." -ForegroundColor Yellow
Write-Host " Running: cmake --workflow --preset $($config.Preset) --fresh"

Push-Location $ExtensionPath
Expand All @@ -92,7 +123,7 @@ if (-not (Test-Path $buildOutputDir)) {
}

# Step 3: Create directory structure in sample project
Write-Host "`n[3/5] Creating directory structure..." -ForegroundColor Yellow
Write-Host "`n[3/6] Creating directory structure..." -ForegroundColor Yellow

$targetPluginRoot = Join-Path $repoRoot "sample" "Platforms" $config.PlatformFolder "Plugins" "Sentry"
$targetSourceRoot = Join-Path $targetPluginRoot "Source"
Expand All @@ -116,7 +147,7 @@ foreach ($dir in $dirsToCreate) {
Write-Host " ✓ Directory structure created" -ForegroundColor Green

# Step 4: Copy build artifacts (ThirdParty libs/headers)
Write-Host "`n[4/5] Copying build artifacts..." -ForegroundColor Yellow
Write-Host "`n[4/6] Copying build artifacts..." -ForegroundColor Yellow

$buildThirdPartyDir = Join-Path $buildOutputDir "Source" "ThirdParty" $config.PlatformFolder
if (-not (Test-Path $buildThirdPartyDir)) {
Expand All @@ -135,38 +166,7 @@ Write-Host " Copied: ThirdParty/$($config.PlatformFolder)/"
Write-Host " ✓ Build artifacts copied" -ForegroundColor Green

# Step 5: Symlink source files for live editing
Write-Host "`n[5/5] Creating symlinks to source files..." -ForegroundColor Yellow

# Helper function to create symlink/junction
function New-SymbolicLink {
param(
[string]$LinkPath,
[string]$TargetPath
)

# Remove existing link if it exists
if (Test-Path $LinkPath) {
$item = Get-Item $LinkPath
if ($item.LinkType -eq "Junction" -or $item.LinkType -eq "SymbolicLink") {
$item.Delete()
} else {
Remove-Item -Path $LinkPath -Recurse -Force
}
}

# Create parent directory if needed
$parentDir = Split-Path -Parent $LinkPath
if (-not (Test-Path $parentDir)) {
New-Item -ItemType Directory -Path $parentDir -Force | Out-Null
}

# Create junction (works cross-platform with PowerShell)
if (Test-Path $TargetPath -PathType Container) {
New-Item -ItemType Junction -Path $LinkPath -Target $TargetPath | Out-Null
} else {
New-Item -ItemType SymbolicLink -Path $LinkPath -Target $TargetPath | Out-Null
}
}
Write-Host "`n[5/6] Creating symlinks to source files..." -ForegroundColor Yellow

# Symlink .uplugin file
$upluginFiles = @(Get-ChildItem -Path $sourceDir -Filter "*.uplugin" -ErrorAction SilentlyContinue)
Expand Down Expand Up @@ -197,5 +197,34 @@ if (Test-Path $privateSourceDir) {

Write-Host " ✓ Source files symlinked" -ForegroundColor Green

# Step 6: Symlink config files for live editing
Write-Host "`n[6/6] Creating symlinks to config files..." -ForegroundColor Yellow

$sampleConfigDir = Join-Path $ExtensionPath "unreal" "sample-config"
if (Test-Path $sampleConfigDir) {
$targetConfigDir = Join-Path $repoRoot "sample" "Platforms" $config.PlatformFolder "Config"

# Ensure Config directory exists
if (-not (Test-Path $targetConfigDir)) {
New-Item -ItemType Directory -Path $targetConfigDir -Force | Out-Null
}

# Symlink platform-specific Engine.ini
$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
Comment on lines +213 to +218
Copy link

@sentry sentry bot Nov 7, 2025

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.

Write-Host " Linked: Config/$configFile"
} else {
Write-Host " Warning: Config file not found: $configFile" -ForegroundColor Yellow
}

Write-Host " ✓ Config files symlinked" -ForegroundColor Green
} else {
Write-Host " Skipping config symlinking (sample-config directory not found)" -ForegroundColor Gray
}

Write-Host "`n✓ Console extension setup complete!" -ForegroundColor Green
Write-Host "`nTarget location: $targetPluginRoot" -ForegroundColor Cyan