PowerToys/README.md
2022-11-29 11:41:22 -08:00

15 KiB
Raw Blame History

Microsoft PowerToys

Hero image for Microsoft PowerToys

How to use PowerToys | Downloads & Release notes | Contributing to PowerToys | What's Happening | Roadmap

Build status

Architecture Solution (Main) Solution (Stable) Installer (Main)
x64 Build Status for Main Build Status for Stable Build Status Installer pipeline
ARM64 Build Status for Main Build Status for Main Build Status Installer pipeline

About

Microsoft PowerToys is a set of utilities for power users to tune and streamline their Windows experience for greater productivity. For more info on PowerToys overviews and how to use the utilities, or any other tools and resources for Windows development environments, head over to learn.microsoft.com!

Current utilities:
Always on Top PowerToys Awake Color Picker
FancyZones File Explorer Add-ons File Locksmith
Hosts File Editor Image Resizer Keyboard Manager
Mouse utilities PowerRename PowerToys Run
Quick Accent Screen Ruler Shortcut Guide
Text Extractor Video Conference Mute

Installing and running Microsoft PowerToys

Requirements

Go to Microsoft PowerToys GitHub releases page, click on Assets at the bottom to show the files available in the release. Please use the appropriate the PowerToys installer that matches your machine's architecture. For most, it is x64.

This is our preferred method.

Via Microsoft Store

Install from the Microsoft Store's PowerToys page. You must be using the new Microsoft Store which will be available for both Windows 11 and Windows 10.

Via WinGet (Preview)

Download PowerToys from WinGet. To install PowerToys, run the following command from the command line / PowerShell:

winget install Microsoft.PowerToys -s winget

Other install methods

There are community driven install methods such as Chocolatey and Scoop. If these are your preferred install solutions, this will have the install instructions.

Contributing

This project welcomes contributions of all types. Help spec'ing, design, documentation, finding bugs are ways everyone can help on top of coding features / bug fixes. We are excited to work with the power user community to build a set of tools for helping you get the most out of Windows.

We ask that before you start work on a feature that you would like to contribute, please read our Contributor's Guide. We will be happy to work with you to figure out the best approach, provide guidance and mentorship throughout feature development, and help avoid any wasted or duplicate effort.

Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution.

For guidance on developing for PowerToys, please read the developer docs for a detailed breakdown. This includes how to setup your computer to compile.

What's Happening

PowerToys Roadmap

Our prioritized roadmap of features and utilities that the core team is focusing on.

0.64 - October 2022 Update

In this release, we focused on releasing new features and improvements.

Highlights

  • New utility: File Locksmith allows seeing which processes are currently using the selected files.
  • New utility: Hosts File Editor allows you to edit your hosts file in an Editor UI. Thanks @davidegiacometti!
  • Settings has a new feature for backing up / restoring the settings from a file. Thanks @jefflord!
  • FancyZones allows you to set defaults for horizontal/vertical screens to get better intended behavior for new screens and cases where a monitor ID resets.
  • PowerToys ships with Group Policy Objects settings for force disabling and enabling PowerToys utilities in organizations. Check the GPO docs for more details.
  • Added a warning about deprecating Video Conference Mute in the future (v0.67), please check https://github.com/microsoft/PowerToys/issues/21473 for more information.

Known issues

Always on Top

  • Detect and put a window on top again if it's no longer on top.

Color Picker

FancyZones

  • Added a way for users to configure default layouts for horizontal and vertical screens.
  • Replaced remaining Number Boxes in FancyZones Editor with Sliders, to improve accessibility for screen readers.
  • Fixed an issue breaking window switching shortcuts.

File Locksmith

  • Added a new utility: File Locksmith.
  • Thanks @niels9001 for the design on the UI!

Group Policy Objects

  • Group Policy Objects settings for force disabling and enabling PowerToys utilities.
  • Thanks @htcfreek for your help in reviewing to make sure the shipped settings conform to system administrators expectations!

Hosts File Editor

  • Added a new utility: Hosts File Editor. Thanks @davidegiacometti!
  • Thanks @niels9001 for the design help on the UI!
  • Thanks @davidegiacometti for fixing the bugs found and adding features up until release!
  • Thanks @AtariDreams for consolidating the packages comparing to the rest of the project!
  • Thanks @htcfreek for adding a scrollviewer to the entry editor!

Keyboard Manager

  • Fixed a delay that was not being cancelled properly. Thanks @AtariDreams!

Mouse Utilities

PowerToys Run

  • Changed image loading to release the images in PowerToys Run main executable. This is a try to fix the "app.dark.png" missing issues received after a PowerToys update.
  • Fixed the PowerToys Run hiding after the default action failed. Thanks @hlaueriksson!
  • Fixed the PowerToys Run allows showing after a context menu action succeeded. Thanks @hlaueriksson!

Quick Accent

  • Corrected "Dutch" word to "German". Thanks @damienleroy!
  • Added the Portuguese language accents. Thanks @pcanavar!
  • Fixed positioning of toolbar on scaled desktops.

Screen Ruler

  • Improved the acrylic brush used in the menu. Thanks @niels9001!

Settings

  • Added a feature to backup/restore settings to/from a file. Thanks @jefflord!
  • Fixed an issue causing shortcuts shown in OOBE not updating to new values when the window was re-opened.
  • Fixed the "Documents" folder usage in the backup/restore feature. Thanks @davidegiacometti!

Text Extractor

  • Added a warning about how to install languages for OCR recognition.
  • Fixed the overlay not focusing after the first activation.
  • Added spaces between CJK and non-CJK words. Thanks @maggch97!

Video Conference Mute

Installer

  • Added some missing files that were causing Settings and PowerRename to not function correctly on some configurations.
  • Updated the .NET dependency to 6.0.10.

Development

  • Consolidated nuget packages and removed a few unused packages.
  • Updated the Windows.CppRT to the latest version. Thanks @AtariDreams!
  • Removed the cxxopts dependency, which was no longer used. Thanks @AtariDreams!
  • Updated the cziplob dependency to 0.25. Thanks @AtariDreams!
  • Updated the System.IO.Abstractions dependency. Thanks @davidegiacometti!
  • Turned on C++ code analysis and incrementally fixing warnings.
  • Added the install method to the issue template on GitHub, since some issues seem to be related to specific installation methods.
  • Automated installer hash creation in the release CI.
  • Simplified use of .First() on ImageResizer. Thanks @AtariDreams!
  • Improved and clarified the issues templates. Thanks @Jay-o-Way!
  • Fixed a PTRun unit test to be more compatible with .NET 6. Thanks @AtariDreams!

What is being planned for version 0.65

For v0.65, we'll work on below:

  • Ship .NET self contained and shared between utilities
  • Stability / bug fixes

PowerToys Community

The PowerToys team is extremely grateful to have the support of an amazing active community. The work you do is incredibly important. PowerToys wouldnt be nearly what it is today without your help filing bugs, updating documentation, guiding the design, or writing features. We want to say thank you and take time to recognize your work. Month over month, you directly help make PowerToys a better piece of software.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct.

Privacy Statement

The application logs basic telemetry. Our Telemetry Data page (Coming Soon) has the trends from the telemetry. Please read the Microsoft privacy statement for more information.