Move Config files to Config folder

This commit is contained in:
Raphire
2026-03-08 01:34:53 +01:00
parent e8adac1852
commit 1eeacf3351
5 changed files with 20 additions and 20 deletions

View File

@@ -1,7 +1,7 @@
# How to Contribute? # How to Contribute?
We welcome contributions from the community. You can contribute to Win11Debloat by: We welcome contributions from the community. You can contribute to Win11Debloat by:
- Reporting issues and bugs [here](https://github.com/Raphire/Win11Debloat/issues/new?template=bug_report.yml). - Reporting issues and bugs [here](https://github.com/Raphire/Win11Debloat/issues/new?template=bug_report.yml)
- Submitting feature requests [here](https://github.com/Raphire/Win11Debloat/issues/new?template=feature_request.yml) - Submitting feature requests [here](https://github.com/Raphire/Win11Debloat/issues/new?template=feature_request.yml)
- Testing Win11Debloat - Testing Win11Debloat
- Creating a pull request - Creating a pull request
@@ -59,16 +59,16 @@ Understanding the project structure is essential for contributing effectively:
``` ```
Win11Debloat/ Win11Debloat/
├── Win11Debloat.ps1 # Main PowerShell script ├── Win11Debloat.ps1 # Main PowerShell script
├── Apps.json # List of supported apps for removal ├── Scripts/ # Additional PowerShell scripts and functions
├── DefaultSettings.json # Default configuration preset │ └── Get.ps1 # Script used for the quick launch method to automatically download and run Win11debloat
├── LastUsedSettings.json # Last used configuration (generated during use) ├── Config/
├── Assets/ ├── Apps.json # List of supported apps for removal
── Features.json # All features with metadata ── DefaultSettings.json # Default configuration preset
├── Regfiles/ # Registry files for each feature │ ├── Features.json # All features with metadata
├── Schemas/ # XAML Schemas for GUI elements │ └── LastUsedSettings.json # Last used configuration (generated during use)
── Scripts/ # Additional PowerShell scripts and functions ── Regfiles/ # Registry files for each feature
└── Get.ps1 # Script used for the quick launch method to automatically download and run Win11debloat └── Schemas/ # XAML Schemas for GUI elements
``` ```
### Best Practices ### Best Practices
@@ -115,7 +115,7 @@ To add a new app that can be removed via Win11Debloat:
Get-AppxPackage | Select-Object Name, PackageFullName Get-AppxPackage | Select-Object Name, PackageFullName
``` ```
2. **Edit `Apps.json`**: Add a new entry to the `"Apps"` array: 2. **Edit `Config/Apps.json`**: Add a new entry to the `"Apps"` array:
```json ```json
{ {
"FriendlyName": "Display Name", "FriendlyName": "Display Name",
@@ -132,7 +132,7 @@ To add a new app that can be removed via Win11Debloat:
### Adding a New Feature ### Adding a New Feature
Features are defined in `Assets/Features.json` and can modify Windows settings via registry files or PowerShell commands. Features are defined in `Config/Features.json` and can modify Windows settings via registry files or PowerShell commands.
> [!NOTE] > [!NOTE]
> For simple features that just include a registry change, no actual coding is required in the main script except for adding the corresponding command-line parameters. The GUI is automatically built using the information in the Features.json file. > For simple features that just include a registry change, no actual coding is required in the main script except for adding the corresponding command-line parameters. The GUI is automatically built using the information in the Features.json file.
@@ -167,7 +167,7 @@ If your feature requires more than just applying a registry file, add custom log
#### 2. Add Feature to Features.json #### 2. Add Feature to Features.json
Add your feature to the `"Features"` array in `Assets/Features.json`: Add your feature to the `"Features"` array in `Config/Features.json`:
```json ```json
{ {
@@ -211,7 +211,7 @@ Add a corresponding parameter to both `Win11Debloat.ps1` AND `Scripts/Get.ps1`,
To add a new category for organizing features: To add a new category for organizing features:
- Add a new category entry to the `"Categories"` array in `Assets/Features.json`: - Add a new category entry to the `"Categories"` array in `Config/Features.json`:
```json ```json
{ {
"Name": "Your Category Name", "Name": "Your Category Name",

View File

@@ -103,10 +103,11 @@ param (
# Define script-level variables & paths # Define script-level variables & paths
$script:Version = "2026.03.07" $script:Version = "2026.03.07"
$script:DefaultSettingsFilePath = "$PSScriptRoot/DefaultSettings.json" $script:AppsListFilePath = "$PSScriptRoot/Config/Apps.json"
$script:AppsListFilePath = "$PSScriptRoot/Apps.json" $script:DefaultSettingsFilePath = "$PSScriptRoot/Config/DefaultSettings.json"
$script:SavedSettingsFilePath = "$PSScriptRoot/LastUsedSettings.json" $script:FeaturesFilePath = "$PSScriptRoot/Config/Features.json"
$script:CustomAppsListFilePath = "$PSScriptRoot/CustomAppsList" $script:SavedSettingsFilePath = "$PSScriptRoot/Config/LastUsedSettings.json"
$script:CustomAppsListFilePath = "$PSScriptRoot/Config/CustomAppsList"
$script:DefaultLogPath = "$PSScriptRoot/Logs/Win11Debloat.log" $script:DefaultLogPath = "$PSScriptRoot/Logs/Win11Debloat.log"
$script:RegfilesPath = "$PSScriptRoot/Regfiles" $script:RegfilesPath = "$PSScriptRoot/Regfiles"
$script:AssetsPath = "$PSScriptRoot/Assets" $script:AssetsPath = "$PSScriptRoot/Assets"
@@ -116,7 +117,6 @@ $script:MessageBoxSchema = "$PSScriptRoot/Schemas/MessageBoxWindow.xaml"
$script:AboutWindowSchema = "$PSScriptRoot/Schemas/AboutWindow.xaml" $script:AboutWindowSchema = "$PSScriptRoot/Schemas/AboutWindow.xaml"
$script:ApplyChangesWindowSchema = "$PSScriptRoot/Schemas/ApplyChangesWindow.xaml" $script:ApplyChangesWindowSchema = "$PSScriptRoot/Schemas/ApplyChangesWindow.xaml"
$script:SharedStylesSchema = "$PSScriptRoot/Schemas/SharedStyles.xaml" $script:SharedStylesSchema = "$PSScriptRoot/Schemas/SharedStyles.xaml"
$script:FeaturesFilePath = "$script:AssetsPath/Features.json"
$script:ControlParams = 'WhatIf', 'Confirm', 'Verbose', 'Debug', 'LogPath', 'Silent', 'Sysprep', 'User', 'NoRestartExplorer', 'RunDefaults', 'RunDefaultsLite', 'RunSavedSettings', 'RunAppsListGenerator', 'CLI', 'AppRemovalTarget' $script:ControlParams = 'WhatIf', 'Confirm', 'Verbose', 'Debug', 'LogPath', 'Silent', 'Sysprep', 'User', 'NoRestartExplorer', 'RunDefaults', 'RunDefaultsLite', 'RunSavedSettings', 'RunAppsListGenerator', 'CLI', 'AppRemovalTarget'