From 1c4ecc23c631317e4483c0abfb1b7882dd79bfbf Mon Sep 17 00:00:00 2001 From: Jay <65828559+Jay-o-Way@users.noreply.github.com> Date: Wed, 1 Apr 2026 23:08:38 +0200 Subject: [PATCH] Cleanup md files (root folder) (#46582) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Summary of the Pull Request Cleaning up Markdown files, including: - [Learn Authoring Pack](https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-authoring-pack) in Visual Studio Code - consolidating list item bullets - spelling and grammar - HTML tables and links to Markdown To do: - [x] Sentence casing in headers https://learn.microsoft.com/en-us/style-guide/capitalization#sentence-style-capitalization-in-titles-and-headings (Copilot quotum was reached 🤓) - [ ] NOTICE.md: text in code blocks or not?? --------- Co-authored-by: Niels Laute --- AGENTS.md | 39 +- COMMUNITY.md | 121 +-- CONTRIBUTING.md | 40 +- DATA_AND_PRIVACY.md | 1710 ++++++++++--------------------------------- NOTICE.md | 87 ++- README.md | 70 +- SECURITY.md | 24 +- SUPPORT.md | 17 +- 8 files changed, 581 insertions(+), 1527 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 1bb8fdee51..df5a43265f 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -3,7 +3,7 @@ description: 'Top-level AI contributor guidance for developing PowerToys - a col applyTo: '**' --- -# PowerToys – AI Contributor Guide +# PowerToys – AI contributor guide This is the top-level guidance for AI contributions to PowerToys. Keep changes atomic, follow existing patterns, and cite exact paths in PRs. @@ -26,13 +26,15 @@ For architecture details and module types, see [Architecture Overview](doc/devdo ## Conventions For detailed coding conventions, see: + - [Coding Guidelines](doc/devdocs/development/guidelines.md) – Dependencies, testing, PR management - [Coding Style](doc/devdocs/development/style.md) – Formatting, C++/C#/XAML style rules - [Logging](doc/devdocs/development/logging.md) – C++ spdlog and C# Logger usage -### Component-Specific Instructions +### Component-specific instructions These instruction files are automatically applied when working in their respective areas: + - [Runner & Settings UI](.github/instructions/runner-settings-ui.instructions.md) – IPC contracts, schema migrations - [Common Libraries](.github/instructions/common-libraries.instructions.md) – ABI stability, shared code guidelines @@ -44,7 +46,7 @@ These instruction files are automatically applied when working in their respecti - Windows 10 1803+ (April 2018 Update or newer) - Initialize submodules once: `git submodule update --init --recursive` -### Build Commands +### Build commands | Task | Command | |------|---------| @@ -52,7 +54,7 @@ These instruction files are automatically applied when working in their respecti | Build current folder | `tools\build\build.cmd` | | Build with options | `build.ps1 -Platform x64 -Configuration Release` | -### Build Discipline +### Build discipline 1. One terminal per operation (build → test). Do not switch or open new ones mid-flow 2. After making changes, `cd` to the project folder that changed (`.csproj`/`.vcxproj`) @@ -62,9 +64,10 @@ These instruction files are automatically applied when working in their respecti 6. On failure, read the errors log: `build...errors.log` 7. Do not start tests or launch Runner until the build succeeds -### Build Logs +### Build logs Located next to the solution/project being built: + - `build...errors.log` – errors only (check this first) - `build...all.log` – full log - `build...trace.binlog` – for MSBuild Structured Log Viewer @@ -73,18 +76,18 @@ For complete details, see [Build Guidelines](tools/build/BUILD-GUIDELINES.md). ## Tests -### Test Discovery +### Test discovery - Find test projects by product code prefix (e.g., `FancyZones`, `AdvancedPaste`) - Look for sibling folders or 1-2 levels up named `*UnitTests` or `*UITests` -### Running Tests +### Running tests 1. **Build the test project first**, wait for exit code 0 2. Run via VS Test Explorer (`Ctrl+E, T`) or `vstest.console.exe` with filters 3. **Avoid `dotnet test`** in this repo – use VS Test Explorer or vstest.console.exe -### Test Types +### Test types | Type | Requirements | Setup | |------|--------------|-------| @@ -92,13 +95,13 @@ For complete details, see [Build Guidelines](tools/build/BUILD-GUIDELINES.md). | UI Tests | WinAppDriver v1.2.1, Developer Mode | Install from [WinAppDriver releases](https://github.com/microsoft/WinAppDriver/releases/tag/v1.2.1) | | Fuzz Tests | OneFuzz, .NET 8 | See [Fuzzing Tests](doc/devdocs/tools/fuzzingtesting.md) | -### Test Discipline +### Test discipline 1. Add or adjust tests when changing behavior 2. If tests skipped, state why (e.g., comment-only change, string rename) 3. New modules handling file I/O or user input **must** implement fuzzing tests -### Special Requirements +### Special requirements - **Mouse Without Borders**: Requires 2+ physical computers (not VMs) - **Multi-monitor utilities**: Test with 2+ monitors, different DPI settings @@ -107,14 +110,14 @@ For UI test setup details, see [UI Tests](doc/devdocs/development/ui-tests.md). ## Boundaries -### Ask for Clarification When +### Ask for clarification when - Ambiguous spec after scanning relevant docs - Cross-module impact (shared enum/struct) is unclear - Security, elevation, or installer changes involved - GPO or policy handling modifications needed -### Areas Requiring Extra Care +### Areas requiring extra care | Area | Concern | Reference | |------|---------|-----------| @@ -123,7 +126,7 @@ For UI test setup details, see [UI Tests](doc/devdocs/development/ui-tests.md). | Installer files | Release impact | Careful review required | | Elevation/GPO logic | Security | Confirm no regression in policy handling | -### What NOT to Do +### What not to do - Don't merge incomplete features into main (use feature branches) - Don't break IPC/JSON contracts without updating both runner and settings-ui @@ -143,23 +146,27 @@ Before finishing, verify: ## Documentation Index -### Core Architecture +### Core architecture + - [Architecture Overview](doc/devdocs/core/architecture.md) - [Runner](doc/devdocs/core/runner.md) - [Settings System](doc/devdocs/core/settings/readme.md) - [Module Interface](doc/devdocs/modules/interface.md) ### Development + - [Coding Guidelines](doc/devdocs/development/guidelines.md) - [Coding Style](doc/devdocs/development/style.md) - [Logging](doc/devdocs/development/logging.md) - [UI Tests](doc/devdocs/development/ui-tests.md) - [Fuzzing Tests](doc/devdocs/tools/fuzzingtesting.md) -### Build & Tools +### Build & tools + - [Build Guidelines](tools/build/BUILD-GUIDELINES.md) - [Tools Overview](doc/devdocs/tools/readme.md) -### Instructions (Auto-Applied) +### Instructions (auto-applied) + - [Runner & Settings UI](.github/instructions/runner-settings-ui.instructions.md) - [Common Libraries](.github/instructions/common-libraries.instructions.md) diff --git a/COMMUNITY.md b/COMMUNITY.md index dbbc413f68..acee03aefb 100644 --- a/COMMUNITY.md +++ b/COMMUNITY.md @@ -1,84 +1,109 @@ # Community -The PowerToys team is extremely grateful to have the support of an amazing active community. The work you do is incredibly important. PowerToys wouldn’t be near what it is without your help filing bugs, updating documentation, guiding the design, or writing features. We want to say thanks and to recognize your work. This is a living document dedicated to highlighting the high impact community members and their contributions. +The PowerToys team is extremely grateful to have the support of an amazing active community. The work you do is incredibly important. PowerToys wouldn't be near what it is without your help filing bugs, updating documentation, guiding the design, or writing features. We want to say thanks and to recognize your work. This is a living document dedicated to highlighting the high impact community members and their contributions. -Names are in alphabetical order based on first name. +Names are in alphabetical order, based on first name. ## High impact community members -### [@cgaarden](https://github.com/cgaarden) - [Christian Gaarden Gaardmark](https://www.onegreatworld.com) -Christian contributed New+ utility +### [@cgaarden](https://github.com/cgaarden) - [Christian Gaarden Gaardmark](https://www.onegreatworld.com) + +Christian contributed the New+ utility ### [@CleanCodeDeveloper](https://github.com/CleanCodeDeveloper) + CleanCodeDeveloper helped do massive amounts of code stability and image resizer work. ### [@plante-msft](https://github.com/plante-msft) - Connor Plante + Connor was the creator of Workspaces and helped create Command Palette (PowerToys Run v2) ### [@damienleroy](https://github.com/damienleroy) - [Damien Leroy](https://www.linkedin.com/in/Damien-Leroy-b2734416a/) + Damien has helped out by developing and contributing the Quick Accent utility. ### [@daverayment](https://github.com/daverayment) - [David Rayment](https://www.linkedin.com/in/david-rayment-168b5251/) + Dave has helped improve the experience inside of Peek by adding in new features and fixing bugs. ### [@davidegiacometti](https://github.com/davidegiacometti) - [Davide Giacometti](https://www.linkedin.com/in/davidegiacometti/) + Davide has helped fix multiple bugs, added new utilities, features, as well as help us with the ARM64 effort by porting applications to .NET Core. ### [@ethanfangg](https://github.com/ethanfangg) - Ethan Fang + Ethan helped run PowerToys and worked on improving and prototyping out next generation PowerToys ### [@franky920920](https://github.com/franky920920) - [Franky Chen](https://frankychen.net) + Franky has helped triaging, discussing, and creating a substantial number of issues and contributed features/fixes to PowerToys. ### [@htcfreek](https://github.com/htcfreek) - Heiko + Heiko has helped triaging, discussing, and creating a substantial number of issues and contributed features/fixes to PowerToys. ### [@Jay-o-Way](https://github.com/Jay-o-Way) - Jay + Jay has helped triaging, discussing, creating a substantial number of issues and PRs. ### [@jefflord](https://github.com/Jjefflord) - Jeff Lord -Jeff added in multiple new features into Keyboard manager, such as key chord support and launching apps. He also contributed multiple features/fixes to PowerToys. + +Jeff added multiple new features to Keyboard Manager, such as key chord support and launching apps. He also contributed multiple features/fixes to PowerToys. ### [@snickler](https://github.com/snickler) - [Jeremy Sinclair](http://sinclairinat0r.com) -Jeremy has helped drive large sums of the ARM64 support inside PowerToys + +Jeremy has helped drive substantial ARM64 support within PowerToys. ### [@jiripolasek](https://github.com/jiripolasek) - [Jiří Polášek](https://github.com/jiripolasek) + Jiří has contributed a massive number of features and improvements to Command Palette, including drag & drop support, custom themes, Web Search enhancements, Remote Desktop extension fixes, and many UX improvements. ### [@TheJoeFin](https://github.com/TheJoeFin) - [Joe Finney](https://joefinapps.com) -Joe has helped triaging, discussing, issues as well as fixing bugs and building features for Text Extractor. + +Joe has helped with triaging, discussing issues as well as fixing bugs and building features for Text Extractor. ### [@joadoumie](https://github.com/joadoumie) - Jordi Adoumie + Jordi helped innovate amazing new features into Advanced Paste and helped create Command Palette (PowerToys Run v2) - + ### [@jsoref](https://github.com/jsoref) - [Josh Soref](https://check-spelling.dev/) + Helping keep our spelling correct :) ### [@martinchrzan](https://github.com/martinchrzan/) - Martin Chrzan + Color Picker is from Martin. ### [@mikeclayton](https://github.com/mikeclayton) - [Michael Clayton](https://michael-clayton.com) + Michael contributed the [initial version](https://github.com/microsoft/PowerToys/issues/23216) of the Mouse Jump tool and [a number of updates](https://github.com/microsoft/PowerToys/pulls?q=is%3Apr+author%3Amikeclayton) based on his FancyMouse utility. ### [@Noraa-Junker](https://github.com/Noraa-Junker) - [Noraa Junker](https://noraajunker.ch) + Noraa has helped triaging, discussing, and creating a substantial number of issues and contributed features/fixes. Noraa was the primary person for helping build the File Explorer preview pane handler for developer files. ### [@pedrolamas](https://github.com/pedrolamas/) - Pedro Lamas -Pedro helped create the thumbnail and File Explorer previewers for 3D files like STL and GCode. If you like 3D printing, these are very helpful. + +Pedro helped create the thumbnail and File Explorer previewers for 3D files like STL and GCode. If you like 3D printing, these are very helpful. ### [@PesBandi](https://github.com/PesBandi/) - PesBandi + PesBandi has helped do massive amounts of Quick Accent and bug fixes. ### [@riverar](https://github.com/riverar) - [Rafael Rivera](https://withinrafael.com/) -Rafael has helped do the [upgrade from CppWinRT 1.x to 2.0](https://github.com/microsoft/PowerToys/issues/1907). He directly provided feedback to the CppWinRT team for bugs from this migration as well. + +Rafael has helped do the [upgrade from CppWinRT 1.x to 2.0](https://github.com/microsoft/PowerToys/issues/1907). He directly provided feedback to the CppWinRT team for bugs from this migration as well. ### [@royvou](https://github.com/royvou) + Roy has helped out contributing multiple features to PowerToys Run ### [@ThiefZero](https://github.com/ThiefZero) -ThiefZero has helped out contributing a features to PowerToys Run such as the unit converter plugin + +ThiefZero has helped contribute features to PowerToys Run, such as the unit converter plugin ### [@TobiasSekan](https://github.com/TobiasSekan) - Tobias Sekan + Tobias Sekan has helped out contributing features to PowerToys Run such as Settings plugin, Registry plugin ## Open source projects @@ -94,7 +119,8 @@ Their fork of Wox was the base of PowerToys Run. Initial base of jjw24's fork, which makes it the base of PowerToys Run. ### [Text-Grab](https://github.com/TheJoeFin/Text-Grab) - Joseph Finney -Joe helped develop and contribute to the Text Extractor utility. It is directly based on his Text Grab application. + +Joe helped develop and contribute to the Text Extractor utility. It is directly based on his Text Grab application. ## Microsoft community members @@ -102,7 +128,7 @@ We would like to also directly call out some extremely helpful Microsoft employe ### [@betsegaw](https://github.com/betsegaw/) - [Betsegaw Tadele](http://www.dreamsofameaningfullife.com/) -Window Walker, inside PowerToys Run, is from Beta. +Window Walker, inside PowerToys Run, is from Beta. ### [@TheMrJukes](https://github.com/TheMrJukes/) - Bret Anderson @@ -125,6 +151,7 @@ PowerToys Awake is a tool to keep your computer awake. Randy contributed Registry Preview and some very early conversations about keyboard remapping. ### [@cinnamon-msft](https://github.com/cinnamon-msft) - Kayla Cinnamon + Kayla was a former lead for PowerToys and helped create multiple utilities, maintained the GitHub repo, and collaborated with the community to improve the overall product ### [@oldnewthing](https://github.com/oldnewthing) - Raymond Chen @@ -135,46 +162,48 @@ Find My Mouse is based on Raymond Chen's SuperSonar. Crop And Lock is based on the original work of Robert Mikhayelyan, with Program Manager support from [@kevinguo305](https://github.com/kevinguo305) - Kevin Guo. -ZoomIt's Video Recording Session code is based on Robert Mikhayelyan's https://github.com/robmikh/capturevideosample code. +ZoomIt's Video Recording Session code is based on Robert Mikhayelyan's code. ### Microsoft InVEST team -This amazing team helped PowerToys develop PowerToys Run and Keyboard manager as well as update our Settings to v2. @alekhyareddy28, @arjunbalgovind, @jyuwono @laviusmotileng-ms, @ryanbodrug-microsoft, @saahmedm, @somil55, @traies, @udit3333 +This amazing team helped PowerToys develop PowerToys Run and Keyboard manager as well as update our Settings to v2. @alekhyareddy28, @arjunbalgovind, @jyuwono @laviusmotileng-ms, @ryanbodrug-microsoft, @saahmedm, @somil55, @traies, @udit3333 ## Mouse Without Borders original contributors -*Project creator: Truong Do (Đỗ Đức Trường)* + +Project creator: Truong Do (Đỗ Đức Trường) Other contributors: - * Microsoft Garage: Quinn Hawkins, Michael Low, Joe Coplen, Nino Yuniardi, Gwyneth Marshall, David Andrews, Karen Luecking - * Peter Hauge - Visual Studio - * Bruce Dawson - Windows Fundamentals - * Alan Myrvold - Office Security - * Adrian Garside - WEX - * Scott Bradner - Surface - * Aleks Gershaft - Windows Azure - * Chinh Huynh - Windows Azure - * Long Nguyen - Data Center - * Triet Le - Cloud Engineering - * Luke Schoen - Excel - * Bao Nguyen - Bing - * Ross Nichols - Windows - * Ryan Baltazar - Windows - * Ed Essey - The Garage - * Mario Madden - The Garage - * Karthick Mahalingam - ACE - * Pooja Kamra - ACE - * Justin White - SA - * Chris Ransom - SA - * Mike Ricks - Red Team - * Randy Santossio - Surface - * Ashish Sen Jaswal - Device Health - * Zoltan Harmath - Security Tools - * Luciano Krigun - Security Products - * Jo Hemmerlein - Red Team - * Chris Johnson - Surface Hub - * Loren Ponten - Surface Hub - * Paul Schmitt - WWL - * And many other Users! + +- Microsoft Garage: Quinn Hawkins, Michael Low, Joe Coplen, Nino Yuniardi, Gwyneth Marshall, David Andrews, Karen Luecking +- Peter Hauge - Visual Studio +- Bruce Dawson - Windows Fundamentals +- Alan Myrvold - Office Security +- Adrian Garside - WEX +- Scott Bradner - Surface +- Aleks Gershaft - Windows Azure +- Chinh Huynh - Windows Azure +- Long Nguyen - Data Center +- Triet Le - Cloud Engineering +- Luke Schoen - Excel +- Bao Nguyen - Bing +- Ross Nichols - Windows +- Ryan Baltazar - Windows +- Ed Essey - The Garage +- Mario Madden - The Garage +- Karthick Mahalingam - ACE +- Pooja Kamra - ACE +- Justin White - SA +- Chris Ransom - SA +- Mike Ricks - Red Team +- Randy Santossio - Surface +- Ashish Sen Jaswal - Device Health +- Zoltan Harmath - Security Tools +- Luciano Krigun - Security Products +- Jo Hemmerlein - Red Team +- Chris Johnson - Surface Hub +- Loren Ponten - Surface Hub +- Paul Schmitt - WWL +- And many other Users! ## ZoomIt original contributors diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 02f8746a78..dbf6d5afc2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# PowerToys Contributor's Guide +# PowerToys contributor's guide Below is our guidance for reporting issues, proposing new features, and submitting contributions via Pull Requests (PRs). Our philosophy is to understand the problem and scenarios first, which is why we follow this pattern before work starts. @@ -6,46 +6,46 @@ Below is our guidance for reporting issues, proposing new features, and submitti 2. There has been a conversation. 3. There is agreement on the problem, the fit for PowerToys, and the solution to the problem (implementation). -## Filing an Issue +## Filing an issue **Importance of Filing an Issue First** -Please follow this rule to help eliminate wasted effort and frustration, and to ensure an efficient and effective use of everyone’s time: +Please follow this rule to help eliminate wasted effort and frustration, and to ensure an efficient and effective use of everyone's time: > 👉 If you have a question, think you've discovered an issue, or would like to propose a new feature, please find/file an issue **BEFORE** starting work to fix/implement it. When requesting new features or enhancements, providing additional evidence, data, tweets, blog posts, or research is extremely helpful. This information gives context to the scenario that may otherwise be lost. -* Unsure whether it’s an issue or feature request? File an issue. -* Have a question that isn't answered in the docs, videos, etc.? File an issue. -* Want to know if we’re planning a particular feature? File an issue. -* Got a great idea for a new utility or feature? File an issue/request/idea. -* Don’t understand how to do something? File an issue/Community Guidance Request. -* Found an existing issue that describes yours? Great! Upvote and add additional commentary, info, or repro steps. +- Unsure whether it's an issue or feature request? File an issue. +- Have a question that isn't answered in the docs, videos, etc.? File an issue. +- Want to know if we're planning a particular feature? File an issue. +- Got a great idea for a new utility or feature? File an issue/request/idea. +- Don't understand how to do something? File an issue/Community Guidance Request. +- Found an existing issue that describes yours? Great! Upvote and add additional commentary, info, or repro steps. -A quick search before filing an issue could be helpful. It’s likely someone else has found the same problem, and they may even be working on or have already contributed a fix! +A quick search before filing an issue could be helpful. It's likely someone else has found the same problem, and they may even be working on or have already contributed a fix! -### Indicating Interest in Issues +### Indicating interest in issues To let the team know which issues are important, upvote by clicking the [+😊] button and the 👍 icon on the original issue post. Avoid comments like "+1" or "me too" as they clutter the discussion and make it harder to prioritize requests. --- -## Contributing Fixes/Features +## Contributing fixes or features -Please comment on our ["Would you like to contribute to PowerToys?"](https://github.com/microsoft/PowerToys/issues/28769) thread to let us know you're interested in working on something before you start. This helps avoid multiple people unexpectedly working on the same thing and ensures everyone is clear on what should be done. It's less work for everyone to establish this up front. +Please comment on our [Would you like to contribute to PowerToys?](https://github.com/microsoft/PowerToys/issues/28769) thread to let us know you're interested in working on something before you start. This helps avoid multiple people unexpectedly working on the same thing and ensures everyone is clear on what should be done. It's less work for everyone to establish this up front. -### Localization Issues +### Localization issues For localization issues, please file an issue to notify our internal localization team, as community PRs for localization aren't accepted. Localization is handled exclusively by the internal Microsoft team. -### To Spec or Not to Spec +### To spec or not to spec A key point is for everyone to understand the approach that will be taken. We want to be sure that any work done will be accepted. Larger-scope items will require a spec to outline the approach and allow for discussion. Specs help collaborators consider different solutions, describe feature behavior, and plan for errors. Achieving agreement in a spec before writing code often results in simpler code and less wasted effort. Once a team member has agreed with your approach, proceed to the "Development" section below. Team members are happy to help review specs and guide them to completion. -### Help Wanted +### Help wanted Once the team has approved an issue/spec approach, development can proceed. If no developers are immediately available, the spec may be parked and labeled "Help Wanted," ready for a developer to get started. For development opportunities, visit [Issues labeled Help Wanted](https://github.com/microsoft/PowerToys/labels/Help%20Wanted). @@ -55,18 +55,18 @@ Once the team has approved an issue/spec approach, development can proceed. If n Follow the [development guidelines](https://github.com/microsoft/PowerToys/blob/main/doc/devdocs/readme.md). -### Naming Features and Functionality +### Naming features and functionality Names should be descriptive and straightforward, clearly reflecting functionality and usefulness. -### Becoming a Collaborator on the PowerToys Team +### Becoming a collaborator on the PowerToys team -Be an active community member! Make helpful contributions by filing bugs, offering suggestions, developing fixes and features, conducting code reviews, and updating documentation. +Be an active community member! Make helpful contributions by filing bugs, offering suggestions, developing fixes and features, conducting code reviews, and updating documentation. When the time comes, Microsoft will reach out to you about becoming a formal team member. Just make sure they have a way to contact you. 😊 --- -## Thank You +## Thank you Thank you in advance for your contribution! We appreciate your help in making PowerToys a better tool for everyone. diff --git a/DATA_AND_PRIVACY.md b/DATA_AND_PRIVACY.md index 09b85c6446..2caee8edfd 100644 --- a/DATA_AND_PRIVACY.md +++ b/DATA_AND_PRIVACY.md @@ -1,10 +1,12 @@ -# PowerToys Data & Privacy +# PowerToys data & privacy + ## Overview + PowerToys diagnostic data is completely optional for users and is off by default in v0.86 and beyond. Our team believes in transparency and trust. As PowerToys is open source, all of our diagnostic data events are in the codebase. Additionally, this document aims to list each diagnostic data event individually and describe their purpose clearly. -For more information, please read the [Microsoft privacy statement](https://privacy.microsoft.com/privacystatement). +For more information, please read the [Microsoft privacy statement](https://privacy.microsoft.com/privacystatement). ## What does PowerToys collect? @@ -12,1426 +14,448 @@ For more information, please read the [Microsoft privacy statement](https://priv 2. **Stability**: Monitoring bugs and system crashes, as well as analyzing GitHub issue reports, assists us in prioritizing the most urgent issues. 3. **Performance**: Assessing the performance of PowerToys features to load and execute gives us an understanding of what surfaces are causing slowdowns. This supports our commitment to providing you with tools that are both speedy and effective. -### Success Story: Fixing FancyZones Bugs with Your Help +### Success story: Fixing FancyZones bugs with your help + FancyZones had numerous bug reports related to virtual desktop interactions. Initially, these were considered lower priority, since the assumption was that virtual desktops were not widely used, so we chose to focus on more urgent issues. However, the volume of bug reports suggested otherwise, prompting us to add additional diagnostics to see virtual desktop usage with FancyZones. We discovered that virtual desktop usage was much higher among FancyZones users. This new understanding led us to prioritize this class of bugs and get them fixed. - -## Transparency and Public Sharing + +## Transparency and public sharing + As much as possible, we aim to share the results of diagnostic data publicly. We hope this document provides clarity on why and how we collect diagnostic data to improve PowerToys for our users. If you have any questions or concerns, please feel free to reach out to us. Thank you for using PowerToys! -## List of Diagnostic Data Events -_**Note:** We're in the process of updating this section with more events and their descriptions. We aim to keep this list current by adding any new diagnostic data events as they become available._ +## List of diagnostic data events + +> [!NOTE] +> We're in the process of updating this section with more events and their descriptions. We aim to keep this list current by adding any new diagnostic data events as they become available. +> +> If you want to find diagnostic data events in the source code, these two links will be good starting points based on the source code's language: -_If you want to find diagnostic data events in the source code, these two links will be good starting points based on the source code's langauge._ - [C# events](https://github.com/search?q=repo%3Amicrosoft/PowerToys%20EventBase&type=code) - [C++ events](https://github.com/search?q=repo%3Amicrosoft%2FPowerToys+ProjectTelemetryPrivacyDataTag&type=code) ### General - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.DebugEventLogs debugging information for diagnostics and troubleshooting.
Microsoft.PowerToys.GeneralSettingsChangedLogs changes made to general settings within PowerToys.
Microsoft.PowerToys.Install_FailTriggered when the PowerToys installation process encounters an error and fails to complete.
Microsoft.PowerToys.Repair_CancelTriggered when a PowerToys repair operation is cancelled by the user before completion.
Microsoft.PowerToys.Repair_FailTriggered when the PowerToys repair operation fails to complete successfully due to an error.
Microsoft.PowerToys.PowerToys_ModuleLaunchedFromSettingsLogs when a module editor is launched from the Settings UI or Quick Access panel, including which module was launched.
Microsoft.PowerToys.Runner_LaunchIndicates when the PowerToys Runner is launched.
Microsoft.PowerToys.SettingsBootEventTriggered when PowerToys settings are initialized at startup.
Microsoft.PowerToys.SettingsEnabledEventIndicates that the PowerToys settings have been enabled.
Microsoft.PowerToys.ScoobeStartedEventTriggered when SCOOBE (Secondary Out-of-box experience) starts.
Microsoft.PowerToys.ShortcutConflictControlClickedEventTriggered when a user clicks on the Shortcut Conflict Control button in the PowerToys Settings UI Dashboard.
Microsoft.PowerToys.ShortcutConflictDetectedEventTriggered when keyboard shortcut conflicts are detected in the PowerToys Settings UI Dashboard.
Microsoft.PowerToys.ShortcutConflictResolvedEventTriggered when a keyboard shortcut conflict is resolved in the PowerToys Settings UI.
Microsoft.PowerToys.TrayFlyoutActivatedEventIndicates when the tray flyout menu is activated.
Microsoft.PowerToys.TrayFlyoutModuleRunEventLogs when a utility from the tray flyout menu is run.
Microsoft.PowerToys.UnInstall_CancelTriggered when the PowerToys uninstallation process is cancelled by the user before completion.
Microsoft.PowerToys.UnInstall_FailTriggered when the PowerToys uninstallation process fails to complete successfully due to an error.
Microsoft.PowerToys.Uninstall_SuccessLogs when PowerToys is successfully uninstalled (who would do such a thing!).
Microsoft.PowerToys.UpdateCheck_CompletedLogs when an auto-update check completes, including success status, whether an update is available, and version information.
Microsoft.PowerToys.UpdateDownload_CompletedLogs when an update download completes, including success status and version.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.DebugEvent | Logs debugging information for diagnostics and troubleshooting. | +| Microsoft.PowerToys.GeneralSettingsChanged | Logs changes made to general settings within PowerToys. | +| Microsoft.PowerToys.Install_Fail | Triggered when the PowerToys installation process encounters an error and fails to complete. | +| Microsoft.PowerToys.PowerToys_ModuleLaunchedFromSettings | Logs when a module editor is launched from the Settings UI or Quick Access panel, including which module was launched. | +| Microsoft.PowerToys.Repair_Cancel | Triggered when a PowerToys repair operation is cancelled by the user before completion. | +| Microsoft.PowerToys.Repair_Fail | Triggered when the PowerToys repair operation fails to complete successfully due to an error. | +| Microsoft.PowerToys.Runner_Launch | Indicates when the PowerToys Runner is launched. | +| Microsoft.PowerToys.ScoobeStartedEvent | Triggered when SCOOBE (Secondary Out-of-box experience) starts. | +| Microsoft.PowerToys.SettingsBootEvent | Triggered when PowerToys settings are initialized at startup. | +| Microsoft.PowerToys.SettingsEnabledEvent | Indicates that the PowerToys settings have been enabled. | +| Microsoft.PowerToys.ShortcutConflictControlClickedEvent | Triggered when a user clicks on the Shortcut Conflict Control button in the PowerToys Settings UI Dashboard. | +| Microsoft.PowerToys.ShortcutConflictDetectedEvent | Triggered when keyboard shortcut conflicts are detected in the PowerToys Settings UI Dashboard. | +| Microsoft.PowerToys.ShortcutConflictResolvedEvent | Triggered when a keyboard shortcut conflict is resolved in the PowerToys Settings UI. | +| Microsoft.PowerToys.TrayFlyoutActivatedEvent | Indicates when the tray flyout menu is activated. | +| Microsoft.PowerToys.TrayFlyoutModuleRunEvent | Logs when a utility from the tray flyout menu is run. | +| Microsoft.PowerToys.UnInstall_Cancel | Triggered when the PowerToys uninstallation process is cancelled by the user before completion. | +| Microsoft.PowerToys.UnInstall_Fail | Triggered when the PowerToys uninstallation process fails to complete successfully due to an error. | +| Microsoft.PowerToys.Uninstall_Success | Logs when PowerToys is successfully uninstalled (who would do such a thing!). | +| Microsoft.PowerToys.UpdateCheck_Completed | Logs when an auto-update check completes, including success status, whether an update is available, and version information. | +| Microsoft.PowerToys.UpdateDownload_Completed | Logs when an update download completes, including success status and version. | ### OOBE (Out-of-box experience) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.OobeModuleRunEventTriggered when a user clicks to run or launch a PowerToys module directly from the OOBE (out-of-box experience) interface.
Microsoft.PowerToys.OobeSectionEventOccurs when OOBE is shown to the user.
Microsoft.PowerToys.OobeSettingsEventTriggers when a Settings page is opened from an OOBE page.
Microsoft.PowerToys.OobeStartedEventIndicates when the out-of-box experience has been initiated.
Microsoft.PowerToys.OobeVariantAssignmentEventThis event logs A/B testing assignments for experimental features, helping track which users are in control or alternate groups for feature experiments.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.OobeModuleRunEvent | Triggered when a user clicks to run or launch a PowerToys module directly from the OOBE (out-of-box experience) interface. | +| Microsoft.PowerToys.OobeSectionEvent | Occurs when OOBE is shown to the user. | +| Microsoft.PowerToys.OobeSettingsEvent | Triggers when a Settings page is opened from an OOBE page. | +| Microsoft.PowerToys.OobeStartedEvent | Indicates when the out-of-box experience has been initiated. | +| Microsoft.PowerToys.OobeVariantAssignmentEvent | This event logs A/B testing assignments for experimental features, helping track which users are in control or alternate groups for feature experiments. | ### Advanced Paste - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.AdvancedPaste_EnableAdvancedPasteTriggered when Advanced Paste is enabled.
Microsoft.PowerToys.AdvancedPaste_ErrorOccurs when an error is encountered during the Advanced Paste process.
Microsoft.PowerToys.AdvancedPaste_InvokeAdvancedPasteActivated when Advanced Paste is called by the user.
Microsoft.PowerToys.AdvancedPaste_SettingsTriggered when settings for Advanced Paste are accessed or modified.
Microsoft.PowerToys.AdvancedPasteClipboardItemClickedOccurs when a clipboard item is selected from the Advanced Paste menu.
Microsoft.PowerToys.AdvancedPasteClipboardItemDeletedEventTriggered when an item is removed from the Advanced Paste clipboard history.
Microsoft.PowerToys.AdvancedPasteCustomFormatOutputThumbUpDownEventTriggered when a user gives feedback on a custom format output (thumb up/down).
Microsoft.PowerToys.AdvancedPasteFormatClickedEventOccurs when a specific paste format is clicked in the Advanced Paste menu.
Microsoft.PowerToys.AdvancedPasteGenerateCustomErrorEventTriggered when an error occurs while generating a custom paste format.
Microsoft.PowerToys.AdvancedPasteGenerateCustomFormatEventOccurs when a custom paste format is successfully generated.
Microsoft.PowerToys.AdvancedPasteInAppKeyboardShortcutEventTriggered when a keyboard shortcut is used within the Advanced Paste interface.
Microsoft.PowerToys.AdvancedPasteSemanticKernelFormatEventTriggered when Advanced Paste leverages the Semantic Kernel.
Microsoft.PowerToys.AdvancedPasteSemanticKernelErrorEventOccurs when the Semantic Kernel workflow encounters an error.
Microsoft.PowerToys.AdvancedPasteEndpointUsageEventLogs the AI provider, model, and processing duration for each endpoint call.
Microsoft.PowerToys.AdvancedPasteCustomActionErrorEventRecords provider, model, and status details when a custom action fails.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.AdvancedPaste_EnableAdvancedPaste | Triggered when Advanced Paste is enabled. | +| Microsoft.PowerToys.AdvancedPaste_Error | Occurs when an error is encountered during the Advanced Paste process. | +| Microsoft.PowerToys.AdvancedPaste_InvokeAdvancedPaste | Activated when Advanced Paste is called by the user. | +| Microsoft.PowerToys.AdvancedPaste_Settings | Triggered when settings for Advanced Paste are accessed or modified. | +| Microsoft.PowerToys.AdvancedPasteClipboardItemClicked | Occurs when a clipboard item is selected from the Advanced Paste menu. | +| Microsoft.PowerToys.AdvancedPasteClipboardItemDeletedEvent | Triggered when an item is removed from the Advanced Paste clipboard history. | +| Microsoft.PowerToys.AdvancedPasteCustomActionErrorEvent | Records provider, model, and status details when a custom action fails. | +| Microsoft.PowerToys.AdvancedPasteCustomFormatOutputThumbUpDownEvent | Triggered when a user gives feedback on a custom format output (thumb up/down). | +| Microsoft.PowerToys.AdvancedPasteEndpointUsageEvent | Logs the AI provider, model, and processing duration for each endpoint call. | +| Microsoft.PowerToys.AdvancedPasteFormatClickedEvent | Occurs when a specific paste format is clicked in the Advanced Paste menu. | +| Microsoft.PowerToys.AdvancedPasteGenerateCustomErrorEvent | Triggered when an error occurs while generating a custom paste format. | +| Microsoft.PowerToys.AdvancedPasteGenerateCustomFormatEvent | Occurs when a custom paste format is successfully generated. | +| Microsoft.PowerToys.AdvancedPasteInAppKeyboardShortcutEvent | Triggered when a keyboard shortcut is used within the Advanced Paste interface. | +| Microsoft.PowerToys.AdvancedPasteSemanticKernelErrorEvent | Occurs when the Semantic Kernel workflow encounters an error. | +| Microsoft.PowerToys.AdvancedPasteSemanticKernelFormatEvent | Triggered when Advanced Paste leverages the Semantic Kernel. | ### Always on Top - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.AlwaysOnTop_EnableAlwaysOnTopTriggered when Always on Top is enabled.
Microsoft.PowerToys.AlwaysOnTop_PinWindowOccurs when a window is pinned to stay on top of other windows.
Microsoft.PowerToys.AlwaysOnTop_UnpinWindowTriggered when a pinned window is unpinned, allowing it to be behind other windows.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.AlwaysOnTop_EnableAlwaysOnTop | Triggered when Always on Top is enabled. | +| Microsoft.PowerToys.AlwaysOnTop_PinWindow | Occurs when a window is pinned to stay on top of other windows. | +| Microsoft.PowerToys.AlwaysOnTop_UnpinWindow | Triggered when a pinned window is unpinned, allowing it to be behind other windows. | ### Awake - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.Awake_EnableAwakeTriggered when Awake is enabled.
Microsoft.PowerToys.AwakeExpirableKeepAwakeEventOccurs when the system is kept awake for a temporary, expirable duration.
Microsoft.PowerToys.AwakeIndefinitelyKeepAwakeEventTriggered when the system is set to stay awake indefinitely.
Microsoft.PowerToys.AwakeNoKeepAwakeEventOccurs when Awake is turned off, allowing the computer to enter sleep mode.
Microsoft.PowerToys.AwakeTimedKeepAwakeEventTriggered when the system is kept awake for a specified time duration.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.Awake_EnableAwake | Triggered when Awake is enabled. | +| Microsoft.PowerToys.AwakeExpirableKeepAwakeEvent | Occurs when the system is kept awake for a temporary, expirable duration. | +| Microsoft.PowerToys.AwakeIndefinitelyKeepAwakeEvent | Triggered when the system is set to stay awake indefinitely. | +| Microsoft.PowerToys.AwakeNoKeepAwakeEvent | Occurs when Awake is turned off, allowing the computer to enter sleep mode. | +| Microsoft.PowerToys.AwakeTimedKeepAwakeEvent | Triggered when the system is kept awake for a specified time duration. | ### Color Picker - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.ColorPicker_EnableColorPickerTriggered when Color Picker is enabled.
Microsoft.PowerToys.ColorPicker_SessionOccurs during a Color Picker usage session.
Microsoft.PowerToys.ColorPicker_SettingsTriggered when the settings for the Color Picker are accessed or modified.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.ColorPicker_EnableColorPicker | Triggered when Color Picker is enabled. | +| Microsoft.PowerToys.ColorPicker_Session | Occurs during a Color Picker usage session. | +| Microsoft.PowerToys.ColorPicker_Settings | Triggered when the settings for the Color Picker are accessed or modified. | ### Command Not Found - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.CmdNotFound_EnableCmdNotFoundTriggered when Command Not Found is enabled or disabled.
Microsoft.PowerToys.CmdNotFoundInstallEventTriggered when a Command Not Found is installed.
Microsoft.PowerToys.CmdNotFoundUninstallEventTriggered when Command Not Found is uninstalled after being previously installed.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.CmdNotFound_EnableCmdNotFound | Triggered when Command Not Found is enabled or disabled. | +| Microsoft.PowerToys.CmdNotFoundInstallEvent | Triggered when a Command Not Found is installed. | +| Microsoft.PowerToys.CmdNotFoundUninstallEvent | Triggered when Command Not Found is uninstalled after being previously installed. | ### Command Palette - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.CmdPal_BeginInvokeTriggered when the Command Palette is launched by the user.
Microsoft.PowerToys.CmdPal_ColdLaunchOccurs when Command Palette starts for the first time (cold start).
Microsoft.PowerToys.CmdPal_OpenPageTriggered when a page is opened within the Command Palette, tracking navigation depth.
Microsoft.PowerToys.CmdPal_OpenUriOccurs when a URI is opened through the Command Palette, including whether it's a web URL.
Microsoft.PowerToys.CmdPal_ReactivateInstanceTriggered when an existing Command Palette instance is reactivated.
Microsoft.PowerToys.CmdPal_RunCommandLogs when a command is executed through the Command Palette, including admin elevation status.
Microsoft.PowerToys.CmdPal_RunQueryTriggered when a search query is performed, including result count and duration.
Microsoft.PowerToys.CmdPalDismissedOnEscOccurs when the Command Palette is dismissed by pressing the Escape key.
Microsoft.PowerToys.CmdPalDismissedOnLostFocusTriggered when the Command Palette is dismissed due to losing focus.
Microsoft.PowerToys.CmdPalHotkeySummonedLogs when the Command Palette is summoned via hotkey, distinguishing between global and context-specific hotkeys.
Microsoft.PowerToys.CmdPalInvokeResultRecords the result type of a Command Palette invocation.
Microsoft.PowerToys.CmdPalProcessStartedTriggered when the Command Palette process is started.
Microsoft.PowerToys.CmdPal_ExtensionInvokedTracks extension usage including extension ID, command details, success status, and execution time.
Microsoft.PowerToys.CmdPal_SessionDurationLogs session metrics from launch to dismissal including duration, commands executed, pages visited, search queries, navigation depth, and errors.
Microsoft.PowerToys.CmdPal_DockConfigurationTracks dock configuration at startup including whether the dock is enabled, dock side (top, bottom, left, or right), and the list of extension commands pinned to the start, center, and end sections of the dock.
+| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.CmdPal_BeginInvoke | Triggered when the Command Palette is launched by the user. | +| Microsoft.PowerToys.CmdPal_ColdLaunch | Occurs when Command Palette starts for the first time (cold start). | +| Microsoft.PowerToys.CmdPal_DockConfiguration | Tracks dock configuration at startup including whether the dock is enabled, dock side (top, bottom, left, or right), and the list of extension commands pinned to the start, center, and end sections of the dock. | +| Microsoft.PowerToys.CmdPal_ExtensionInvoked | Tracks extension usage including extension ID, command details, success status, and execution time. | +| Microsoft.PowerToys.CmdPal_OpenPage | Triggered when a page is opened within the Command Palette, tracking navigation depth. | +| Microsoft.PowerToys.CmdPal_OpenUri | Occurs when a URI is opened through the Command Palette, including whether it's a web URL. | +| Microsoft.PowerToys.CmdPal_ReactivateInstance | Triggered when an existing Command Palette instance is reactivated. | +| Microsoft.PowerToys.CmdPal_RunCommand | Logs when a command is executed through the Command Palette, including admin elevation status. | +| Microsoft.PowerToys.CmdPal_RunQuery | Triggered when a search query is performed, including result count and duration. | +| Microsoft.PowerToys.CmdPal_SessionDuration | Logs session metrics from launch to dismissal including duration, commands executed, pages visited, search queries, navigation depth, and errors. | +| Microsoft.PowerToys.CmdPalDismissedOnEsc | Occurs when the Command Palette is dismissed by pressing the Escape key. | +| Microsoft.PowerToys.CmdPalDismissedOnLostFocus | Triggered when the Command Palette is dismissed due to losing focus. | +| Microsoft.PowerToys.CmdPalHotkeySummoned | Logs when the Command Palette is summoned via hotkey, distinguishing between global and context-specific hotkeys. | +| Microsoft.PowerToys.CmdPalInvokeResult | Records the result type of a Command Palette invocation. | +| Microsoft.PowerToys.CmdPalProcessStarted | Triggered when the Command Palette process is started. | -### Crop And Lock - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.CropAndLock_ActivateReparentTriggered when the cropping interface is activated for reparenting the cropped content.
Microsoft.PowerToys.CropAndLock_ActivateScreenshotTriggered when the screenshot mode is activated in Crop and Lock.
Microsoft.PowerToys.CropAndLock_ActivateThumbnailOccurs when the thumbnail view for cropped content is activated.
Microsoft.PowerToys.CropAndLock_CreateReparentWindowTriggered when a reparent window is created in Crop and Lock mode.
Microsoft.PowerToys.CropAndLock_CreateScreenshotWindowTriggered when a screenshot window is created in Crop and Lock mode.
Microsoft.PowerToys.CropAndLock_CreateThumbnailWindowTriggered when a thumbnail window is created in Crop and Lock mode.<-/td> -
Microsoft.PowerToys.CropAndLock_EnableCropAndLockTriggered when Crop and Lock is enabled.
Microsoft.PowerToys.CropAndLock_SettingsOccurs when settings related to Crop and Lock are modified.
+### Crop and lock + +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.CropAndLock_ActivateReparent | Triggered when the cropping interface is activated for reparenting the cropped content. | +| Microsoft.PowerToys.CropAndLock_ActivateScreenshot | Triggered when the screenshot mode is activated in Crop and Lock. | +| Microsoft.PowerToys.CropAndLock_ActivateThumbnail | Occurs when the thumbnail view for cropped content is activated. | +| Microsoft.PowerToys.CropAndLock_CreateReparentWindow | Triggered when a reparent window is created in Crop and Lock mode. | +| Microsoft.PowerToys.CropAndLock_CreateScreenshotWindow | Triggered when a screenshot window is created in Crop and Lock mode. | +| Microsoft.PowerToys.CropAndLock_CreateThumbnailWindow | Triggered when a thumbnail window is created in Crop and Lock mode. | +| Microsoft.PowerToys.CropAndLock_EnableCropAndLock | Triggered when Crop and Lock is enabled. | +| Microsoft.PowerToys.CropAndLock_Settings | Occurs when settings related to Crop and Lock are modified. | ### Cursor Wrap - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.CursorWrap_EnableCursorWrapTriggered when Cursor Wrap is enabled or disabled.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.CursorWrap_EnableCursorWrap | Triggered when Cursor Wrap is enabled or disabled. | ### Environment Variables - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.EnvironmentVariables_ActivateTriggered when Environment Variables is launched.
Microsoft.PowerToys.EnvironmentVariables_EnableEnvironmentVariablesOccurs when Environment Variables is enabled.
Microsoft.PowerToys.EnvironmentVariablesOpenedEventTriggered when the Environment Variables interface is opened.
Microsoft.PowerToys.EnvironmentVariablesProfileEnabledEventOccurs when an environment variable profile is enabled.
Microsoft.PowerToys.EnvironmentVariablesVariableChangedEventTriggered when an environment variable is added, modified, or deleted.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.EnvironmentVariables_Activate | Triggered when Environment Variables is launched. | +| Microsoft.PowerToys.EnvironmentVariables_EnableEnvironmentVariables | Occurs when Environment Variables is enabled. | +| Microsoft.PowerToys.EnvironmentVariablesOpenedEvent | Triggered when the Environment Variables interface is opened. | +| Microsoft.PowerToys.EnvironmentVariablesProfileEnabledEvent | Occurs when an environment variable profile is enabled. | +| Microsoft.PowerToys.EnvironmentVariablesVariableChangedEvent | Triggered when an environment variable is added, modified, or deleted. | ### FancyZones - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.FancyZones_CycleActiveZoneSetTriggered when the active zone set is cycled through.
Microsoft.PowerToys.FancyZones_EditorLaunchOccurs when the FancyZones editor is launched.
Microsoft.PowerToys.FancyZones_EnableFancyZonesOccurs when FancyZones is enabled.
Microsoft.PowerToys.FancyZones_ErrorTriggered when an error occurs within the FancyZones module. This event logs critical errors to help diagnose and troubleshoot issues with FancyZones functionality, such as failures to set up Windows hooks or other system-level operations required for window management.
Microsoft.PowerToys.FancyZones_KeyboardSnapWindowToZoneTriggered when a window is snapped to a zone using the keyboard.
Microsoft.PowerToys.FancyZones_MoveOrResizeEndedOccurs when a window move or resize action has completed.
Microsoft.PowerToys.FancyZones_MoveOrResizeStartedTriggered when a window move or resize action is initiated.
Microsoft.PowerToys.FancyZones_OnKeyDownTriggered when a key is pressed down while interacting with zones.
Microsoft.PowerToys.FancyZones_QuickLayoutSwitchOccurs when a quick switch between zone layouts is performed.
Microsoft.PowerToys.FancyZones_SettingsTriggered when FancyZones settings are accessed or modified.
Microsoft.PowerToys.FancyZones_SnapNewWindowIntoZoneTriggered when a new window is snapped into a zone.
Microsoft.PowerToys.FancyZones_VirtualDesktopChangedOccurs when the virtual desktop changes, affecting zone layout.
Microsoft.PowerToys.FancyZones_ZoneSettingsChangedTriggered when the settings for specific zones are altered.
Microsoft.PowerToys.FancyZones_ZoneWindowKeyUpOccurs when a key is released while interacting with zones.
Microsoft.PowerToys.FancyZones_CLICommandTriggered when a FancyZones CLI command is executed, logging the command name and success status.
Microsoft.PowerToys.FancyZonesEditorStartEventTriggered when the FancyZones Editor application starts. This logs the initialization of the editor UI, which is used to create and configure custom zone layouts.
Microsoft.PowerToys.FancyZonesEditorStartFinishEventTriggered when the FancyZones Editor has completed loading and is ready for user interaction.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.FancyZones_CLICommand | Triggered when a FancyZones CLI command is executed, logging the command name and success status. | +| Microsoft.PowerToys.FancyZones_CycleActiveZoneSet | Triggered when the active zone set is cycled through. | +| Microsoft.PowerToys.FancyZones_EditorLaunch | Occurs when the FancyZones editor is launched. | +| Microsoft.PowerToys.FancyZones_EnableFancyZones | Occurs when FancyZones is enabled. | +| Microsoft.PowerToys.FancyZones_Error | Triggered when an error occurs within the FancyZones module. This event logs critical errors to help diagnose and troubleshoot issues with FancyZones functionality, such as failures to set up Windows hooks or other system-level operations required for window management. | +| Microsoft.PowerToys.FancyZones_KeyboardSnapWindowToZone | Triggered when a window is snapped to a zone using the keyboard. | +| Microsoft.PowerToys.FancyZones_MoveOrResizeEnded | Occurs when a window move or resize action has completed. | +| Microsoft.PowerToys.FancyZones_MoveOrResizeStarted | Triggered when a window move or resize action is initiated. | +| Microsoft.PowerToys.FancyZones_OnKeyDown | Triggered when a key is pressed down while interacting with zones. | +| Microsoft.PowerToys.FancyZones_QuickLayoutSwitch | Occurs when a quick switch between zone layouts is performed. | +| Microsoft.PowerToys.FancyZones_Settings | Triggered when FancyZones settings are accessed or modified. | +| Microsoft.PowerToys.FancyZones_SnapNewWindowIntoZone | Triggered when a new window is snapped into a zone. | +| Microsoft.PowerToys.FancyZones_VirtualDesktopChanged | Occurs when the virtual desktop changes, affecting zone layout. | +| Microsoft.PowerToys.FancyZones_ZoneSettingsChanged | Triggered when the settings for specific zones are altered. | +| Microsoft.PowerToys.FancyZones_ZoneWindowKeyUp | Occurs when a key is released while interacting with zones. | +| Microsoft.PowerToys.FancyZonesEditorStartEvent | Triggered when the FancyZones Editor application starts. This logs the initialization of the editor UI, which is used to create and configure custom zone layouts. | +| Microsoft.PowerToys.FancyZonesEditorStartFinishEvent | Triggered when the FancyZones Editor has completed loading and is ready for user interaction. | ### File Locksmith - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.FileLocksmith_EnableFileLocksmithTriggered when File Locksmith is enabled.
Microsoft.PowerToys.FileLocksmith_InvokedOccurs when File Locksmith is invoked.
Microsoft.PowerToys.FileLocksmith_InvokedRetTriggered when File Locksmith invocation returns a result.
Microsoft.PowerToys.FileLocksmith_QueryContextMenuErrorOccurs when there is an error querying the context menu for File Locksmith.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.FileLocksmith_EnableFileLocksmith | Triggered when File Locksmith is enabled. | +| Microsoft.PowerToys.FileLocksmith_Invoked | Occurs when File Locksmith is invoked. | +| Microsoft.PowerToys.FileLocksmith_InvokedRet | Triggered when File Locksmith invocation returns a result. | +| Microsoft.PowerToys.FileLocksmith_QueryContextMenuError | Occurs when there is an error querying the context menu for File Locksmith. | ### FileExplorerAddOns - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.GcodeFileHandlerLoadedTriggered when a G-code file handler is loaded.
Microsoft.PowerToys.GcodeFilePreviewedOccurs when a G-code file is previewed in File Explorer.
Microsoft.PowerToys.GcodeFilePreviewErrorTriggered when there is an error previewing a G-code file.
Microsoft.PowerToys.BgcodeFileHandlerLoadedTriggered when a Binary G-code file handler is loaded.
Microsoft.PowerToys.BgcodeFilePreviewedOccurs when a Binary G-code file is previewed in File Explorer.
Microsoft.PowerToys.BgcodeFilePreviewErrorTriggered when there is an error previewing a Binary G-code file.
Microsoft.PowerToys.MarkdownFileHandlerLoadedOccurs when a Markdown file handler is loaded.
Microsoft.PowerToys.MarkdownFilePreviewedTriggered when a Markdown file is previewed in File Explorer.
Microsoft.PowerToys.MarkdownFilePreviewErrorTriggered when there is an error previewing a Markdown file in File Explorer.
Microsoft.PowerToys.PdfFileHandlerLoadedOccurs when a PDF file handler is loaded.
Microsoft.PowerToys.PdfFilePreviewedTriggered when a PDF file is previewed in File Explorer.
Microsoft.PowerToys.PdfFilePreviewErrorTriggered when there is an error previewing a PDF file in File Explorer.
Microsoft.PowerToys.PowerPreview_EnabledOccurs when preview is enabled.
Microsoft.PowerToys.PowerPreview_TweakUISettings_DestroyedTriggered when the Tweak UI settings for Power Preview are destroyed.
Microsoft.PowerToys.PowerPreview_TweakUISettings_FailedUpdatingSettingsOccurs when updating Tweak UI settings fails.
Microsoft.PowerToys.PowerPreview_TweakUISettings_InitSet__ErrorLoadingFileTriggered when there is an error loading a file during Tweak UI settings initialization.
Microsoft.PowerToys.PowerPreview_TweakUISettings_SetConfig__InvalidJSONGivenTriggered when invalid JSON is provided to the Power Preview settings configuration
Microsoft.PowerToys.PowerPreview_TweakUISettings_SuccessfullyUpdatedSettingsOccurs when the Tweak UI settings for Power Preview are successfully updated.
Microsoft.PowerToys.QoiFilePreviewedTriggered when a QOI file is previewed in File Explorer.
Microsoft.PowerToys.QoiFilePreviewErrorTriggered when there is an error previewing a QOI (Quite OK Image) file in File Explorer.
Microsoft.PowerToys.SvgFileHandlerLoadedOccurs when an SVG file handler is loaded.
Microsoft.PowerToys.SvgFilePreviewedTriggered when an SVG file is previewed in File Explorer.
Microsoft.PowerToys.SvgFilePreviewErrorOccurs when there is an error previewing an SVG file.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.BgcodeFileHandlerLoaded | Triggered when a Binary G-code file handler is loaded. | +| Microsoft.PowerToys.BgcodeFilePreviewed | Occurs when a Binary G-code file is previewed in File Explorer. | +| Microsoft.PowerToys.BgcodeFilePreviewError | Triggered when there is an error previewing a Binary G-code file. | +| Microsoft.PowerToys.GcodeFileHandlerLoaded | Triggered when a G-code file handler is loaded. | +| Microsoft.PowerToys.GcodeFilePreviewed | Occurs when a G-code file is previewed in File Explorer. | +| Microsoft.PowerToys.GcodeFilePreviewError | Triggered when there is an error previewing a G-code file. | +| Microsoft.PowerToys.MarkdownFileHandlerLoaded | Occurs when a Markdown file handler is loaded. | +| Microsoft.PowerToys.MarkdownFilePreviewed | Triggered when a Markdown file is previewed in File Explorer. | +| Microsoft.PowerToys.MarkdownFilePreviewError | Triggered when there is an error previewing a Markdown file in File Explorer. | +| Microsoft.PowerToys.PdfFileHandlerLoaded | Occurs when a PDF file handler is loaded. | +| Microsoft.PowerToys.PdfFilePreviewed | Triggered when a PDF file is previewed in File Explorer. | +| Microsoft.PowerToys.PdfFilePreviewError | Triggered when there is an error previewing a PDF file in File Explorer. | +| Microsoft.PowerToys.PowerPreview_Enabled | Occurs when preview is enabled. | +| Microsoft.PowerToys.PowerPreview_TweakUISettings_Destroyed | Triggered when the Tweak UI settings for Power Preview are destroyed. | +| Microsoft.PowerToys.PowerPreview_TweakUISettings_FailedUpdatingSettings | Occurs when updating Tweak UI settings fails. | +| Microsoft.PowerToys.PowerPreview_TweakUISettings_InitSet__ErrorLoadingFile | Triggered when there is an error loading a file during Tweak UI settings initialization. | +| Microsoft.PowerToys.PowerPreview_TweakUISettings_SetConfig__InvalidJSONGiven | Triggered when invalid JSON is provided to the Power Preview settings configuration. | +| Microsoft.PowerToys.PowerPreview_TweakUISettings_SuccessfullyUpdatedSettings | Occurs when the Tweak UI settings for Power Preview are successfully updated. | +| Microsoft.PowerToys.QoiFilePreviewed | Triggered when a QOI file is previewed in File Explorer. | +| Microsoft.PowerToys.QoiFilePreviewError | Triggered when there is an error previewing a QOI (Quite OK Image) file in File Explorer. | +| Microsoft.PowerToys.SvgFileHandlerLoaded | Occurs when an SVG file handler is loaded. | +| Microsoft.PowerToys.SvgFilePreviewed | Triggered when an SVG file is previewed in File Explorer. | +| Microsoft.PowerToys.SvgFilePreviewError | Occurs when there is an error previewing an SVG file. | ### Find My Mouse - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.FindMyMouse_EnableFindMyMouseTriggered when Find My Mouse is enabled.
Microsoft.PowerToys.FindMyMouse_MousePointerFocusedOccurs when the mouse pointer is focused using Find My Mouse, including the activation method (double-tap left/right Ctrl, shake mouse, or shortcut).
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.FindMyMouse_EnableFindMyMouse | Triggered when Find My Mouse is enabled. | +| Microsoft.PowerToys.FindMyMouse_MousePointerFocused | Occurs when the mouse pointer is focused using Find My Mouse, including the activation method (double-tap left/right Ctrl, shake mouse, or shortcut). | ### Hosts File Editor - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.HostsFileEditor_ActivateTriggered when Hosts File Editor is activated.
Microsoft.PowerToys.HostsFileEditor_EnableHostsFileEditorOccurs when Hosts File Editor is enabled.
Microsoft.PowerToys.HostsFileEditorOpenedEventFires when Hosts File Editor is opened.
Microsoft.PowerToys.HostEditorStartEventTriggered when the Hosts File Editor application starts. This logs the initialization of the Hosts File Editor UI with a timestamp.
Microsoft.PowerToys.HostEditorStartFinishEventTriggered when the Hosts File Editor has completed loading and is ready for user interaction.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.HostEditorStartEvent | Triggered when the Hosts File Editor application starts. This logs the initialization of the Hosts File Editor UI with a timestamp. | +| Microsoft.PowerToys.HostEditorStartFinishEvent | Triggered when the Hosts File Editor has completed loading and is ready for user interaction. | +| Microsoft.PowerToys.HostsFileEditor_Activate | Triggered when Hosts File Editor is activated. | +| Microsoft.PowerToys.HostsFileEditor_EnableHostsFileEditor | Occurs when Hosts File Editor is enabled. | +| Microsoft.PowerToys.HostsFileEditorOpenedEvent | Fires when Hosts File Editor is opened. | ### Image Resizer - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.ImageResizer_EnableImageResizerTriggered when Image Resizer is enabled.
Microsoft.PowerToys.ImageResizer_InvokedOccurs when Image Resizer is invoked by the user.
Microsoft.PowerToys.ImageResizer_InvokedRetFires when the Image Resizer operation is completed and returns a result.
Microsoft.PowerToys.ImageResizer_QueryContextMenuErrorTriggered when there is an error querying the context menu for Image Resizer.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.ImageResizer_EnableImageResizer | Triggered when Image Resizer is enabled. | +| Microsoft.PowerToys.ImageResizer_Invoked | Occurs when Image Resizer is invoked by the user. | +| Microsoft.PowerToys.ImageResizer_InvokedRet | Fires when the Image Resizer operation is completed and returns a result. | +| Microsoft.PowerToys.ImageResizer_QueryContextMenuError | Triggered when there is an error querying the context menu for Image Resizer. | ### Keyboard Manager - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.KeyboardManager_AppSpecificShortcutRemapConfigurationLoadedIndicates that the application-specific shortcut remap configuration has been successfully loaded.
Microsoft.PowerToys.KeyboardManager_AppSpecificShortcutRemapCountLogs the number of application-specific shortcut remaps configured by the user.
Microsoft.PowerToys.KeyboardManager_AppSpecificShortcutToKeyRemapInvokedLogs each instance when an application-specific shortcut-to-key remap is used.
Microsoft.PowerToys.KeyboardManager_AppSpecificShortcutToShortcutRemapInvokedLogs each instance when an application-specific shortcut-to-shortcut remap is used.
Microsoft.PowerToys.KeyboardManager_ErrorTriggered when an error occurs in Keyboard Manager. This logs the error code, error message, and the method name where the error occurred.
Microsoft.PowerToys.KeyboardManager_ErrorSendingKeyAndShortcutRemapLoadedConfigurationTriggered when there is an error sending remapping configuration telemetry. This occurs when Keyboard Manager fails to report the loaded key and shortcut remap configurations
Microsoft.PowerToys.KeyboardManager_DailyAppSpecificShortcutToKeyRemapInvokedLogs the daily count of application-specific shortcut-to-key remaps executed by the user.
Microsoft.PowerToys.KeyboardManager_DailyAppSpecificShortcutToShortcutRemapInvokedLogs the daily count of application-specific shortcut-to-shortcut remaps executed by the user.
Microsoft.PowerToys.KeyboardManager_DailyKeyToKeyRemapInvokedLogs the daily count of key-to-key remaps used by the user.
Microsoft.PowerToys.KeyboardManager_DailyKeyToShortcutRemapInvokedLogs the daily count of key-to-shortcut remaps used by the user.
Microsoft.PowerToys.KeyboardManager_DailyShortcutToKeyRemapInvokedLogs the daily count of shortcut-to-key remaps used by the user.
Microsoft.PowerToys.KeyboardManager_DailyShortcutToShortcutRemapInvokedLogs the daily count of shortcut-to-shortcut remaps used by the user.
Microsoft.PowerToys.KeyboardManager_EnableKeyboardManagerIndicates that the Keyboard Manager has been enabled in PowerToys settings.
Microsoft.PowerToys.KeyboardManager_KeyRemapConfigurationLoadedIndicates that the key remap configuration has been successfully loaded.
Microsoft.PowerToys.KeyboardManager_KeyRemapCountLogs the number of individual key remaps configured by the user.
Microsoft.PowerToys.KeyboardManager_KeyToKeyRemapInvokedLogs each instance of a key-to-key remap being used.
Microsoft.PowerToys.KeyboardManager_KeyToShortcutRemapInvokedLogs each instance of a key-to-shortcut remap being used.
Microsoft.PowerToys.KeyboardManager_LaunchEditorLogs when the Keyboard Manager editor is launched, including whether it was opened via hotkey or through settings.
Microsoft.PowerToys.KeyboardManager_OSLevelShortcutRemapCountLogs the total number of OS-level shortcut remaps configured by the user.
Microsoft.PowerToys.KeyboardManager_OSLevelShortcutToKeyRemapInvokedLogs each instance of an OS-level shortcut-to-key remap being used.
Microsoft.PowerToys.KeyboardManager_OSLevelShortcutToShortcutRemapInvokedLogs each instance of an OS-level shortcut-to-shortcut remap being used.
Microsoft.PowerToys.KeyboardManager_ShortcutRemapConfigurationLoadedIndicates that the shortcut remap configuration has been successfully loaded.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.KeyboardManager_AppSpecificShortcutRemapConfigurationLoaded | Indicates that the application-specific shortcut remap configuration has been successfully loaded. | +| Microsoft.PowerToys.KeyboardManager_AppSpecificShortcutRemapCount | Logs the number of application-specific shortcut remaps configured by the user. | +| Microsoft.PowerToys.KeyboardManager_AppSpecificShortcutToKeyRemapInvoked | Logs each instance when an application-specific shortcut-to-key remap is used. | +| Microsoft.PowerToys.KeyboardManager_AppSpecificShortcutToShortcutRemapInvoked | Logs each instance when an application-specific shortcut-to-shortcut remap is used. | +| Microsoft.PowerToys.KeyboardManager_DailyAppSpecificShortcutToKeyRemapInvoked | Logs the daily count of application-specific shortcut-to-key remaps executed by the user. | +| Microsoft.PowerToys.KeyboardManager_DailyAppSpecificShortcutToShortcutRemapInvoked | Logs the daily count of application-specific shortcut-to-shortcut remaps executed by the user. | +| Microsoft.PowerToys.KeyboardManager_DailyKeyToKeyRemapInvoked | Logs the daily count of key-to-key remaps used by the user. | +| Microsoft.PowerToys.KeyboardManager_DailyKeyToShortcutRemapInvoked | Logs the daily count of key-to-shortcut remaps used by the user. | +| Microsoft.PowerToys.KeyboardManager_DailyShortcutToKeyRemapInvoked | Logs the daily count of shortcut-to-key remaps used by the user. | +| Microsoft.PowerToys.KeyboardManager_DailyShortcutToShortcutRemapInvoked | Logs the daily count of shortcut-to-shortcut remaps used by the user. | +| Microsoft.PowerToys.KeyboardManager_EnableKeyboardManager | Indicates that the Keyboard Manager has been enabled in PowerToys settings. | +| Microsoft.PowerToys.KeyboardManager_Error | Triggered when an error occurs in Keyboard Manager. This logs the error code, error message, and the method name where the error occurred. | +| Microsoft.PowerToys.KeyboardManager_ErrorSendingKeyAndShortcutRemapLoadedConfiguration | Triggered when there is an error sending remapping configuration telemetry. This occurs when Keyboard Manager fails to report the loaded key and shortcut remap configurations. | +| Microsoft.PowerToys.KeyboardManager_KeyRemapConfigurationLoaded | Indicates that the key remap configuration has been successfully loaded. | +| Microsoft.PowerToys.KeyboardManager_KeyRemapCount | Logs the number of individual key remaps configured by the user. | +| Microsoft.PowerToys.KeyboardManager_KeyToKeyRemapInvoked | Logs each instance of a key-to-key remap being used. | +| Microsoft.PowerToys.KeyboardManager_KeyToShortcutRemapInvoked | Logs each instance of a key-to-shortcut remap being used. | +| Microsoft.PowerToys.KeyboardManager_LaunchEditor | Logs when the Keyboard Manager editor is launched, including whether it was opened via hotkey or through settings. | +| Microsoft.PowerToys.KeyboardManager_OSLevelShortcutRemapCount | Logs the total number of OS-level shortcut remaps configured by the user. | +| Microsoft.PowerToys.KeyboardManager_OSLevelShortcutToKeyRemapInvoked | Logs each instance of an OS-level shortcut-to-key remap being used. | +| Microsoft.PowerToys.KeyboardManager_OSLevelShortcutToShortcutRemapInvoked | Logs each instance of an OS-level shortcut-to-shortcut remap being used. | +| Microsoft.PowerToys.KeyboardManager_ShortcutRemapConfigurationLoaded | Indicates that the shortcut remap configuration has been successfully loaded. | ### Light Switch - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.LightSwitch_EnableLightSwitchTriggered when Light Switch is enabled or disabled.
Microsoft.PowerToys.LightSwitch_ShortcutInvokedOccurs when the shortcut for Light Switch is invoked.
Microsoft.PowerToys.LightSwitch_ScheduleModeToggledOccurs when a new schedule mode is selected for Light Switch.
Microsoft.PowerToys.LightSwitch_ThemeTargetChangedOccurs when the options for targeting the system or apps is updated.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.LightSwitch_EnableLightSwitch | Triggered when Light Switch is enabled or disabled. | +| Microsoft.PowerToys.LightSwitch_ScheduleModeToggled | Occurs when a new schedule mode is selected for Light Switch. | +| Microsoft.PowerToys.LightSwitch_ShortcutInvoked | Occurs when the shortcut for Light Switch is invoked. | +| Microsoft.PowerToys.LightSwitch_ThemeTargetChanged | Occurs when the options for targeting the system or apps is updated. | ### Mouse Highlighter - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.MouseHighlighter_EnableMouseHighlighterTriggered when Mouse Highlighter is enabled.
Microsoft.PowerToys.MouseHighlighter_StartHighlightingSessionOccurs when a new highlighting session is started.
Microsoft.PowerToys.MouseHighlighter_StartSpotlightSessionTriggered when a spotlight session is started in Mouse Highlighter. This occurs when the user activates the spotlight mode.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.MouseHighlighter_EnableMouseHighlighter | Triggered when Mouse Highlighter is enabled. | +| Microsoft.PowerToys.MouseHighlighter_StartHighlightingSession | Occurs when a new highlighting session is started. | +| Microsoft.PowerToys.MouseHighlighter_StartSpotlightSession | Triggered when a spotlight session is started in Mouse Highlighter. This occurs when the user activates the spotlight mode. | ### Mouse Jump - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.MouseJump_EnableJumpToolTriggered when Mouse Jump is enabled.
Microsoft.PowerToys.MouseJump_InvokeJumpToolOccurs when Mouse Jump is invoked.
Microsoft.PowerToys.MouseJumpShowEventTriggered when the Mouse Jump display is shown.
Microsoft.PowerToys.MouseJumpTeleportCursorEventOccurs when the cursor is teleported to a new location.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.MouseJump_EnableJumpTool | Triggered when Mouse Jump is enabled. | +| Microsoft.PowerToys.MouseJump_InvokeJumpTool | Occurs when Mouse Jump is invoked. | +| Microsoft.PowerToys.MouseJumpShowEvent | Triggered when the Mouse Jump display is shown. | +| Microsoft.PowerToys.MouseJumpTeleportCursorEvent | Occurs when the cursor is teleported to a new location. | ### Mouse Pointer Crosshairs - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.MousePointerCrosshairs_EnableMousePointerCrosshairsTriggered when Mouse Pointer Crosshairs is enabled.
Microsoft.PowerToys.MousePointerCrosshairs_StartDrawingCrosshairsOccurs when the crosshairs are drawn around the mouse pointer.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.MousePointerCrosshairs_EnableMousePointerCrosshairs | Triggered when Mouse Pointer Crosshairs is enabled. | +| Microsoft.PowerToys.MousePointerCrosshairs_StartDrawingCrosshairs | Occurs when the crosshairs are drawn around the mouse pointer. | ### Mouse Without Borders - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.MouseWithoutBorders_ActivateTriggered when Mouse Without Borders is activated.
Microsoft.PowerToys.MouseWithoutBorders_AddFirewallRuleOccurs when a firewall rule is added for Mouse Without Borders.
Microsoft.PowerToys.MouseWithoutBorders_EnableMouseWithoutBordersTriggered when Mouse Without Borders is enabled.
Microsoft.PowerToys.MouseWithoutBorders_ToggleServiceRegistrationOccurs when the service registration for Mouse Without Borders is toggled.
Microsoft.PowerToys.MouseWithoutBordersClipboardFileTransferEventTriggered during a clipboard file transfer between computers.
Microsoft.PowerToys.MouseWithoutBordersDragAndDropEventOccurs during a drag-and-drop operation between computers.
Microsoft.PowerToys.MouseWithoutBordersMultipleModeEventTriggered when multiple modes are enabled in Mouse Without Borders.
Microsoft.PowerToys.MouseWithoutBordersOldUIOpenedEventOccurs when the old user interface for Mouse Without Borders is opened.
Microsoft.PowerToys.MouseWithoutBordersOldUIQuitEventTriggered when the old user interface for Mouse Without Borders is closed.
Microsoft.PowerToys.MouseWithoutBordersOldUIReconfigureEventOccurs when the old user interface for Mouse Without Borders is reconfigured.
Microsoft.PowerToys.MouseWithoutBordersStartedEventTriggered when Mouse Without Borders is started.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.MouseWithoutBorders_Activate | Triggered when Mouse Without Borders is activated. | +| Microsoft.PowerToys.MouseWithoutBorders_AddFirewallRule | Occurs when a firewall rule is added for Mouse Without Borders. | +| Microsoft.PowerToys.MouseWithoutBorders_EnableMouseWithoutBorders | Triggered when Mouse Without Borders is enabled. | +| Microsoft.PowerToys.MouseWithoutBorders_ToggleServiceRegistration | Occurs when the service registration for Mouse Without Borders is toggled. | +| Microsoft.PowerToys.MouseWithoutBordersClipboardFileTransferEvent | Triggered during a clipboard file transfer between computers. | +| Microsoft.PowerToys.MouseWithoutBordersDragAndDropEvent | Occurs during a drag-and-drop operation between computers. | +| Microsoft.PowerToys.MouseWithoutBordersMultipleModeEvent | Triggered when multiple modes are enabled in Mouse Without Borders. | +| Microsoft.PowerToys.MouseWithoutBordersOldUIOpenedEvent | Occurs when the old user interface for Mouse Without Borders is opened. | +| Microsoft.PowerToys.MouseWithoutBordersOldUIQuitEvent | Triggered when the old user interface for Mouse Without Borders is closed. | +| Microsoft.PowerToys.MouseWithoutBordersOldUIReconfigureEvent | Occurs when the old user interface for Mouse Without Borders is reconfigured. | +| Microsoft.PowerToys.MouseWithoutBordersStartedEvent | Triggered when Mouse Without Borders is started. | ### New+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.NewPlus_ChangedTemplateLocationTriggered when the template folder location is changed.
Microsoft.PowerToys.NewPlus_EventCopyTemplateTriggered when an item from New+ is created (copied to the current directory).
Microsoft.PowerToys.NewPlus_EventCopyTemplateResultLogs the success of item creation (copying).
Microsoft.PowerToys.NewPlus_EventOpenTemplatesTriggered when the templates folder is opened.
Microsoft.PowerToys.NewPlus_EventShowTemplateItemsTriggered when the New+ context menu flyout is displayed.
Microsoft.PowerToys.NewPlus_EventToggleOnOffTriggered when New+ is enabled or disabled.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.NewPlus_ChangedTemplateLocation | Triggered when the template folder location is changed. | +| Microsoft.PowerToys.NewPlus_EventCopyTemplate | Triggered when an item from New+ is created (copied to the current directory). | +| Microsoft.PowerToys.NewPlus_EventCopyTemplateResult | Logs the success of item creation (copying). | +| Microsoft.PowerToys.NewPlus_EventOpenTemplates | Triggered when the templates folder is opened. | +| Microsoft.PowerToys.NewPlus_EventShowTemplateItems | Triggered when the New+ context menu flyout is displayed. | +| Microsoft.PowerToys.NewPlus_EventToggleOnOff | Triggered when New+ is enabled or disabled. | ### Peek - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.Peek_ClosedTriggered when Peek is closed.
Microsoft.PowerToys.Peek_EnablePeekOccurs when Peek is enabled.
Microsoft.PowerToys.Peek_ErrorTriggered when an error occurs for Peek.
Microsoft.PowerToys.Peek_InvokePeekOccurs when Peek is invoked.
Microsoft.PowerToys.Peek_OpenedTriggered when a Peek window is opened.
Microsoft.PowerToys.Peek_OpenWithOccurs when an item is opened with Peek.
Microsoft.PowerToys.Peek_SettingsTriggered when the settings for Peek are modified.
Microsoft.PowerToys.Peek_SpaceModeEnabledTriggered when the Space key activation mode is enabled or disabled in Peek
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.Peek_Closed | Triggered when Peek is closed. | +| Microsoft.PowerToys.Peek_EnablePeek | Occurs when Peek is enabled. | +| Microsoft.PowerToys.Peek_Error | Triggered when an error occurs for Peek. | +| Microsoft.PowerToys.Peek_InvokePeek | Occurs when Peek is invoked. | +| Microsoft.PowerToys.Peek_Opened | Triggered when a Peek window is opened. | +| Microsoft.PowerToys.Peek_OpenWith | Occurs when an item is opened with Peek. | +| Microsoft.PowerToys.Peek_Settings | Triggered when the settings for Peek are modified. | +| Microsoft.PowerToys.Peek_SpaceModeEnabled | Triggered when the Space key activation mode is enabled or disabled in Peek. | ### PowerRename - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.PowerRename_EnablePowerRenameTriggered when PowerRename is enabled.
Microsoft.PowerToys.PowerRename_InvokedOccurs when PowerRename is invoked.
Microsoft.PowerToys.PowerRename_InvokedRetTriggered when the invocation of PowerRename returns a result.
Microsoft.PowerToys.PowerRename_RenameOperationTriggered during the rename operation within PowerRename.
Microsoft.PowerToys.PowerRename_SettingsChangedOccurs when the settings for PowerRename are changed.
Microsoft.PowerToys.PowerRename_UIShownRetTriggered when the PowerRename user interface is shown.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.PowerRename_EnablePowerRename | Triggered when PowerRename is enabled. | +| Microsoft.PowerToys.PowerRename_Invoked | Occurs when PowerRename is invoked. | +| Microsoft.PowerToys.PowerRename_InvokedRet | Triggered when the invocation of PowerRename returns a result. | +| Microsoft.PowerToys.PowerRename_RenameOperation | Triggered during the rename operation within PowerRename. | +| Microsoft.PowerToys.PowerRename_SettingsChanged | Occurs when the settings for PowerRename are changed. | +| Microsoft.PowerToys.PowerRename_UIShownRet | Triggered when the PowerRename user interface is shown. | ### PowerToys Run - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.LauncherBootEventTriggered when PowerToys Run is initialized on boot.
Microsoft.PowerToys.LauncherColdStateHotkeyEventOccurs when the hotkey is pressed in the cold state (not yet initialized).
Microsoft.PowerToys.LauncherFirstDeleteEventTriggered when the first deletion action is performed in PowerToys Run.
Microsoft.PowerToys.LauncherHideEventOccurs when PowerToys Run is hidden.
Microsoft.PowerToys.LauncherQueryEventTriggered when a query is made in PowerToys Run.
Microsoft.PowerToys.LauncherResultActionEventOccurs when an action is taken on a result in PowerToys Run.
Microsoft.PowerToys.LauncherShowEventTriggered when PowerToys Run is shown.
Microsoft.PowerToys.LauncherWarmStateHotkeyEventOccurs when the hotkey is pressed in the warm state (initialized).
Microsoft.PowerToys.RunPluginsSettingsEventTriggered when the settings for PowerToys Run plugins are accessed or modified.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.LauncherBootEvent | Triggered when PowerToys Run is initialized on boot. | +| Microsoft.PowerToys.LauncherColdStateHotkeyEvent | Occurs when the hotkey is pressed in the cold state (not yet initialized). | +| Microsoft.PowerToys.LauncherFirstDeleteEvent | Triggered when the first deletion action is performed in PowerToys Run. | +| Microsoft.PowerToys.LauncherHideEvent | Occurs when PowerToys Run is hidden. | +| Microsoft.PowerToys.LauncherQueryEvent | Triggered when a query is made in PowerToys Run. | +| Microsoft.PowerToys.LauncherResultActionEvent | Occurs when an action is taken on a result in PowerToys Run. | +| Microsoft.PowerToys.LauncherShowEvent | Triggered when PowerToys Run is shown. | +| Microsoft.PowerToys.LauncherWarmStateHotkeyEvent | Occurs when the hotkey is pressed in the warm state (initialized). | +| Microsoft.PowerToys.RunPluginsSettingsEvent | Triggered when the settings for PowerToys Run plugins are accessed or modified. | ### Quick Accent - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.PowerAccent_EnablePowerAccentTriggered when Quick Accent is enabled.
Microsoft.PowerToys.PowerAccentShowAccentMenuEventOccurs when the accent menu is displayed.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.PowerAccent_EnablePowerAccent | Triggered when Quick Accent is enabled. | +| Microsoft.PowerToys.PowerAccentShowAccentMenuEvent | Occurs when the accent menu is displayed. | ### Registry Preview - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.RegistryPreview_ActivateTriggered when Registry Preview is activated.
Microsoft.PowerToys.RegistryPreview_EnableRegistryPreviewOccurs when Registry Preview is enabled.
Microsoft.PowerToys.RegistryPreviewEditorStartEventTriggered when the Registry Preview application starts. This logs the initialization of the Registry Preview UI with a timestamp.
Microsoft.PowerToys.RegistryPreviewEditorStartFinishEventTriggered when the Registry Preview application has completed loading and is ready for user interaction.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.RegistryPreview_Activate | Triggered when Registry Preview is activated. | +| Microsoft.PowerToys.RegistryPreview_EnableRegistryPreview | Occurs when Registry Preview is enabled. | +| Microsoft.PowerToys.RegistryPreviewEditorStartEvent | Triggered when the Registry Preview application starts. This logs the initialization of the Registry Preview UI with a timestamp. | +| Microsoft.PowerToys.RegistryPreviewEditorStartFinishEvent | Triggered when the Registry Preview application has completed loading and is ready for user interaction. | ### Screen Ruler - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.MeasureTool_BoundsToolActivatedTriggered when Screen Ruler's Bounds tool is activated.
Microsoft.PowerToys.MeasureTool_EnableMeasureToolOccurs when Screen Ruler is enabled.
Microsoft.PowerToys.MeasureTool_MeasureToolActivatedTriggered when Screen Ruler's Measure tool is activated.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.MeasureTool_BoundsToolActivated | Triggered when Screen Ruler's Bounds tool is activated. | +| Microsoft.PowerToys.MeasureTool_EnableMeasureTool | Occurs when Screen Ruler is enabled. | +| Microsoft.PowerToys.MeasureTool_MeasureToolActivated | Triggered when Screen Ruler's Measure tool is activated. | ### Shortcut Guide - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.ShortcutGuide_GuideSessionLogs a Shortcut Guide session including duration and how it was closed.
Microsoft.PowerToys.ShortcutGuide_SettingsIndicates a change in the settings related to the Shortcut Guide.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.ShortcutGuide_GuideSession | Logs a Shortcut Guide session including duration and how it was closed. | +| Microsoft.PowerToys.ShortcutGuide_Settings | Indicates a change in the settings related to the Shortcut Guide. | ### Text Extractor - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.PowerOCR_EnablePowerOCRTriggered when the Text Extractor (OCR) feature is enabled.
Microsoft.PowerToys.PowerOCRCancelledEventOccurs when the text extraction process is cancelled.
Microsoft.PowerToys.PowerOCRCaptureEventOccurs when the user has created a capture for text extraction.
Microsoft.PowerToys.PowerOCRInvokedEventTriggered when Text Extractor is invoked.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.PowerOCR_EnablePowerOCR | Triggered when the Text Extractor (OCR) feature is enabled. | +| Microsoft.PowerToys.PowerOCRCancelledEvent | Occurs when the text extraction process is cancelled. | +| Microsoft.PowerToys.PowerOCRCaptureEvent | Occurs when the user has created a capture for text extraction. | +| Microsoft.PowerToys.PowerOCRInvokedEvent | Triggered when Text Extractor is invoked. | ### Workspaces - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.Workspaces_CreateEventTriggered when a new workspace is created.
Microsoft.PowerToys.Workspaces_DeleteEventTriggered when a workspace is deleted.
Microsoft.PowerToys.Workspaces_EditEventTriggered when a workspace is edited or modified.
Microsoft.PowerToys.Workspaces_EnableIndicates that Workspaces is enabled.
Microsoft.PowerToys.Workspaces_LaunchEventTriggered when a workspace is launched.
Microsoft.PowerToys.WorkspacesEditorStartEventTriggered when the Workspaces Editor application starts. This logs the initialization of the Workspaces Editor UI with a timestamp.
Microsoft.PowerToys.WorkspacesEditorStartFinishEventTriggered when the Workspaces Editor has completed loading and is ready for user interaction.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.Workspaces_CreateEvent | Triggered when a new workspace is created. | +| Microsoft.PowerToys.Workspaces_DeleteEvent | Triggered when a workspace is deleted. | +| Microsoft.PowerToys.Workspaces_EditEvent | Triggered when a workspace is edited or modified. | +| Microsoft.PowerToys.Workspaces_Enable | Indicates that Workspaces is enabled. | +| Microsoft.PowerToys.Workspaces_LaunchEvent | Triggered when a workspace is launched. | +| Microsoft.PowerToys.WorkspacesEditorStartEvent | Triggered when the Workspaces Editor application starts. This logs the initialization of the Workspaces Editor UI with a timestamp. | +| Microsoft.PowerToys.WorkspacesEditorStartFinishEvent | Triggered when the Workspaces Editor has completed loading and is ready for user interaction. | ### ZoomIt - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Microsoft.PowerToys.ZoomIt_EnableZoomItTriggered when ZoomIt is enabled/disabled.
Microsoft.PowerToys.ZoomIt_StartedTriggered when the ZoomIt process starts.
Microsoft.PowerToys.ZoomIt_ActivateBreakTriggered when the Break mode is entered.
Microsoft.PowerToys.ZoomIt_ActivateDrawTriggered when the Draw mode is entered.
Microsoft.PowerToys.ZoomIt_ActivateZoomTriggered when the Zoom mode is entered.
Microsoft.PowerToys.ZoomIt_ActivateLiveZoomTriggered when the Live Zoom mode is entered.
Microsoft.PowerToys.ZoomIt_ActivateDemoTypeTriggered when the DemoType mode is entered.
Microsoft.PowerToys.ZoomIt_ActivateRecordTriggered when the Record mode is entered.
Microsoft.PowerToys.ZoomIt_ActivateSnipTriggered when the Snip mode is entered.
+ +| Event Name | Description | +| --- | --- | +| Microsoft.PowerToys.ZoomIt_ActivateBreak | Triggered when the Break mode is entered. | +| Microsoft.PowerToys.ZoomIt_ActivateDemoType | Triggered when the DemoType mode is entered. | +| Microsoft.PowerToys.ZoomIt_ActivateDraw | Triggered when the Draw mode is entered. | +| Microsoft.PowerToys.ZoomIt_ActivateLiveZoom | Triggered when the Live Zoom mode is entered. | +| Microsoft.PowerToys.ZoomIt_ActivateRecord | Triggered when the Record mode is entered. | +| Microsoft.PowerToys.ZoomIt_ActivateSnip | Triggered when the Snip mode is entered. | +| Microsoft.PowerToys.ZoomIt_ActivateZoom | Triggered when the Zoom mode is entered. | +| Microsoft.PowerToys.ZoomIt_EnableZoomIt | Triggered when ZoomIt is enabled/disabled. | +| Microsoft.PowerToys.ZoomIt_Started | Triggered when the ZoomIt process starts. | diff --git a/NOTICE.md b/NOTICE.md index 73a3532096..498c688175 100644 --- a/NOTICE.md +++ b/NOTICE.md @@ -17,7 +17,7 @@ This software incorporates material from third parties. ### Martin Chrzan's Color Picker -**Source**: https://github.com/martinchrzan/ColorPicker +**Source**: MIT License @@ -49,7 +49,7 @@ We use the WyHash NuGet package for calculating stable hashes for strings. **Source**: [https://github.com/wangyi-fudan/wyhash](https://github.com/wangyi-fudan/wyhash) -``` +```text This is free and unencumbered software released into the public domain. Anyone is free to copy, modify, publish, use, compile, sell, or @@ -82,7 +82,7 @@ We use the ToolGood.Words.Pinyin NuGet package for converting Chinese characters **Source**: [https://github.com/toolgood/ToolGood.Words.Pinyin](https://github.com/toolgood/ToolGood.Words.Pinyin) -``` +```text MIT License Copyright (c) 2020 ToolGood @@ -106,8 +106,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ``` - -## Utility: Command Palette Built-in Extensions +## Utility: Command palette built-in extensions ### Calculator @@ -117,7 +116,7 @@ We use the exprtk library (exprtk.hpp) to evaluate mathematical expressions. **Source**: [https://github.com/ArashPartow/exprtk](https://github.com/ArashPartow/exprtk) -``` +```text MIT License Copyright (c) 1999-2024 Arash Partow @@ -144,7 +143,7 @@ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ``` -## Utility: PowerToys Run Built-in Extensions +## Utility: PowerToys Run built-in extensions ### Calculator @@ -154,7 +153,7 @@ We use the Mages NuGet package for calculating the result of expression. **Source**: [https://github.com/FlorianRappl/Mages](https://github.com/FlorianRappl/Mages) -``` +```text The MIT License (MIT) Copyright (c) 2016 - 2025 Florian Rappl @@ -178,13 +177,13 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ``` -## Utility: File Explorer Add-ins +## Utility: File Explorer add-ins ### Monaco Editor -**Source**: https://github.com/Microsoft/monaco-editor +**Source**: -**Additional third party notifications:** https://github.com/microsoft/monaco-editor/blob/main/ThirdPartyNotices.txt +**Additional third party notifications:** The MIT License (MIT) @@ -208,9 +207,9 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -### The Quite OK Image Format reference decoder +### The Quite OK image format reference decoder -**Source**: https://github.com/phoboslab/qoi +**Source**: **Note**: [@pedrolamas](https://github.com/pedrolamas) translated and adapted the reference decoder code to C# that is in PowerToys from the original C++ implementation. @@ -240,9 +239,9 @@ SOFTWARE. We use the UTF.Unknown NuGet package for detecting encoding in text/code files. -**Source**: https://github.com/CharsetDetector/UTF-unknown +**Source**: -``` +```text MOZILLA PUBLIC LICENSE Version 1.1 @@ -716,9 +715,9 @@ EXHIBIT A -Mozilla Public License. ## Utility: ImageResizer -### Brice Lams's Image Resizer License +### Brice Lams's Image Resizer license -**Source**: https://github.com/bricelam/ImageResizer/ +**Source**: The MIT License (MIT) @@ -744,10 +743,10 @@ THE SOFTWARE. ## Utility: PowerToys Run -### Wox License +### Wox license -**Fork project source**: https://github.com/jjw24/Wox/ -**Base project source**: https://github.com/Wox-launcher/Wox +**Fork project source**: +**Base project source**: The MIT License (MIT) @@ -770,9 +769,9 @@ COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -### Beta Tadele's Window Walker License +### Beta Tadele's Window Walker license -**Source**: https://github.com/betsegaw/windowwalker +**Source**: The MIT License (MIT) @@ -786,9 +785,9 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI ## Utility: PowerRename -### Chris Davis's SmartRename License +### Chris Davis's SmartRename license -**Source**: https://github.com/chrdavis/SmartRename +**Source**: MIT License @@ -816,7 +815,7 @@ SOFTWARE. ### spdlog -**Source**: https://github.com/gabime/spdlog +**Source**: The MIT License (MIT) @@ -841,12 +840,12 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -- NOTE: Third party dependency used by this software -- -This software depends on the fmt lib (MIT License), -and users must comply to its license: https://github.com/fmtlib/fmt/blob/master/LICENSE.rst +This software depends on the fmt lib (MIT License), and users must comply to its license: + ### expected-lite -**Source**: https://github.com/martinmoene/expected-lite +**Source**: Boost Software License - Version 1.0 - August 17th, 2003 @@ -874,7 +873,7 @@ DEALINGS IN THE SOFTWARE. ### zip -**Source**: https://github.com/kuba--/zip +**Source**: All Rights Reserved. @@ -902,7 +901,7 @@ THE SOFTWARE. We adopted some functions from it. -**Source**: https://github.com/DLTcollab/sse2neon +**Source**: sse2neon is freely redistributable under the MIT License. Permission is hereby granted, free of charge, to any person obtaining a copy @@ -925,9 +924,9 @@ SOFTWARE. ### Monaco Editor -**Source**: https://github.com/Microsoft/monaco-editor +**Source**: -**Additional third party notifications:** https://github.com/microsoft/monaco-editor/blob/main/ThirdPartyNotices.txt +**Additional third party notifications:** The MIT License (MIT) @@ -951,11 +950,11 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -### The Quite OK Image Format reference decoder +### The Quite OK image format reference decoder -**Source**: https://github.com/phoboslab/qoi +**Source**: -**Note**: [@pedrolamas](https://github.com/pedrolamas) translated and adapted the reference decoder code to C# that is in PowerToys from the original C++ implementation. +**Note**: [@pedrolamas](https://github.com/pedrolamas) translated and adapted the reference decoder code to C# that is in PowerToys, from the original C++ implementation. MIT License @@ -979,13 +978,13 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -### UTF Unknown +### UTF unknown We use the UTF.Unknown NuGet package for detecting encoding in text/code files. -**Source**: https://github.com/CharsetDetector/UTF-unknown +**Source**: -``` +```text MOZILLA PUBLIC LICENSE Version 1.1 @@ -1463,9 +1462,9 @@ EXHIBIT A -Mozilla Public License. We use HexBox.WinUI to show a preview of binary values. -**Source**: https://github.com/hotkidfamily/HexBox.WinUI +**Source**: -``` +```text MIT License Copyright (c) 2019 Filip Jeremic @@ -1492,11 +1491,11 @@ SOFTWARE. ### Monaco Editor -**Source**: https://github.com/Microsoft/monaco-editor +**Source**: -**Additional third party notifications:** https://github.com/microsoft/monaco-editor/blob/main/ThirdPartyNotices.txt +**Additional third party notifications:** -``` +```text The MIT License (MIT) Copyright (c) 2016 - present Microsoft Corporation @@ -1526,7 +1525,7 @@ SOFTWARE. PowerDisplay's DDC/CI implementation references techniques from Twinkle Tray. -**Source**: https://github.com/xanderfrangos/twinkle-tray +**Source**: MIT License diff --git a/README.md b/README.md index e79558796f..cacad6e06c 100644 --- a/README.md +++ b/README.md @@ -19,14 +19,13 @@ · Release notes -

## 🔨 Utilities -PowerToys includes over 25 utilities to help you customize and optimize your Windows experience: +PowerToys includes over 30 utilities to help you customize and optimize your Windows experience: | | | | -|---|---|---| +| --- | --- | --- | | [Advanced Paste icon Advanced Paste](https://aka.ms/PowerToysOverview_AdvancedPaste) | [Always on Top icon Always on Top](https://aka.ms/PowerToysOverview_AoT) | [Awake icon Awake](https://aka.ms/PowerToysOverview_Awake) | | [Color Picker icon Color Picker](https://aka.ms/PowerToysOverview_ColorPicker) | [Command Not Found icon Command Not Found](https://aka.ms/PowerToysOverview_CmdNotFound) | [Command Palette icon Command Palette](https://aka.ms/PowerToysOverview_CmdPal) | | [Crop and Lock icon Crop And Lock](https://aka.ms/PowerToysOverview_CropAndLock) | [Environment Variables icon Environment Variables](https://aka.ms/PowerToysOverview_EnvironmentVariables) | [FancyZones icon FancyZones](https://aka.ms/PowerToysOverview_FancyZones) | @@ -38,28 +37,27 @@ PowerToys includes over 25 utilities to help you customize and optimize your Win | [Shortcut Guide icon Shortcut Guide](https://aka.ms/PowerToysOverview_ShortcutGuide) | [Text Extractor icon Text Extractor](https://aka.ms/PowerToysOverview_TextExtractor) | [Workspaces icon Workspaces](https://aka.ms/PowerToysOverview_Workspaces) | | [ZoomIt icon ZoomIt](https://aka.ms/PowerToysOverview_ZoomIt) | | | +## 📦 Installation -## 📋 Installation - -For detailed installation instructions and system requirements, visit the [installation docs](https://learn.microsoft.com/windows/powertoys/install). +For detailed installation instructions and system requirements, visit the [installation docs](https://learn.microsoft.com/windows/powertoys/install). But to get started quickly, choose one of the installation methods below:

-Download .exe from GitHub +Download the .exe file from GitHub
-Go to the PowerToys GitHub releases, click Assets to reveal the downloads, and choose the installer that matches your architecture and install scope. For most devices, that's the x64 per-user installer. + +Go to the [PowerToys GitHub releases](https://aka.ms/installPowerToys), select **Assets** to reveal the installation files, and choose the one that matches your architecture and install scope. For most devices, that would be _x64 per-user_. [github-next-release-work]: https://github.com/microsoft/PowerToys/issues?q=is%3Aissue+milestone%3A%22PowerToys+0.99%22 -[github-current-release-work]: https://github.com/microsoft/PowerToys/issues?q=is%3Aissue+milestone%3A%22PowerToys+0.98%22 [ptUserX64]: https://github.com/microsoft/PowerToys/releases/download/v0.98.1/PowerToysUserSetup-0.98.1-x64.exe -[ptUserArm64]: https://github.com/microsoft/PowerToys/releases/download/v0.98.1/PowerToysUserSetup-0.98.1-arm64.exe -[ptMachineX64]: https://github.com/microsoft/PowerToys/releases/download/v0.98.1/PowerToysSetup-0.98.1-x64.exe +[ptUserArm64]: https://github.com/microsoft/PowerToys/releases/download/v0.98.1/PowerToysUserSetup-0.98.1-arm64.exe +[ptMachineX64]: https://github.com/microsoft/PowerToys/releases/download/v0.98.1/PowerToysSetup-0.98.1-x64.exe [ptMachineArm64]: https://github.com/microsoft/PowerToys/releases/download/v0.98.1/PowerToysSetup-0.98.1-arm64.exe - -| Description | Filename | -|----------------|----------| + +| Description | Filename | +| --- | --- | | Per user - x64 | [PowerToysUserSetup-0.98.1-x64.exe][ptUserX64] | | Per user - ARM64 | [PowerToysUserSetup-0.98.1-arm64.exe][ptUserArm64] | | Machine wide - x64 | [PowerToysSetup-0.98.1-x64.exe][ptMachineX64] | @@ -83,14 +81,16 @@ You can easily install PowerToys from the Microsoft Store:
WinGet
-Download PowerToys from WinGet. Updating PowerToys via winget will respect the current PowerToys installation scope. To install PowerToys, run the following command from the command line / PowerShell: +Download PowerToys from [WinGet](https://github.com/microsoft/winget-cli#installing-the-client). Updating PowerToys via winget will respect the current PowerToys installation scope. To install PowerToys, run the following command from the command line / PowerShell: + +- User scope installer (default) -*User scope installer [default]* ```powershell winget install Microsoft.PowerToys -s winget ``` -*Machine-wide scope installer* +- Machine-wide scope installer + ```powershell winget install --scope machine Microsoft.PowerToys -s winget ``` @@ -99,7 +99,7 @@ winget install --scope machine Microsoft.PowerToys -s winget
Other methods
-There are community driven install methods such as Chocolatey and Scoop. If these are your preferred install solutions, you can find the install instructions there. +There are [community driven install methods](https://learn.microsoft.com/windows/powertoys/install#community-driven-install-tools) such as Chocolatey and Scoop. If these are your preferred install solutions, you can find the install instructions there.
## ✨ What's new? @@ -108,28 +108,26 @@ There are