Merge branch 'Progress-bar' of https://github.com/MyDrift-user/winutil into Progress-bar

docs/KnownIssues.md

@@ -0,0 +1,53 @@
+## Known Issues and Fixes
+
+### Launch Issues:
+
+- Windows Security (formerly Defender) and other anti-virus software are known to block the script. The script gets flagged due to the fact that it requires administrator privileges & makes drastic system changes.
+  - If possible: Allow script in Anti-Virus software settings.
+
+- If you are having TLS 1.2 issues, or are having trouble resolving `christitus.com/win` then run with the following command:
+
+```ps1
+[Net.ServicePointManager]::SecurityProtocol=[Net.SecurityProtocolType]::Tls12;iex(New-Object Net.WebClient).DownloadString('https://github.com/ChrisTitusTech/winutil/releases/latest/download/winutil.ps1')
+```
+
+- If you are unable to resolve `christitus.com/win` and are getting  errors launching the tool, it might be due to India blocking GitHub's content domain and preventing downloads.
+  - Source: <https://timesofindia.indiatimes.com/gadgets-news/github-content-domain-blocked-for-these-indian-users-reports/articleshow/96687992.cms>
+
+If you are still having issues try using a **VPN**, or changing your **DNS provider** to:
+
+| `1.1.1.1` | `1.0.0.1` | or  | `8.8.8.8` | `8.8.4.4` |
+|---------|---------|-----|---------|---------|
+
+- Script doesn't run/PowerShell crashes:
+  1. Press Windows Key+X and select 'PowerShell (Admin)' (Windows 10) or 'Windows Terminal (Admin)' (Windows 11)
+  2. Run:
+  ```ps1
+  Set-ExecutionPolicy Unrestricted -Scope Process -Force
+  ```
+  3. Run:
+  ```ps1
+  irm christitus.com/win | iex
+  ```
+
+### Other Issues:
+
+- Windows taking longer to shut down:
+  - [#69](https://github.com/ChrisTitusTech/winutil/issues/69) Turn on fast startup: Press Windows key + R, then type:
+  ```
+  control /name Microsoft.PowerOptions /page pageGlobalSettings
+  ```
+  - If that doesn't work, Disable Hibernation: Press Windows Key+X and select 'PowerShell (Admin)' (Windows 10) or 'Windows Terminal (Admin)' (Windows 11) and enter:
+  ```ps1
+  powercfg /H off
+  ```
+- [#69](https://github.com/ChrisTitusTech/winutil/issues/69) [95](https://github.com/ChrisTitusTech/winutil/issues/95) [#232](https://github.com/ChrisTitusTech/winutil/issues/232) Windows Search does not work: Enable Background Apps
+- [#198](https://github.com/ChrisTitusTech/winutil/issues/198) Xbox Game Bar Activation Broken: Set the Xbox Accessory Management Service to Automatic
+```ps1
+Get-Service -Name "XboxGipSvc" | Set-Service -StartupType Automatic
+```
+
+- Winget requires interaction on first run: Manually type 'y' and 'enter' into the PowerShell console to continue
+- (Windows 11) Quick Settings no longer works: Launch the Script and click 'Enable Action Center'
+
+- Explorer no longer launches: Go to Control Panel, File Explorer Options, Change the 'Open File Explorer to' option to 'This PC'.

docs/contribute.md

@@ -0,0 +1,57 @@
+# How to Contribute?
+
+## Issues
+
+* If you encounter any challenges or problems with the script, I kindly request that you submit them via the "Issues" tab on the GitHub repository. By filling out the provided template, you can provide specific details about the issue, allowing me (and others in the community) to promptly address any bugs, or consider feature requests.
+
+## Contribute Code
+
+* Pull Requests are now handled directly on the **MAIN branch**. This was done since we can now select specific releases to launch via releases in GitHub.
+
+* If you're doing code changes, then you can submit a PR to `main` branch, but I am very selective about these.
+
+> [!WARNING]
+> Do not use a code formatter, massive amounts of line changes, and make multiple feature changes.
+> EACH FEATURE CHANGE SHOULD BE IT'S OWN Pull Request!
+
+* When creating pull requests, it is essential to thoroughly document all changes made. This includes, but not limited to, documenting any additions made to the `tweaks` section and corresponding `undo tweak`, so users are able to remove the newly added tweaks if necessary, and comprehensive documentation is required for all code changes, document your changes and briefly explain why you made your changes in your Pull Request Description. Failure to adhere to this format may result in denial of the pull request. Additionally, Any code lacking sufficient documentation may also be denied.
+
+* By following these guidelines, we can maintain a high standard of quality and ensure that the codebase remains organized and well-documented.
+
+> [!NOTE]
+> When creating a function, please include "WPF" or "WinUtil" in the file name so it can be loaded into the runspace.
+
+## Walk through
+
+### Fork the Repo
+* Fork the WinUtil Repository [here](https://github.com/ChrisTitusTech/winutil) to create a copy that will be available in your Repository-list.
+![Fork](assets/ForkButton.png)
+
+### Clone the Fork 
+* While you can make your changes directly through the Web, we recommend cloning the repo to your device to test your fork easily. 
+* Using the application GitHub Desktop (available in WinUtil) you can easily manage your repos locally. You can do it using other tools like git-cli (available in WinUtil), we recommend GitHub Desktop for ease of use.
+* Install GitHub Desktop if not already installed
+* Log in using the same GitHub account u used to fork WinUtil
+* Choose the fork under "Your Repositories" and press "clone {repo name}"
+* Create a new Branch and name it something relatable to your changes,
+
+* Now you can modify WinUtil to your liking using your prefered text editor.
+
+
+### Testing your changes
+* To test to see if your changes work as intended run following commands in a powershell teminal:
+
+* Change the directory where you are running the commands to the forked project.
+* `cd {path to the folder with the compile.ps1}`
+* Run following command to compile and run Winutil
+* `.\Compile.ps1 -run`
+* After seeing that your changes work properly feel free to commit the changes to the repository and make a PR, for help on that follow the documentation below.
+
+### Commiting the changes
+* Commit your changes once you are fine with the result
+* Push the changes to "upload" them to your fork on github.com.
+
+### Making a PR
+* To make a PR on your repo under a new branch linking to the main branch a button will show and say Preview and Create pull request. Click that button and fill in all information that is provided on the template. Once all the information is filled in correctly check your PR to make sure there is not a WinUtil.ps1 file attached to the PR. Once everything is good make the PR and wait for Chris (The Maintainer) to accept or deny your PR. Once it is accepted in by Chris you will be able to see your changes in the /windev build.
+* If you do not see your feature in the main /win build that is fine. As all new changes go into the /windev build to make sure everything is working ok before going fully public.
+* Congrats you just submitted your first PR. Thank you so much for contributing to WinUtil.

docs/faq.md

@@ -0,0 +1,4 @@
+# FAQ's
+
+## How do I uninstall WinUtil?
+* You do not have to uninstall WinUtil. As it is a script you run from Powershell it only loads into your RAM. This means as soon as you close WinUtil it will be deleted off your system.

docs/index.md

@@ -0,0 +1,12 @@
+# Welcome to Chris Titus WinUtil Official Documentation!
+
+[![](https://dcbadge.limes.pink/api/server/https://discord.gg/RUbZUZyByQ)](https://discord.gg/RUbZUZyByQ)
+
+## Running
+
+There are 4 ways to run WinUtil. The 4 ways goes as follows:
+
+* `irm christitus.com/win | iex` - Runs WinUtil from ChrisTitus's website using the latest Full Releases.
+* `irm https://github.com/ChrisTitusTech/winutil/releases/latest/download/winutil.ps1 | iex` - Runs WinUtil from github using the latest Full Release.
+* `irm christitus.com/windev | iex` - Runs WinUtil from ChrisTitus website using the latest Pre-Release.
+* `irm https://github.com/ChrisTitusTech/winutil/releases/latest/download/windev.ps1 | iex` - Runs WinUtil from github using the latest Pre-Release.

docs/updates.md

@@ -0,0 +1,3 @@
+# Update Log
+
+#

docs/userguide.md

@@ -0,0 +1,159 @@
+# User Guide
+
+## Overview
+* short one
+
+
+## Walkthrough
+
+### Program
+
+#### Installation & Updates
+* To install programs select the programs you wish to install or update like the picture below.
+![Program Install](assets/ProgramInstall.png)
+* Once you have selected the programs you wish to install click the select Install/Upgrade Selected button as seen below.
+![Program Install Button](assets/ProgramInstallButton.png)
+
+#### Upgrade All
+* Press the button to upgrade all installed programs that are supported by WinGet, there is no selection needed.
+
+#### Uninstall
+* To uninstall programs select the programs you wish to uninstall like the picture below.
+![Program Uninstall](assets/ProgramInstall.png)
+* Once you have selected the programs you wish to uninstall click the select Uninstall Selected button as seen below.
+![Program Uninstall Button](assets/ProgramUninstall.png)
+
+#### Get Installed
+* Checks for installed programs that are supported by WinGet and selects them in the Utility.
+
+#### Clear Selection
+* Clears ur current selection so no program is checked.
+
+### Tweaks
+
+#### Tweaks Addition
+* To enable tweaks on your system select Tweaks at the top next to Install.
+* Then you can select what tweaks you want adding to your system. We do have some presets you can select from at the top you can see this in the picture below. 
+![Tweaks Screen](assets/TweaksScreen.PNG)
+* After you have chosen your tweaks click the Run Tweaks button at the bottom of the screen.
+
+#### Tweaks Removal
+* To disable tweaks on your system select Tweaks at the top next to Install.
+* Then you can select what tweaks you want removing from your system.
+* After you have chosen your tweaks you want to remove click the Undo Selected Tweaks button at the bottom of the screen.
+
+#### Essential Tweaks
+* The Tweaks under the Essential
+
+#### Advanced Tweaks - CAUTION
+
+#### O&O Shutup
+
+#### DNS
+
+#### Customize Preferences
+
+#### Performance Plans
+
+#### Shortcuts
+
+
+![Tweaks Screen](assets/TweaksScreen.PNG)
+
+### Config
+
+#### Features
+* Install the most used Windows Features by checking the checkbox and clicking "Install Features" to install them
+
+#### Fixes
+* Quick Fixes for your system if you are having Issues.
+
+* Set Up Autologin
+* Reset Windows Update
+* Reset Network
+* System Corruption Scan
+* WinGet Reinstall
+* Remove Adobe Creative Cloud
+
+#### Legacy Windows Panels
+
+### Updates | Not working rn
+
+### MicroWin
+
+**MicroWin** lets you customize your Windows 10 and 11 installation images by debloating them however you want.
+
+![MicroWin](assets/MicroWinScreen.png)
+
+#### Basic usage
+
+1. Specify the source Windows ISO to customize
+
+	* If you don't have a Windows ISO file prepared, you can download it using the Media Creation Tool for the respective Windows version. [Here](https://go.microsoft.com/fwlink/?linkid=2156295) is the Windows 11 version, and [here](https://go.microsoft.com/fwlink/?LinkId=2265055) is the Windows 10 version
+
+2. Configure the debloat process
+3. Specify the target location for the new ISO file
+4. Let the magic happen!
+
+**NOTE:** this feature is still in development and you may encounter some issues with the generated images. If that happens, don't hesitate to report an issue!
+
+#### Options
+
+* **Download oscdimg.exe from CTT GitHub repo** will grab a OSCDIMG executable from the GitHub repository instead of a Chocolatey package
+
+	OSCDIMG is the tool that lets the program create ISO images. Typically, you would find this in the [Windows Assessment and Deployment Kit](https://learn.microsoft.com/en-us/windows-hardware/get-started/adk-install)
+
+* Selecting a scratch directory will copy the contents of the ISO file to the directory you specify instead of an automatically generated folder on 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 were permanent ones or had 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 case 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. On that regard, don't install AVs with bad reputation 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)
+
+
+##### Driver integration options
+
+* **Inject drivers** will add the drivers in the folder that you specify to the target Windows image
+* **Import drivers from 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 of 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
+
+
+##### Ventoy options
+
+* **Copy to Ventoy** will copy the target ISO file to any USB drive with [Ventoy](https://ventoy.net/en/index.html) installed
+
+	Ventoy is a solution that lets you boot to any ISO file stored in a drive. Think of it as having multiple bootable USBs in one. Do note though that your drive needs to have enough free space for the target ISO file
+	
+
+## Automation
+
+* Some features are available through automation. This allows you to save your config file pass it to Winutil walk away and come back to a finished system. Here is how you can set it up currently with Winutil >24.01.15
+
+* On the Install Tab, click "Get Installed", this will get all installed apps **supported by Winutil** on the system
+![GetInstalled](assets/Get-Installed.png)
+* Click on the Settings cog in the upper right corner and chose Export, chose file file and location, this will export the setting file.
+![SettingsExport](assets/Settings-Export.png)
+* Copy this file to a USB or somewhere you can use after Windows installation.
+* Use Microwin tab to create a custom Windows image.
+* Install the Windows image.
+* In the new Windows, Open PowerShell in the admin mode and run command to automatically apply tweaks and install apps from the config file.
+* ``` iex "& { $(irm christitus.com/win) } -Config [path-to-your-config] -Run" ```
+* Have a cup of coffee! Come back when it's done.