diff --git a/.github/workflows/github-pages.yaml b/.github/workflows/github-pages.yaml index b51697b8..f4d0ebb3 100644 --- a/.github/workflows/github-pages.yaml +++ b/.github/workflows/github-pages.yaml @@ -1,15 +1,16 @@ name: GitHub Pages Deploy on: - release: - types: [published, prereleased] + push: + paths: + - '.github/mkdocs.yml' + - '.github/requirements.txt' + - 'docs/**' + - 'overrides/**' workflow_dispatch: -permissions: - contents: write - jobs: - deploy: + build-and-deploy: runs-on: ubuntu-latest steps: @@ -22,10 +23,10 @@ jobs: uses: actions/setup-python@v5 with: python-version: 3.x # Install latest Stable release of Python 3 - cache: 'pip' # caching pip dependencies + cache: 'pip' # Caching pip dependencies - - name: Install Necessary Dependencies using 'pip install -r .github/requirements.txt' + - name: Install Necessary Dependencies run: pip install -r .github/requirements.txt - - name: Build & Deploy using 'mkdocs' - run: mkdocs gh-deploy --force -f .github/mkdocs.yml \ No newline at end of file + - name: Build & Deploy using mkdocs + run: mkdocs gh-deploy --force -f .github/mkdocs.yml diff --git a/Compile.ps1 b/Compile.ps1 index fdb59e2b..e63c4c17 100644 --- a/Compile.ps1 +++ b/Compile.ps1 @@ -64,7 +64,6 @@ Get-ChildItem "$workingdir\functions" -Recurse -File | ForEach-Object { } Update-Progress "Adding: Config *.json" 40 Get-ChildItem "$workingdir\config" | Where-Object {$psitem.extension -eq ".json"} | ForEach-Object { - $json = (Get-Content $psitem.FullName).replace("'","''") # Replace every XML Special Character so it'll render correctly in final build @@ -98,12 +97,9 @@ Get-ChildItem "$workingdir\config" | Where-Object {$psitem.extension -eq ".json" # Add 'WPFInstall' as a prefix to every entry-name in 'applications.json' file if ($psitem.Name -eq "applications.json") { - for ($i = 0; $i -lt $firstLevelJsonList.Count; $i += 1) { - $appEntryName = $firstLevelJsonList[$i] + foreach ($appEntryName in $jsonAsObject.PSObject.Properties.Name) { $appEntryContent = $jsonAsObject.$appEntryName - # Remove the entire app entry, so we could add it later with a different name $jsonAsObject.PSObject.Properties.Remove($appEntryName) - # Add the app entry, but with a different name (WPFInstall + The App Entry Name) $jsonAsObject | Add-Member -MemberType NoteProperty -Name "WPFInstall$appEntryName" -Value $appEntryContent } } @@ -118,20 +114,7 @@ Get-ChildItem "$workingdir\config" | Where-Object {$psitem.extension -eq ".json" $xaml = (Get-Content "$workingdir\xaml\inputXML.xaml").replace("'","''") -# Dot-source the Get-TabXaml function -. "$workingdir\functions\private\Get-TabXaml.ps1" - -Update-Progress "Building: Xaml " 75 -$appXamlContent = Get-TabXaml "applications" 5 -$tweaksXamlContent = Get-TabXaml "tweaks" -$featuresXamlContent = Get-TabXaml "feature" - - Update-Progress "Adding: Xaml " 90 -# Replace the placeholder in $inputXML with the content of inputApp.xaml -$xaml = $xaml -replace "{{InstallPanel_applications}}", $appXamlContent -$xaml = $xaml -replace "{{InstallPanel_tweaks}}", $tweaksXamlContent -$xaml = $xaml -replace "{{InstallPanel_features}}", $featuresXamlContent $script_content.Add($(Write-output "`$inputXML = '$xaml'")) diff --git a/README.md b/README.md index 942a03d1..b0820ded 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ If you have Issues, refer to [Known Issues](https://christitustech.github.io/win These are the sponsors that help keep this project alive with monthly contributions. -Yusuke SaitoTriHyderaMark AmosJason A. DiegmuellerwyattStefanthaddlPaulDave JonesAnthony MendezMichael WozniakxPandaku +Yusuke SaitoTriHyderaMark AmosJason A. DiegmuellerwyattStefanthaddlPaulDave JonesAnthony MendezMichael WozniakxPandakuClaudemodsHalil KolatanTimothy Cook ## 🏅 Thanks to all Contributors Thanks a lot for spending your time helping Winutil grow. Thanks a lot! Keep rocking 🍻. diff --git a/config/preset.json b/config/preset.json index a6a94989..ef33a05b 100644 --- a/config/preset.json +++ b/config/preset.json @@ -15,7 +15,7 @@ "WPFTweaksDeleteTempFiles", "WPFTweaksEndTaskOnTaskbar", "WPFTweaksRestorePoint", - "WPFTweaksTeredo", + "WPFTweaksIPv46", "WPFTweaksPowershell7Tele" ], "Minimal": [ diff --git a/config/themes.json b/config/themes.json index c3ee4fe4..969491fb 100644 --- a/config/themes.json +++ b/config/themes.json @@ -1,221 +1,170 @@ { "$schema": "../schemas/config/themes.json", - "Classic": { - "CustomDialogFontSize": "12", - "CustomDialogFontSizeHeader": "14", - "CustomDialogIconSize": "25", - "CustomDialogWidth": "400", - "CustomDialogHeight": "200", + "_default": { + "CustomDialogFontSize": "12", + "CustomDialogFontSizeHeader": "14", + "CustomDialogIconSize": "25", + "CustomDialogWidth": "400", + "CustomDialogHeight": "200", - "FontSize": "12", - "FontFamily": "Arial", - "FontSizeHeading": "14", - "HeaderFontFamily": "Consolas, Monaco", + "FontSize": "14", + "FontFamily": "Arial", + "FontSizeHeading": "16", + "HeaderFontFamily": "Consolas, Monaco", - "CheckBoxBulletDecoratorFontSize": "14", - "CheckBoxMargin": "15,0,0,2", + "CheckBoxBulletDecoratorSize": "14", + "CheckBoxMargin": "15,0,0,2", - "TabButtonFontSize": "14", - "TabButtonWidth": "100", - "TabButtonHeight": "25", - "TabRowHeightInPixels": "50", - "IconFontSize": "14", - "IconButtonSize": "35", - "WinUtilIconSize": "Auto", - "SettingsIconFontSize": "18", + "TabContentMargin": "5", + "TabButtonFontSize": "14", + "TabButtonWidth": "100", + "TabButtonHeight": "25", + "TabRowHeightInPixels": "50", + "IconFontSize": "14", + "IconButtonSize": "35", + "WinUtilIconSize": "Auto", + "SettingsIconFontSize": "18", + "CloseIconFontSize": "18", - "MicroWinLogoSize": "10", + "MicroWinLogoSize": "10", - "ProgressBarForegroundColor": "#FFAC1C", - "ProgressBarBackgroundColor": "Transparent", - "ProgressBarTextColor": "#000000", + "ProgressBarForegroundColor": "#FFAC1C", + "ProgressBarBackgroundColor": "Transparent", + "ProgressBarTextColor": "#000000", - "ComboBoxBackgroundColor": "#FFFFFF", - "LabelboxForegroundColor": "#000000", - "MainForegroundColor": "#000000", - "MainBackgroundColor": "#FFFFFF", - "LabelBackgroundColor": "#FAFAFA", - "LinkForegroundColor": "#000000", - "LinkHoverForegroundColor": "#000000", - "GroupBorderBackgroundColor": "#000000", - "ComboBoxForegroundColor": "#000000", + "ComboBoxBackgroundColor": "#FFFFFF", + "LabelboxForegroundColor": "#000000", + "MainForegroundColor": "#000000", + "MainBackgroundColor": "#FFFFFF", + "LabelBackgroundColor": "#FFFFFF", + "LinkForegroundColor": "#000000", + "LinkHoverForegroundColor": "#000000", + "GroupBorderBackgroundColor": "#000000", + "ComboBoxForegroundColor": "#000000", - "ButtonFontSize": "12", - "ButtonFontFamily": "Arial", - "ButtonWidth": "200", - "ButtonHeight": "25", - "ConfigTabButtonFontSize": "16", + "ButtonFontSize": "12", + "ButtonFontFamily": "Arial", + "ButtonWidth": "200", + "ButtonHeight": "25", + "ConfigTabButtonFontSize": "16", - "SearchBarWidth": "200", - "SearchBarHeight": "25", - "SearchBarTextBoxFontSize": "16", - "SearchBarClearButtonFontSize": "14", + "SearchBarWidth": "200", + "SearchBarHeight": "25", + "SearchBarTextBoxFontSize": "12", + "SearchBarClearButtonFontSize": "14", - "ButtonInstallBackgroundColor": "#FFFFFF", - "ButtonTweaksBackgroundColor": "#FFFFFF", - "ButtonConfigBackgroundColor": "#FFFFFF", - "ButtonUpdatesBackgroundColor": "#FFFFFF", - "ButtonInstallForegroundColor": "#000000", - "ButtonTweaksForegroundColor": "#000000", - "ButtonConfigForegroundColor": "#000000", - "ButtonUpdatesForegroundColor": "#000000", - "ButtonBackgroundColor": "#F5F5F5", - "ButtonBackgroundPressedColor": "#1A1A1A", - "CheckboxMouseOverColor": "#999999", - "ButtonBackgroundMouseoverColor": "#C2C2C2", - "ButtonBackgroundSelectedColor": "#F0F0F0", - "ButtonForegroundColor": "#000000", - "ToggleButtonOnColor": "#2e77ff", + "ButtonInstallBackgroundColor": "#FFFFFF", + "ButtonTweaksBackgroundColor": "#FFFFFF", + "ButtonConfigBackgroundColor": "#FFFFFF", + "ButtonUpdatesBackgroundColor": "#FFFFFF", + "ButtonInstallForegroundColor": "#000000", + "ButtonTweaksForegroundColor": "#000000", + "ButtonConfigForegroundColor": "#000000", + "ButtonUpdatesForegroundColor": "#000000", + "ButtonBackgroundColor": "#F5F5F5", + "ButtonBackgroundPressedColor": "#1A1A1A", + "CheckboxMouseOverColor": "#999999", + "ButtonBackgroundMouseoverColor": "#C2C2C2", + "ButtonBackgroundSelectedColor": "#F0F0F0", + "ButtonForegroundColor": "#000000", + "ToggleButtonOnColor": "#2e77ff", - "ButtonBorderThickness": "1", - "ButtonMargin": "1", - "ButtonCornerRadius": "2", - "BorderColor": "#000000", - "BorderOpacity": "0.2", - "ShadowPulse": "Forever" - }, - "Matrix": { - "CustomDialogFontSize": "12", - "CustomDialogFontSizeHeader": "14", - "CustomDialogIconSize": "25", - "CustomDialogWidth": "400", - "CustomDialogHeight": "200", + "ButtonBorderThickness": "1", + "ButtonMargin": "1", + "ButtonCornerRadius": "2", + "BorderColor": "#000000", + "BorderOpacity": "0.2", + "ShadowPulse": "Forever" + }, + "Classic": { + "ComboBoxBackgroundColor": "#FFFFFF", + "LabelboxForegroundColor": "#000000", + "MainForegroundColor": "#000000", + "MainBackgroundColor": "#FFFFFF", + "LabelBackgroundColor": "#FFFFFF", + "LinkForegroundColor": "#000000", + "LinkHoverForegroundColor": "#000000", + "GroupBorderBackgroundColor": "#000000", + "ComboBoxForegroundColor": "#000000", - "FontSize": "12", - "FontFamily": "Arial", - "FontSizeHeading": "14", - "HeaderFontFamily": "Consolas, Monaco", + "ButtonInstallBackgroundColor": "#FFFFFF", + "ButtonTweaksBackgroundColor": "#FFFFFF", + "ButtonConfigBackgroundColor": "#FFFFFF", + "ButtonUpdatesBackgroundColor": "#FFFFFF", + "ButtonInstallForegroundColor": "#000000", + "ButtonTweaksForegroundColor": "#000000", + "ButtonConfigForegroundColor": "#000000", + "ButtonUpdatesForegroundColor": "#000000", + "ButtonBackgroundColor": "#F5F5F5", + "ButtonBackgroundPressedColor": "#1A1A1A", + "CheckboxMouseOverColor": "#999999", + "ButtonBackgroundMouseoverColor": "#C2C2C2", + "ButtonBackgroundSelectedColor": "#F0F0F0", + "ButtonForegroundColor": "#000000", + "ToggleButtonOnColor": "#2e77ff" + }, + "Matrix": { + "ComboBoxBackgroundColor": "#000000", + "LabelboxForegroundColor": "#FFEE58", + "MainForegroundColor": "#9CCC65", + "MainBackgroundColor": "#000000", + "LabelBackgroundColor": "#000000", + "LinkForegroundColor": "#add8e6", + "LinkHoverForegroundColor": "#FFFFFF", + "ComboBoxForegroundColor": "#FFEE58", - "CheckBoxBulletDecoratorFontSize": "14", - "CheckBoxMargin": "15,0,0,2", + "ProgressBarForegroundColor": "#222222", + "ProgressBarBackgroundColor": "Transparent", + "ProgressBarTextColor": "#cccccc", - "TabButtonFontSize": "14", - "TabButtonWidth": "100", - "TabButtonHeight": "25", - "TabRowHeightInPixels": "50", - "IconFontSize": "14", - "IconButtonSize": "35", - "WinUtilIconSize": "Auto", - "SettingsIconFontSize": "18", + "ButtonInstallBackgroundColor": "#222222", + "ButtonTweaksBackgroundColor": "#333333", + "ButtonConfigBackgroundColor": "#444444", + "ButtonUpdatesBackgroundColor": "#555555", + "ButtonInstallForegroundColor": "#FFFFFF", + "ButtonTweaksForegroundColor": "#FFFFFF", + "ButtonConfigForegroundColor": "#FFFFFF", + "ButtonUpdatesForegroundColor": "#FFFFFF", + "ButtonBackgroundColor": "#000019", + "ButtonBackgroundPressedColor": "#FFFFFF", + "ButtonBackgroundMouseoverColor": "#A55A64", + "ButtonBackgroundSelectedColor": "#FF5733", + "ButtonForegroundColor": "#9CCC65", + "ToggleButtonOnColor": "#2e77ff", - "MicroWinLogoSize": "10", + "BorderColor": "#FFAC1C", + "BorderOpacity": "0.8", + "ShadowPulse": "0:0:3" + }, + "Dark": { + "ComboBoxBackgroundColor": "#000000", + "LabelboxForegroundColor": "#FFEE58", + "MainForegroundColor": "#9CCC65", + "MainBackgroundColor": "#000000", + "LabelBackgroundColor": "#000000", + "LinkForegroundColor": "#add8e6", + "LinkHoverForegroundColor": "#FFFFFF", + "ComboBoxForegroundColor": "#FFEE58", - "ProgressBarForegroundColor": "#222222", - "ProgressBarBackgroundColor": "Transparent", - "ProgressBarTextColor": "#cccccc", + "ProgressBarForegroundColor": "#222222", + "ProgressBarBackgroundColor": "Transparent", + "ProgressBarTextColor": "#cccccc", - "ComboBoxBackgroundColor": "#000000", - "LabelboxForegroundColor": "#FFEE58", - "MainForegroundColor": "#9CCC65", - "MainBackgroundColor": "#000000", - "LabelBackgroundColor": "#000000", - "LinkForegroundColor": "#add8e6", - "LinkHoverForegroundColor": "#FFFFFF", - "ComboBoxForegroundColor": "#FFEE58", + "ButtonInstallBackgroundColor": "#222222", + "ButtonTweaksBackgroundColor": "#333333", + "ButtonConfigBackgroundColor": "#444444", + "ButtonUpdatesBackgroundColor": "#555555", + "ButtonInstallForegroundColor": "#FFFFFF", + "ButtonTweaksForegroundColor": "#FFFFFF", + "ButtonConfigForegroundColor": "#FFFFFF", + "ButtonUpdatesForegroundColor": "#FFFFFF", + "ButtonBackgroundColor": "#000019", + "ButtonBackgroundPressedColor": "#9CCC65", + "ButtonBackgroundMouseoverColor": "#FF5733", + "ButtonBackgroundSelectedColor": "#FF5733", + "ButtonForegroundColor": "#9CCC65", + "ToggleButtonOnColor": "#2e77ff", - "ButtonFontSize": "12", - "ButtonFontFamily": "Arial", - "ButtonWidth": "200", - "ButtonHeight": "25", - "ConfigTabButtonFontSize": "16", - - "SearchBarWidth": "200", - "SearchBarHeight": "25", - "SearchBarTextBoxFontSize": "16", - "SearchBarClearButtonFontSize": "14", - - "ButtonInstallBackgroundColor": "#222222", - "ButtonTweaksBackgroundColor": "#333333", - "ButtonConfigBackgroundColor": "#444444", - "ButtonUpdatesBackgroundColor": "#555555", - "ButtonInstallForegroundColor": "#FFFFFF", - "ButtonTweaksForegroundColor": "#FFFFFF", - "ButtonConfigForegroundColor": "#FFFFFF", - "ButtonUpdatesForegroundColor": "#FFFFFF", - "ButtonBackgroundColor": "#000019", - "ButtonBackgroundPressedColor": "#FFFFFF", - "ButtonBackgroundMouseoverColor": "#A55A64", - "ButtonBackgroundSelectedColor": "#FF5733", - "ButtonForegroundColor": "#9CCC65", - "ToggleButtonOnColor": "#2e77ff", - - "ButtonBorderThickness": "1", - "ButtonMargin": "1", - "ButtonCornerRadius": "2", - "BorderColor": "#FFAC1C", - "BorderOpacity": "0.8", - "ShadowPulse": "0:0:3" - }, - "Dark": { - "CustomDialogFontSize": "12", - "CustomDialogFontSizeHeader": "14", - "CustomDialogIconSize": "25", - "CustomDialogWidth": "400", - "CustomDialogHeight": "200", - - "FontSize": "12", - "FontFamily": "Arial", - "FontSizeHeading": "14", - "HeaderFontFamily": "Consolas, Monaco", - - "CheckBoxBulletDecoratorFontSize": "14", - "CheckBoxMargin": "15,0,0,2", - - "TabButtonFontSize": "14", - "TabButtonWidth": "100", - "TabButtonHeight": "25", - "TabRowHeightInPixels": "50", - "IconFontSize": "14", - "IconButtonSize": "35", - "WinUtilIconSize": "Auto", - "SettingsIconFontSize": "18", - - "MicroWinLogoSize": "10", - - "ProgressBarForegroundColor": "#222222", - "ProgressBarBackgroundColor": "Transparent", - "ProgressBarTextColor": "#FFFFFF", - - "ComboBoxBackgroundColor": "#000000", - "LabelboxForegroundColor": "#FFEE58", - "MainForegroundColor": "#9CCC65", - "MainBackgroundColor": "#000000", - "LabelBackgroundColor": "#000000", - "LinkForegroundColor": "#add8e6", - "LinkHoverForegroundColor": "#FFFFFF", - "ComboBoxForegroundColor": "#FFEE58", - - "ButtonFontSize": "12", - "ButtonFontFamily": "Arial", - "ButtonWidth": "200", - "ButtonHeight": "25", - "ConfigTabButtonFontSize": "16", - - "SearchBarWidth": "200", - "SearchBarHeight": "25", - "SearchBarTextBoxFontSize": "16", - "SearchBarClearButtonFontSize": "14", - - "ButtonInstallBackgroundColor": "#222222", - "ButtonTweaksBackgroundColor": "#333333", - "ButtonConfigBackgroundColor": "#444444", - "ButtonUpdatesBackgroundColor": "#555555", - "ButtonInstallForegroundColor": "#FFFFFF", - "ButtonTweaksForegroundColor": "#FFFFFF", - "ButtonConfigForegroundColor": "#FFFFFF", - "ButtonUpdatesForegroundColor": "#FFFFFF", - "ButtonBackgroundColor": "#000019", - "ButtonBackgroundPressedColor": "#9CCC65", - "ButtonBackgroundMouseoverColor": "#FF5733", - "ButtonBackgroundSelectedColor": "#FF5733", - "ButtonForegroundColor": "#9CCC65", - "ToggleButtonOnColor": "#2e77ff", - - "ButtonBorderThickness": "1", - "ButtonMargin": "1", - "ButtonCornerRadius": "2", - "BorderColor": "#FFAC1C", - "BorderOpacity": "0.2", - "ShadowPulse": "Forever" - } + "BorderColor": "#FFAC1C" + } } diff --git a/config/tweaks.json b/config/tweaks.json index 53145732..bb1967cd 100644 --- a/config/tweaks.json +++ b/config/tweaks.json @@ -3142,12 +3142,29 @@ ], "link": "https://christitustech.github.io/winutil/dev/tweaks/Essential-Tweaks/DVR" }, - "WPFTweaksTeredo": { - "Content": "Disable Teredo", - "Description": "Teredo network tunneling is a ipv6 feature that can cause additional latency.", + "WPFTweaksIPv46": { + "Content": "Prefer IPv4 over IPv6", + "Description": "To set the IPv4 preference can have latency and security benefits on private networks where IPv6 is not configured.", "category": "Essential Tweaks", "panel": "1", "Order": "a005_", + "registry": [ + { + "Path": "HKLM:\\SYSTEM\\CurrentControlSet\\Services\\Tcpip6\\Parameters", + "Name": "DisabledComponents", + "Value": "32", + "OriginalValue": "0", + "Type": "DWord" + } + ], + "link": "https://christitustech.github.io/winutil/dev/tweaks/Essential-Tweaks/IPv46" + }, + "WPFTweaksTeredo": { + "Content": "Disable Teredo", + "Description": "Teredo network tunneling is a ipv6 feature that can cause additional latency, but may cause problems with some games", + "category": "z__Advanced Tweaks - CAUTION", + "panel": "1", + "Order": "a023_", "registry": [ { "Path": "HKLM:\\SYSTEM\\CurrentControlSet\\Services\\Tcpip6\\Parameters", @@ -3163,7 +3180,7 @@ "UndoScript": [ "netsh interface teredo set state default" ], - "link": "https://christitustech.github.io/winutil/dev/tweaks/Essential-Tweaks/Teredo" + "link": "https://christitustech.github.io/winutil/dev/tweaks/z--Advanced-Tweaks---CAUTION/Teredo" }, "WPFTweaksDisableipsix": { "Content": "Disable IPv6", diff --git a/docs/dev/tweaks/Essential-Tweaks/IPv46.md b/docs/dev/tweaks/Essential-Tweaks/IPv46.md new file mode 100644 index 00000000..471ca312 --- /dev/null +++ b/docs/dev/tweaks/Essential-Tweaks/IPv46.md @@ -0,0 +1,63 @@ +# Prefer IPv4 over IPv6 + +Last Updated: 2024-08-27 + + +!!! info + The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. **Developers do have the ability to add custom content, which won't be updated automatically.** +## Description + +To set the IPv4 preference can have latency and security benefits on private networks where IPv6 is not configured. + + + + + +
+Preview Code + +```json +{ + "Content": "Prefer IPv4 over IPv6", + "Description": "To set the IPv4 preference can have latency and security benefits on private networks where IPv6 is not configured.", + "category": "Essential Tweaks", + "panel": "1", + "Order": "a005_", + "registry": [ + { + "Path": "HKLM:\\SYSTEM\\CurrentControlSet\\Services\\Tcpip6\\Parameters", + "Name": "DisabledComponents", + "Value": "32", + "OriginalValue": "0", + "Type": "DWord" + } + ], + "link": "https://christitustech.github.io/winutil/dev/tweaks/Essential-Tweaks/IPv46" +} +``` + +
+ +## Registry Changes +Applications and System Components store and retrieve configuration data to modify windows settings, so we can use the registry to change many settings in one place. + + +You can find information about the registry on [Wikipedia](https://www.wikiwand.com/en/Windows_Registry) and [Microsoft's Website](https://learn.microsoft.com/en-us/windows/win32/sysinfo/registry). + +### Registry Key: DisabledComponents + +**Type:** DWord + +**Original Value:** 0 + +**New Value:** 32 + + + + + + + + +[View the JSON file](https://github.com/ChrisTitusTech/winutil/tree/main/config/tweaks.json) + diff --git a/docs/dev/tweaks/Essential-Tweaks/Teredo.md b/docs/dev/tweaks/z--Advanced-Tweaks---CAUTION/Teredo.md similarity index 84% rename from docs/dev/tweaks/Essential-Tweaks/Teredo.md rename to docs/dev/tweaks/z--Advanced-Tweaks---CAUTION/Teredo.md index 4206d514..428d8022 100644 --- a/docs/dev/tweaks/Essential-Tweaks/Teredo.md +++ b/docs/dev/tweaks/z--Advanced-Tweaks---CAUTION/Teredo.md @@ -1,13 +1,13 @@ # Disable Teredo -Last Updated: 2024-08-07 +Last Updated: 2024-08-27 !!! info The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. **Developers do have the ability to add custom content, which won't be updated automatically.** ## Description -Teredo network tunneling is a ipv6 feature that can cause additional latency. +Teredo network tunneling is a ipv6 feature that can cause additional latency, but may cause problems with some games @@ -19,10 +19,10 @@ Teredo network tunneling is a ipv6 feature that can cause additional latency. ```json { "Content": "Disable Teredo", - "Description": "Teredo network tunneling is a ipv6 feature that can cause additional latency.", - "category": "Essential Tweaks", + "Description": "Teredo network tunneling is a ipv6 feature that can cause additional latency, but may cause problems with some games", + "category": "z__Advanced Tweaks - CAUTION", "panel": "1", - "Order": "a005_", + "Order": "a023_", "registry": [ { "Path": "HKLM:\\SYSTEM\\CurrentControlSet\\Services\\Tcpip6\\Parameters", @@ -38,7 +38,7 @@ Teredo network tunneling is a ipv6 feature that can cause additional latency. "UndoScript": [ "netsh interface teredo set state default" ], - "link": "https://christitustech.github.io/winutil/dev/tweaks/Essential-Tweaks/Teredo" + "link": "https://christitustech.github.io/winutil/dev/tweaks/z--Advanced-Tweaks---CAUTION/Teredo" } ``` diff --git a/docs/devdocs.md b/docs/devdocs.md index 9a73d996..7efd5d62 100644 --- a/docs/devdocs.md +++ b/docs/devdocs.md @@ -13,6 +13,7 @@ - [Disable IPv6](dev/tweaks/z--Advanced-Tweaks---CAUTION/Disableipsix.md) - [Disable Microsoft Copilot](dev/tweaks/z--Advanced-Tweaks---CAUTION/RemoveCopilot.md) - [Disable Notification Tray/Calendar](dev/tweaks/z--Advanced-Tweaks---CAUTION/DisableNotifications.md) +- [Disable Teredo](dev/tweaks/z--Advanced-Tweaks---CAUTION/Teredo.md) - [DNS](dev/tweaks/z--Advanced-Tweaks---CAUTION/changedns.md) - [Remove ALL MS Store Apps - NOT RECOMMENDED](dev/tweaks/z--Advanced-Tweaks---CAUTION/DeBloat.md) - [Remove Home and Gallery from explorer](dev/tweaks/z--Advanced-Tweaks---CAUTION/RemoveHomeGallery.md) @@ -30,6 +31,7 @@ - [Create Restore Point](dev/tweaks/Essential-Tweaks/RestorePoint.md) - [Debloat Edge](dev/tweaks/Essential-Tweaks/EdgeDebloat.md) - [Delete Temporary Files](dev/tweaks/Essential-Tweaks/DeleteTempFiles.md) +- [Prefer IPv4 over IPv6](dev/tweaks/Essential-Tweaks/IPv46.md) - [Disable Activity History](dev/tweaks/Essential-Tweaks/AH.md) - [Disable ConsumerFeatures](dev/tweaks/Essential-Tweaks/ConsumerFeatures.md) - [Disable GameDVR](dev/tweaks/Essential-Tweaks/DVR.md) @@ -39,7 +41,6 @@ - [Disable Powershell 7 Telemetry](dev/tweaks/Essential-Tweaks/Powershell7Tele.md) - [Disable Storage Sense](dev/tweaks/Essential-Tweaks/Storage.md) - [Disable Telemetry](dev/tweaks/Essential-Tweaks/Tele.md) -- [Disable Teredo](dev/tweaks/Essential-Tweaks/Teredo.md) - [Disable Wifi-Sense](dev/tweaks/Essential-Tweaks/Wifi.md) - [Enable End Task With Right Click](dev/tweaks/Essential-Tweaks/EndTaskOnTaskbar.md) - [Run Disk Cleanup](dev/tweaks/Essential-Tweaks/DiskCleanup.md) diff --git a/docs/userguide.md b/docs/userguide.md index 9800ed59..7dac8c9a 100644 --- a/docs/userguide.md +++ b/docs/userguide.md @@ -198,26 +198,7 @@ The utility provides three distinct settings for managing Windows updates: Defau * Selecting a scratch directory will copy the contents of the ISO file to the directory you specify instead of an automatically generated folder in the `%TEMP%` directory. * You can select an edition of Windows to debloat (**SKU**) using the convenient drop-down menu. -    By default, MicroWin will debloat the Pro edition, but you can choose any edition you want. - - -##### Customization options - -* **Keep Provisioned Packages**: leaving this option unticked (default) will try to remove every operating system package. - -    Some packages may remain after processing. This can happen if the packages in question are permanent or have been superseded by newer versions. - -* **Keep Appx Packages**: leaving this option unticked (default) will try to remove every Microsoft Store app from the Windows image. - -    This option will exclude some applications that are essential in the event that you want or need to add a Store app later on. - -* **Keep Defender**: leaving this option unticked will try to remove every part of Windows Defender, including the Windows Security app. - -    Leaving this option unticked is **NOT recommended** unless you plan to use a third-party antivirus solution on your MicroWin installation. In that regard, don't install AVs with bad reputations or rogueware. - -* **Keep Edge**: leaving this option unticked will try to remove every part of the Microsoft Edge browser using the best methods available. - -    Leaving this option unticked is not recommended because it might break some applications that might depend on the `Edge WebView2` runtime. However, if that happens, you can easily [reinstall it](https://developer.microsoft.com/en-us/microsoft-edge/webview2) +By default, MicroWin will debloat the Pro edition, but you can choose any edition you want. ##### Driver integration options @@ -225,7 +206,15 @@ The utility provides three distinct settings for managing Windows updates: Defau * **Inject drivers** will add the drivers in the folder that you specify to the target Windows image. * **Import drivers from the current system** will add every third-party driver that is present in your active installation. -    This makes the target image have the same hardware compatibility as the active installation. However, this means that you will only be able to install the target Windows image and take full advantage of it on computers with **the same hardware**. To avoid this, you'll need to customize the `install.wim` file of the target ISO in the 'sources` folder. +This makes the target image have the same hardware compatibility as the active installation. However, this means that you will only be able to install the target Windows image and take full advantage of it on computers with **the same hardware**. To avoid this, you'll need to customize the `install.wim` file of the target ISO in the 'sources` folder. + +##### Custom user settings + +With MicroWin, you can also configure your user before proceeding if you don't want to use the default `User` account. To do this, simply type the account name (20 characters maximum), and a password. Then, let MicroWin do the rest. + +!!! info + + Please make sure that you remember your password. MicroWin will configure auto-login settings, so you won't have to enter your password. However, if you are required to enter your password, it's best that you don't forget it. ##### Ventoy options diff --git a/functions/private/Get-TabXaml.ps1 b/functions/private/Get-TabXaml.ps1 deleted file mode 100644 index 5eef6417..00000000 --- a/functions/private/Get-TabXaml.ps1 +++ /dev/null @@ -1,221 +0,0 @@ -function Get-TabXaml { - <# - .SYNOPSIS - Generates XAML for a tab in the WinUtil GUI - This function is used to generate the XAML for the applications tab in the WinUtil GUI - It takes the tabname and the number of columns to display the applications in as input and returns the XAML for the tab as output - - .PARAMETER tabname - The name of the tab to generate XAML for - Note: the 'tabname' parameter must equal one of the json files found in $sync.configs variable - Otherwise, it'll throw an exception - - .PARAMETER columncount - The number of columns to display the applications in, default is 0 - - .OUTPUTS - The XAML for the tab - - .EXAMPLE - Get-TabXaml "applications" 3 - #> - - - param( - [Parameter(Mandatory, position=0)] - [string]$tabname, - - [Parameter(position=1)] - [ValidateRange(0,10)] # 10 panels as max number is more then enough - [int]$columncount = 0 - ) - - # Validate tabname - if ($sync.configs.$tabname -eq $null) { - throw "Invalid parameter passed, can't find '$tabname' in '`$sync.configs' variable, please double check any calls to 'Get-TabXaml' function." - } - - $organizedData = @{} - # Iterate through JSON data and organize by panel and category - foreach ($appName in $sync.configs.$tabname.PSObject.Properties.Name) { - $appInfo = $sync.configs.$tabname.$appName - - # Create an object for the application - $appObject = [PSCustomObject]@{ - Name = $appName - Category = $appInfo.Category - Content = $appInfo.Content - Choco = $appInfo.choco - Winget = $appInfo.winget - Panel = if ($columncount -gt 0 ) { "0" } else {$appInfo.panel} - Link = $appInfo.link - Description = $appInfo.description - # Type is (Checkbox,Toggle,Button,Combobox ) (Default is Checkbox) - Type = $appInfo.type - ComboItems = $appInfo.ComboItems - # Checked is the property to set startup checked status of checkbox (Default is false) - Checked = $appInfo.Checked - ButtonWidth = $appInfo.ButtonWidth - } - - if (-not $organizedData.ContainsKey($appObject.panel)) { - $organizedData[$appObject.panel] = @{} - } - - if (-not $organizedData[$appObject.panel].ContainsKey($appObject.Category)) { - $organizedData[$appObject.panel][$appObject.Category] = @{} - } - - # Store application data in a sub-array under the category - # Add Order property to keep the original order of tweaks and features - $organizedData[$appObject.panel][$appInfo.Category]["$($appInfo.order)$appName"] = $appObject - } - - # Same tab amount in last line of 'inputXML.xaml' file - # TODO: Get the base repeat (amount) of tabs from last line (or even lines) - # so it can dynamicly react to whatever is before this generated XML string. - # .. may be solve this even before calling this function, and pass the result as a parameter? - $tab_repeat = 7 - $spaces_per_tab = 4 # The convenction used across the code base - $tab_as_spaces = $(" " * $spaces_per_tab) - $precal_indent = $($tab_as_spaces * $tab_repeat) - $precal_indent_p1 = $($tab_as_spaces * ($tab_repeat + 1)) - $precal_indent_p2 = $($tab_as_spaces * ($tab_repeat + 2)) - $precal_indent_m1 = $($tab_as_spaces * ($tab_repeat - 1)) - $precal_indent_m2 = $($tab_as_spaces * ($tab_repeat - 2)) - - # Calculate the needed number of panels - $panelcount = 0 - $paneltotal = $organizedData.Keys.Count - if ($columncount -gt 0) { - $appcount = $sync.configs.$tabname.PSObject.Properties.Name.count + $organizedData["0"].Keys.count - $maxcount = [Math]::Round( $appcount / $columncount + 0.5) - $paneltotal = $columncount - } - # add ColumnDefinitions to evenly draw colums - $blockXml = "" - $blockXml += $("`r`n" + " " * ($spaces_per_tab * $tab_repeat) + - "") * $paneltotal - $blockXml += $("`r`n" + " " * ($spaces_per_tab * ($tab_repeat - 1))) + - "" + "`r`n" - - # Iterate through 'organizedData' by panel, category, and application - $count = 0 - foreach ($panel in ($organizedData.Keys | Sort-Object)) { - $blockXml += $precal_indent_m1 + "" + "`r`n" - $blockXml += $precal_indent + "" + "`r`n" - $panelcount++ - foreach ($category in ($organizedData[$panel].Keys | Sort-Object)) { - $count++ - if ($columncount -gt 0) { - $panelcount2 = [Int](($count)/$maxcount-0.5) - if ($panelcount -eq $panelcount2 ) { - $blockXml += $precal_indent_p2 + "" + "`r`n" - $blockXml += $precal_indent_p1 + "" + "`r`n" - $blockXml += $precal_indent_p1 + "" + "`r`n" - $blockXml += $precal_indent_p2 + "" + "`r`n" - $panelcount++ - } - } - - # Dot-source the Get-WPFObjectName function - . "$($sync.PSScriptRoot)\functions\private\Get-WPFObjectName.ps1" - - $categorycontent = $($category -replace '^.__', '') - $categoryname = Get-WPFObjectName -type "Label" -name $categorycontent - $blockXml += $("`r`n" + " " * ($spaces_per_tab * $tab_repeat)) + - "" + "`r`n" - $blockXml += $precal_indent_m2 + - "" + "`r`n" - $blockXml += $precal_indent_m2 + - "" + "`r`n" - $blockXml += $precal_indent_m1 + - "" + "`r`n" - $panelcount++ - } - } - - $appInfo = $organizedData[$panel][$category][$appName] - switch ($appInfo.Type) { - "Toggle" { - $blockXml += $precal_indent_m1 + - "" + "`r`n" - $blockXml += $precal_indent + - "" + "`r`n" - $blockXml += $precal_indent + - "" + "`r`n" - } - - "Combobox" { - $blockXml += $precal_indent_m1 + - "" + "`r`n" - $blockXml += $precal_indent + "" + "`r`n" - } - - "Button" { - if ($appInfo.ButtonWidth -ne $null) { - $ButtonWidthStr = "Width=""$($appInfo.ButtonWidth)""" - } - $blockXml += $precal_indent + - "