Skip to content

ValerioGc/windows-explorer-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🪟 Windows Explorer Customizer

Customize Windows 10 & 11 appearance and behavior through the system registry.


📘 For detailed information about development, testing, and Docker setup, please refer to the DEVELOPMENT.md file.


🗂️ Table of Contents


📖 Overview

Windows Explorer Customizer is a desktop application built with JavaFX (Java 17) that allows users to easily personalize certain elements of Windows Explorer.
It provides a visual interface to modify registry-based settings safely, without manually editing the Windows Registry.

The project targets Windows 10 and 11, aiming to make common system tweaks accessible and user-friendly.


🧩 Features

  • 🖼 Change Drive Icons (WIP) — Replace default drive icons with custom .ico or .exe icons.
  • 📁 Add Folder Shortcuts to "This PC" (TODO) — Add quick access links to folders under This PC.
  • 🌐 Add Network Shortcuts (TODO) — Add network locations under the Network Locations area.
  • ⚙️ Upcoming Features
    • Custom folder icons
    • Quick access manager
    • Registry backup and restore

🏗️ Technology Stack

Component Description
Language Java 17
UI Framework JavaFX
Build Tool Maven
Target OS Windows 10 / 11
Registry Access Native calls (via JNA)

🚀 How to Run the Project Locally

1️⃣ Prerequisites

Make sure you have the following installed:

  • Java 17+
  • Maven 3.8+
  • Windows 10 or 11

2️⃣ Clone the Repository

git clone https://github.com/your-username/windows-explorer-customizer.git
cd windows-explorer-customizer

3️⃣ Build and Run

mvn clean install
mvn javafx:run

The application should launch a window titled “Windows Explorer Editor”.


🧪 Running Tests

To execute all JUnit tests, simply run:

mvn clean verify

This will compile the project and execute all tests under src/test/java.

If you want to skip the tests (for example, when doing a quick build), use:

mvn clean verify -DskipTests

📊 Code Analysis with SonarQube

The project is configured to work with SonarQube. All required configuration parameters (sonar.projectKey, sonar.projectName, sonar.host.url) are defined inside the pom.xml file.

You only need to provide a valid SonarQube authentication token.

Option 1 — Pass the token directly from the command line

Run the following command from the project root:

mvn clean verify sonar:sonar -Dsonar.login=YOUR_SONAR_TOKEN

⚠️ Replace YOUR_SONAR_TOKEN with your personal token generated from SonarQube.

You can also analyze the project without running the tests using:

mvn sonar:sonar -Dsonar.login=YOUR_SONAR_TOKEN

Option 2 — Use a dedicated Maven profile for your token

You can permanently store your token in your local Maven configuration file ~/.m2/settings.xml (Linux/macOS) or %USERPROFILE%.m2\settings.xml (Windows):

sonar YOUR_SONAR_TOKEN sonar

Then simply run:

mvn clean verify sonar:sonar

The token is now securely stored and automatically used for every analysis.

⚠️ Disclaimer

This software modifies registry entries. Always back up your registry before making changes.
Use at your own risk — the author assumes no responsibility for data loss or system instability.


🪪 Licence

Released under The Unlicense. See LICENSE.

About

desktop application built with JavaFX hat allows users to easily personalize certain elements of Windows Explorer.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors