Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ on:
- main
paths:
- "docs/**"
- "config/tweaks.json"
- "config/feature.json"
- "functions/**"
workflow_dispatch:

permissions:
Expand Down Expand Up @@ -42,6 +45,11 @@ jobs:
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Generate Dev Docs from JSON
shell: pwsh
run: |
Set-Location tools
./devdocs-generator.ps1
- name: Install Node.js dependencies
run: "cd docs && [[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
- name: Cache Restore
Expand Down
13 changes: 8 additions & 5 deletions config/feature.json
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@
"Order": "a019_",
"feature": [],
"InvokeScript": [
"bcdedit /set bootmenupolicy standard"
"bcdedit /set bootmenupolicy standard"
],
"link": "https://winutil.christitus.com/dev/features/features/disablelegacyrecovery"
},
Expand Down Expand Up @@ -252,7 +252,7 @@
"panel": "2",
"Type": "Button",
"ButtonWidth": "300",
"link": "https://winutil.christitus.com/dev/features/legacy-windows-panels/user"
"link": "https://winutil.christitus.com/dev/features/legacy-windows-panels/sound"
},
"WPFPanelSystem": {
"Content": "System Properties",
Expand All @@ -276,22 +276,25 @@
"panel": "2",
"Order": "a083_",
"Type": "Button",
"ButtonWidth": "300"
"ButtonWidth": "300",
"link": "https://winutil.christitus.com/dev/features/powershell-profile-powershell-7--only/installpsprofile"
},
"WPFWinUtilUninstallPSProfile": {
"Content": "Uninstall CTT PowerShell Profile",
"category": "Powershell Profile Powershell 7+ Only",
"panel": "2",
"Order": "a084_",
"Type": "Button",
"ButtonWidth": "300"
"ButtonWidth": "300",
"link": "https://winutil.christitus.com/dev/features/powershell-profile-powershell-7--only/uninstallpsprofile"
},
"WPFWinUtilSSHServer": {
"Content": "Enable OpenSSH Server",
"category": "Remote Access",
"panel": "2",
"Order": "a084_",
"Type": "Button",
"ButtonWidth": "300"
"ButtonWidth": "300",
"link": "https://winutil.christitus.com/dev/features/remote-access/sshserver"
}
}
77 changes: 64 additions & 13 deletions config/tweaks.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"UndoScript": [
"powercfg.exe /hibernate on"
],
"link": "https://winutil.christitus.com/dev/tweaks/essential-tweaks/hibernation"
"link": "https://winutil.christitus.com/dev/tweaks/essential-tweaks/hiber"
},
"WPFTweaksWidget": {
"Content": "Remove Widgets",
Expand All @@ -80,7 +80,55 @@
Invoke-WinUtilExplorerUpdate -action \"restart\"
"
],
"link": "https://winutil.christitus.com/dev/tweaks/essential-tweaks/widgets"
"link": "https://winutil.christitus.com/dev/tweaks/essential-tweaks/widget"
},
"WPFTweaksLaptopHibernation": {
"Content": "Set Hibernation as default (good for laptops)",
"Description": "Most modern laptops have connected standby enabled which drains the battery, this sets hibernation as default which will not drain the battery. See issue https://github.com/ChrisTitusTech/winutil/issues/1399",
"category": "z__Advanced Tweaks - CAUTION",
"panel": "1",
"Order": "a030_",
"registry": [
{
"Path": "HKLM:\\SYSTEM\\CurrentControlSet\\Control\\Power\\PowerSettings\\238C9FA8-0AAD-41ED-83F4-97BE242C8F20\\7bc4a2f9-d8fc-4469-b07b-33eb785aaca0",
"OriginalValue": "1",
"Name": "Attributes",
"Value": "2",
"Type": "DWord"
},
{
"Path": "HKLM:\\SYSTEM\\CurrentControlSet\\Control\\Power\\PowerSettings\\abfc2519-3608-4c2a-94ea-171b0ed546ab\\94ac6d29-73ce-41a6-809f-6363ba21b47e",
"OriginalValue": "0",
"Name": "Attributes ",
"Value": "2",
"Type": "DWord"
}
],
"InvokeScript": [
"
Write-Host \"Turn on Hibernation\"
powercfg.exe /hibernate on

# Set hibernation as the default action
powercfg.exe change standby-timeout-ac 60
powercfg.exe change standby-timeout-dc 60
powercfg.exe change monitor-timeout-ac 10
powercfg.exe change monitor-timeout-dc 1
"
],
"UndoScript": [
"
Write-Host \"Turn off Hibernation\"
powercfg.exe /hibernate off

# Set standby to default values
powercfg.exe change standby-timeout-ac 15
powercfg.exe change standby-timeout-dc 15
powercfg.exe change monitor-timeout-ac 15
powercfg.exe change monitor-timeout-dc 15
"
],
"link": "https://winutil.christitus.com/dev/tweaks/z--advanced-tweaks---caution/laptophibernation"
},
"WPFTweaksLocation": {
"Content": "Disable Location Tracking",
Expand Down Expand Up @@ -1090,7 +1138,7 @@
"panel": "1",
"registry": [
{
"Path":"HKLM:\\SOFTWARE\\Policies\\BraveSoftware\\Brave",
"Path": "HKLM:\\SOFTWARE\\Policies\\BraveSoftware\\Brave",
"Name": "BraveRewardsDisabled",
"Type": "DWord",
"Value": "1",
Expand Down Expand Up @@ -1125,7 +1173,7 @@
"OriginalValue": "<RemoveEntry>"
}
],
"link": "https://winutil.christitus.com/dev/tweaks/z--advanced-tweaks---caution/bravedebloat/"
"link": "https://winutil.christitus.com/dev/tweaks/z--advanced-tweaks---caution/bravedebloat"
},
"WPFTweaksEdgeDebloat": {
"Content": "Edge Debloat",
Expand Down Expand Up @@ -1763,7 +1811,7 @@
"OriginalValue": "1"
}
],
"link": "https://winutil.christitus.com/dev/tweaks/essential-tweaks/storage"
"link": "https://winutil.christitus.com/dev/tweaks/z--advanced-tweaks---caution/storage"
},
"WPFTweaksRemoveCopilot": {
"Content": "Disable Microsoft Copilot",
Expand Down Expand Up @@ -2023,7 +2071,7 @@
"Type": "DWord"
}
],
"link": "https://winutil.christitus.com/dev/tweaks/essential-tweaks/ipv46"
"link": "https://winutil.christitus.com/dev/tweaks/z--advanced-tweaks---caution/ipv46"
},
"WPFTweaksTeredo": {
"Content": "Disable Teredo",
Expand Down Expand Up @@ -2247,7 +2295,7 @@
Invoke-WinUtilExplorerUpdate -action \"restart\"
"
],
"link": "https://winutil.christitus.com/dev/tweaks/customize-preferences/wpftogglestartmenurecommendations"
"link": "https://winutil.christitus.com/dev/tweaks/customize-preferences/startmenurecommendations"
},
"WPFToggleHideSettingsHome": {
"Content": "Remove Settings Home Page",
Expand All @@ -2264,7 +2312,8 @@
"OriginalValue": "show:home",
"DefaultState": "false"
}
]
],
"link": "https://winutil.christitus.com/dev/tweaks/customize-preferences/hidesettingshome"
},
"WPFToggleMouseAcceleration": {
"Content": "Mouse Acceleration",
Expand Down Expand Up @@ -2360,7 +2409,6 @@
],
"link": "https://winutil.christitus.com/dev/tweaks/customize-preferences/newoutlook"
},

"WPFToggleMultiplaneOverlay": {
"Content": "Disable Multiplane Overlay",
"Description": "Disable the Multiplane Overlay which can sometimes cause issues with Graphics Cards.",
Expand All @@ -2377,7 +2425,7 @@
"Type": "DWord"
}
],
"link": "https://winutil.christitus.com/dev/tweaks/customize-preferences/multplaneoverlay"
"link": "https://winutil.christitus.com/dev/tweaks/customize-preferences/multiplaneoverlay"
},
"WPFToggleHiddenFiles": {
"Content": "Show Hidden Files",
Expand Down Expand Up @@ -2530,7 +2578,8 @@
"DefaultState": "false",
"Type": "DWord"
}
]
],
"link": "https://winutil.christitus.com/dev/tweaks/customize-preferences/s3sleep"
},
"WPFOOSUbutton": {
"Content": "Run OO Shutup 10",
Expand Down Expand Up @@ -2615,7 +2664,8 @@

Write-Host Please sign out and back in, or restart your computer to apply the changes!
"
]
],
"link": "https://winutil.christitus.com/dev/tweaks/essential-tweaks/disableexplorerautodiscovery"
},
"WPFToggleDisableCrossDeviceResume": {
"Content": "Cross-Device Resume",
Expand All @@ -2632,6 +2682,7 @@
"DefaultState": "true",
"Type": "DWord"
}
]
],
"link": "https://winutil.christitus.com/dev/tweaks/customize-preferences/disablecrossdeviceresume"
}
}
2 changes: 1 addition & 1 deletion docs/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@ irm "https://christitus.com/win" | iex
```


> [!NOTE]
> [!IMPORTANT]
> Winutil is updated frequently as of the time of writing. Consequently, features and functionalities may evolve, and the documentation may not always reflect the most current images or information.
9 changes: 4 additions & 5 deletions docs/content/dev/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ Update UI

### applications.json Structure

```json
```json {filename="config/applications.json"}
{
"WPFInstall<AppName>": {
"category": "Browsers",
Expand All @@ -217,14 +217,13 @@ Update UI

### tweaks.json Structure

```json
```json {filename="config/tweaks.json"}
{
"WPFTweaksTelemetry": {
"Content": "Disable Telemetry",
"Description": "Disables Microsoft Telemetry",
"category": "Essential Tweaks",
"panel": "1",
"Order": "a003_",
"registry": [
{
"Path": "HKLM:\\SOFTWARE\\Policies\\Microsoft\\Windows\\DataCollection",
Expand Down Expand Up @@ -365,7 +364,7 @@ $sync.form.Dispatcher.Invoke([action]{
### Adding a New Application

1. Edit `config/applications.json`:
```json
```json {filename="config/applications.json"}
{
"WPFInstallNewApp": {
"category": "Utilities",
Expand All @@ -383,7 +382,7 @@ $sync.form.Dispatcher.Invoke([action]{
### Adding a New Tweak

1. Edit `config/tweaks.json`:
```json
```json {filename="config/tweaks.json"}
{
"WPFTweaksNewTweak": {
"Content": "New Tweak",
Expand Down
4 changes: 2 additions & 2 deletions docs/content/dev/features/Features/DisableLegacyRecovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Disable Legacy F8 Boot Recovery"
description: ""
---
```json
```json {filename="config/feature.json",linenos=inline,linenostart=107}
"WPFFeatureDisableLegacyRecovery": {
"Content": "Disable Legacy F8 Boot Recovery",
"Description": "Disables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes.",
Expand All @@ -11,6 +11,6 @@ description: ""
"Order": "a019_",
"feature": [],
"InvokeScript": [
"bcdedit /set bootmenupolicy standard"
"bcdedit /set bootmenupolicy standard"
],
```
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Enable Legacy F8 Boot Recovery"
description: ""
---
```json
```json {filename="config/feature.json",linenos=inline,linenostart=95}
"WPFFeatureEnableLegacyRecovery": {
"Content": "Enable Legacy F8 Boot Recovery",
"Description": "Enables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes.",
Expand Down
4 changes: 2 additions & 2 deletions docs/content/dev/features/Features/RegBackup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: "Enable Daily Registry Backup Task 12.30am"
description: ""
---
```json
"WPFFeatureRegBackup": {
```json {filename="config/feature.json",linenos=inline,linenostart=77}
"WPFFeatureRegBackup": {
"Content": "Enable Daily Registry Backup Task 12.30am",
"Description": "Enables daily registry backup, previously disabled by Microsoft in Windows 10 1803.",
"category": "Features",
Expand Down
4 changes: 2 additions & 2 deletions docs/content/dev/features/Features/Sandbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: "Windows Sandbox"
description: ""
---
```json
"WPFFeaturesSandbox": {
```json {filename="config/feature.json",linenos=inline,linenostart=119}
"WPFFeaturesSandbox": {
"Content": "Windows Sandbox",
"Description": "Windows Sandbox is a lightweight virtual machine that provides a temporary desktop environment to safely run applications and programs in isolation.",
"category": "Features",
Expand Down
5 changes: 3 additions & 2 deletions docs/content/dev/features/Features/dotnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: "All .Net Framework (2,3,4)"
description: ""
---
```json
"WPFFeaturesdotnet": {
```json {filename="config/feature.json",linenos=inline,linenostart=2}
"WPFFeaturesdotnet": {
"Content": "All .Net Framework (2,3,4)",
"Description": ".NET and .NET Framework is a developer platform made up of tools, programming languages, and libraries for building many different types of applications.",
"category": "Features",
Expand All @@ -13,4 +13,5 @@ description: ""
"NetFx4-AdvSrvs",
"NetFx3"
],
"InvokeScript": [],
```
4 changes: 2 additions & 2 deletions docs/content/dev/features/Features/hyperv.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: "HyperV Virtualization"
description: ""
---
```json
"WPFFeatureshyperv": {
```json {filename="config/feature.json",linenos=inline,linenostart=15}
"WPFFeatureshyperv": {
"Content": "HyperV Virtualization",
"Description": "Hyper-V is a hardware virtualization product developed by Microsoft that allows users to create and manage virtual machines.",
"category": "Features",
Expand Down
5 changes: 3 additions & 2 deletions docs/content/dev/features/Features/legacymedia.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: "Legacy Media (WMP, DirectPlay)"
description: ""
---
```json
"WPFFeatureslegacymedia": {
```json {filename="config/feature.json",linenos=inline,linenostart=29}
"WPFFeatureslegacymedia": {
"Content": "Legacy Media (WMP, DirectPlay)",
"Description": "Enables legacy programs from previous versions of windows",
"category": "Features",
Expand All @@ -15,4 +15,5 @@ description: ""
"DirectPlay",
"LegacyComponents"
],
"InvokeScript": [],
```
4 changes: 2 additions & 2 deletions docs/content/dev/features/Features/nfs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: "NFS - Network File System"
description: ""
---
```json
"WPFFeaturenfs": {
```json {filename="config/feature.json",linenos=inline,linenostart=57}
"WPFFeaturenfs": {
"Content": "NFS - Network File System",
"Description": "Network File System (NFS) is a mechanism for storing files on a network.",
"category": "Features",
Expand Down
Loading
Loading