Skip to content

Explainer.md

Latest commit

 

History

History
311 lines (204 loc) · 8.42 KB

Explainer.md

File metadata and controls

311 lines (204 loc) · 8.42 KB

Galaxy Book Enabler Explainer

This file is the public command reference for:

.\Install-GalaxyBookEnabler.ps1

Best practice: download the script first and run it locally from PowerShell 7. That gives you the most predictable behavior, makes reruns easier, and is the best way to use the install, autonomous, and manual generation paths.

Recommended Setup

Install PowerShell 7

winget install Microsoft.PowerShell

Download the script locally

Download Install-GalaxyBookEnabler.ps1 from the Releases page:

https://github.com/Bananz0/GalaxyBookEnabler/releases

Run the local script

.\Install-GalaxyBookEnabler.ps1

irm Use

Running with irm is supported, but local use is still preferred.

Direct one-liner

irm https://raw.githubusercontent.com/Bananz0/GalaxyBookEnabler/main/Install-GalaxyBookEnabler.ps1 | iex

After saving locally:

.\Install-GalaxyBookEnabler.ps1

Basic Use

Interactive install

.\Install-GalaxyBookEnabler.ps1

Test mode

.\Install-GalaxyBookEnabler.ps1 -TestMode

Full uninstall

.\Install-GalaxyBookEnabler.ps1 -Uninstall

Update Samsung Settings

.\Install-GalaxyBookEnabler.ps1 -UpdateSettings

Upgrade SSE path

.\Install-GalaxyBookEnabler.ps1 -UpgradeSSE

Autonomous Install

Standard autonomous install

.\Install-GalaxyBookEnabler.ps1 -FullyAutonomous -AutonomousModel Book4Pro -AutonomousPackageProfile Recommended -AutonomousInstallSsse:$true -AutonomousSsseStrategy Dual -AutonomousConfirmPackages:$true

Exact model code

.\Install-GalaxyBookEnabler.ps1 -FullyAutonomous -AutonomousModel 960XGL -AutonomousPackageProfile Skip -AutonomousInstallSsse:$false

Family or profile input

.\Install-GalaxyBookEnabler.ps1 -FullyAutonomous -AutonomousModel "Galaxy Book4 Pro" -AutonomousPackageProfile Core -AutonomousInstallSsse:$false

Region-aware autonomous install

.\Install-GalaxyBookEnabler.ps1 -FullyAutonomous -AutonomousModel Book4Ultra -AutonomousCountryCode US -AutonomousPackageProfile Recommended

GeoIP-driven autonomous resolution

.\Install-GalaxyBookEnabler.ps1 -FullyAutonomous -AutonomousModel Book4Ultra -AutonomousRegionSource GeoIp -AutonomousPackageProfile Recommended

Manual region override

.\Install-GalaxyBookEnabler.ps1 -FullyAutonomous -AutonomousModel Book4Ultra -AutonomousRegion DE -AutonomousPackageProfile Recommended

Region preference fallback

.\Install-GalaxyBookEnabler.ps1 -FullyAutonomous -AutonomousModel Book4Ultra -AutonomousRegionPreference UK,DE -AutonomousPackageProfile Recommended

config.plist Generation

These commands resolve OpenCore-ready SMBIOS values directly through the installer.

Generate configuration data only

.\Install-GalaxyBookEnabler.ps1 -ConfigurationOnly -FullyAutonomous -AutonomousModel Book4Ultra -AutonomousCountryCode US

Include the full BIOS string

.\Install-GalaxyBookEnabler.ps1 -ConfigurationOnly -FullyAutonomous -AutonomousModel Book4Ultra -AutonomousCountryCode US -IncludeFullBiosVersion

Exact model code

.\Install-GalaxyBookEnabler.ps1 -ConfigurationOnly -FullyAutonomous -AutonomousModel 960XGL -AutonomousCountryCode US

Friendly family name

.\Install-GalaxyBookEnabler.ps1 -ConfigurationOnly -FullyAutonomous -AutonomousModel "Galaxy Book4 Pro" -AutonomousCountryCode US

Country override

.\Install-GalaxyBookEnabler.ps1 -ConfigurationOnly -FullyAutonomous -AutonomousModel Book4Pro -AutonomousCountryCode US

Region override

.\Install-GalaxyBookEnabler.ps1 -ConfigurationOnly -FullyAutonomous -AutonomousModel Book4Pro -AutonomousRegion DE

Region preference

.\Install-GalaxyBookEnabler.ps1 -ConfigurationOnly -FullyAutonomous -AutonomousModel Book4Ultra -AutonomousRegionPreference UK,DE

GeoIP

.\Install-GalaxyBookEnabler.ps1 -ConfigurationOnly -FullyAutonomous -AutonomousModel Book4Ultra -AutonomousRegionSource GeoIp

Write directly into config.plist

.\Install-GalaxyBookEnabler.ps1 -ConfigurationOnly -FullyAutonomous -AutonomousModel Book4Pro -AutonomousCountryCode US -ConfigurationPath "D:\EFI\OC\config.plist"

Write config.plist with full BIOS string

.\Install-GalaxyBookEnabler.ps1 -ConfigurationOnly -FullyAutonomous -AutonomousModel Book4Pro -AutonomousCountryCode US -IncludeFullBiosVersion -ConfigurationPath "D:\EFI\OC\config.plist"

Write config.plist without backup

.\Install-GalaxyBookEnabler.ps1 -ConfigurationOnly -FullyAutonomous -AutonomousModel Book4Pro -AutonomousCountryCode US -ConfigurationPath "D:\EFI\OC\config.plist" -SkipConfigurationBackup

Write config.plist with custom backup suffix

.\Install-GalaxyBookEnabler.ps1 -ConfigurationOnly -FullyAutonomous -AutonomousModel Book4Pro -AutonomousCountryCode US -ConfigurationPath "D:\EFI\OC\config.plist" -ConfigurationBackupSuffix manual-test

Autonomous Actions

Install

.\Install-GalaxyBookEnabler.ps1 -TestMode -FullyAutonomous -AutonomousAction Install -AutonomousModel Book4Pro -AutonomousPackageProfile Skip -AutonomousInstallSsse:$false

UpdateSettings

.\Install-GalaxyBookEnabler.ps1 -TestMode -FullyAutonomous -AutonomousAction UpdateSettings -AutonomousSsseStrategy Stable

UpgradeSSE

.\Install-GalaxyBookEnabler.ps1 -TestMode -FullyAutonomous -AutonomousAction UpgradeSSE

UninstallAll

.\Install-GalaxyBookEnabler.ps1 -TestMode -FullyAutonomous -AutonomousAction UninstallAll

Package Profiles

Valid values for -AutonomousPackageProfile:

  • Core
  • Recommended
  • RecommendedPlus
  • Full
  • Everything
  • Custom
  • Skip

Custom package list

.\Install-GalaxyBookEnabler.ps1 -TestMode -FullyAutonomous -AutonomousModel 960XGL -AutonomousPackageProfile Custom -AutonomousPackageNames "Samsung Account","Samsung Settings" -AutonomousInstallSsse:$false -AutonomousConfirmPackages:$false

Model Input Rules

You can pass:

  • exact model codes such as 960XGL
  • short family/profile values such as Book4Pro
  • friendly family names such as Galaxy Book4 Pro

Examples:

.\Install-GalaxyBookEnabler.ps1 -ConfigurationOnly -FullyAutonomous -AutonomousModel Book4Ultra -AutonomousCountryCode US
.\Install-GalaxyBookEnabler.ps1 -ConfigurationOnly -FullyAutonomous -AutonomousModel "Galaxy Book4 Pro" -AutonomousCountryCode US
.\Install-GalaxyBookEnabler.ps1 -FullyAutonomous -AutonomousModel 960XGL -AutonomousPackageProfile Skip

Region Input Rules

If you do not specify a country or region, the script uses your Windows locale.

IE maps to UK.

Examples:

.\Install-GalaxyBookEnabler.ps1 -ConfigurationOnly -FullyAutonomous -AutonomousModel Book4Ultra -AutonomousCountryCode IE
.\Install-GalaxyBookEnabler.ps1 -ConfigurationOnly -FullyAutonomous -AutonomousModel Book4Ultra -AutonomousRegion UK
.\Install-GalaxyBookEnabler.ps1 -ConfigurationOnly -FullyAutonomous -AutonomousModel Book4Ultra -AutonomousRegionSource GeoIp

Logging

Default autonomous logging

.\Install-GalaxyBookEnabler.ps1 -FullyAutonomous -AutonomousModel Book4Pro -AutonomousPackageProfile Skip -LogDirectory "C:\GalaxyBook\Logs"

Explicit log file

.\Install-GalaxyBookEnabler.ps1 -FullyAutonomous -AutonomousModel Book4Pro -AutonomousPackageProfile Skip -LogPath "C:\GalaxyBook\Logs\manual-run.log"

Recommended Test Commands

Installer dry run

.\Install-GalaxyBookEnabler.ps1 -TestMode

Autonomous dry run

.\Install-GalaxyBookEnabler.ps1 -TestMode -FullyAutonomous -AutonomousModel Book4Pro -AutonomousPackageProfile Skip -AutonomousInstallSsse:$false

Configuration generation test

Copy-Item .\tests\fixtures\config.plist $env:TEMP\gbe-config-test.plist -Force; .\Install-GalaxyBookEnabler.ps1 -ConfigurationOnly -FullyAutonomous -AutonomousModel Book4Pro -AutonomousCountryCode US -IncludeFullBiosVersion -ConfigurationPath "$env:TEMP\gbe-config-test.plist"

Pester

Invoke-Pester -Script .\tests\Install-Configuration.Tests.ps1 -EnableExit