Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Run][Plugin Manager] Doc for 3rd party plugins #27566

Merged
merged 12 commits into from
Aug 8, 2023
10 changes: 10 additions & 0 deletions .github/actions/spell-check/expect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ BOKMAL
bootstrapper
BOOTSTRAPPERINSTALLFOLDER
Bopomofo
bostrot
BOTTOMALIGN
BPBF
bpmf
Expand Down Expand Up @@ -754,6 +755,7 @@ FZE
gabime
GAC
gacutil
Galaxi
Gaeilge
Gaidhlig
GBarm
Expand All @@ -766,6 +768,7 @@ gcode
gdi
gdiplus
GDISCALED
GEmoji
GETDESKWALLPAPER
GETDLGCODE
GETDPISCALEDSIZE
Expand Down Expand Up @@ -856,6 +859,7 @@ HKL
HKLM
HKPD
HKU
hlaueriksson
HLOCAL
HMD
hmenu
Expand Down Expand Up @@ -1637,6 +1641,7 @@ ptc
ptd
PTOKEN
PToy
ptrun
ptstr
pui
PULONG
Expand Down Expand Up @@ -1681,6 +1686,7 @@ RCtrl
READMODE
READOBJECTS
READWRITE
recents
RECTDESTINATION
RECTL
rectp
Expand Down Expand Up @@ -1913,6 +1919,7 @@ SIZENWSE
sizeread
SIZEWE
SKIPOWNPROCESS
skttl
sku
SLGP
sln
Expand Down Expand Up @@ -2047,6 +2054,7 @@ taskbar
taskkill
tasklist
taskschd
TBM
tchar
tcl
Tcollab
Expand Down Expand Up @@ -2410,12 +2418,14 @@ XStr
XUP
XVIRTUALSCREEN
YAxis
ycv
Yeet
YIncrement
yinle
yinwang
yinyue
YOffset
Youdao
YPels
ypescript
YResolution
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,10 @@ winget install --scope machine Microsoft.PowerToys -s winget

There are [community driven install methods](./doc/unofficialInstallMethods.md) such as Chocolatey and Scoop. If these are your preferred install solutions, you can find the install instructions there.

## Third-Party Run Plugins

Collection of [third-party plugins](./doc/thirdPartyRunPlugins.md) created by the community that aren't distributed with PowerToys.

## 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.
Expand Down
35 changes: 35 additions & 0 deletions doc/thirdPartyRunPlugins.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Third-Party Run Plugins

Collection of third-party Run plugins created by the community that aren't distributed with PowerToys.

## Installing / Upgrading

The recommended path for the plugins is `%LOCALAPPDATA%\Microsoft\PowerToys\PowerToys Run\Plugins`.

- Close PowerToys
- Copy the plugin folder to `%LOCALAPPDATA%\Microsoft\PowerToys\PowerToys Run\Plugins`
- Delete previous version in case of upgrade
- Open PowerToys

Refer to plugin instruction for more details.

## Disclaimer

The following plugins are created and maintained by third-party and not officially supported or recognized by Microsoft.
Users install and use these plugins at their own risk, and Microsoft takes no responsibility for their functionality or any potential issues they may cause.
For assistance, please contact the respective plugin developers directly.

## Plugins

| Plugin | Description |
| ------ | ----------- |
| [BrowserSearch](https://github.com/TBM13/BrowserSearch) | Search in your browser history |
| [Edge Favorite](https://github.com/davidegiacometti/PowerToys-Run-EdgeFavorite) | Open Microsoft Edge favorites |
| [Everything](https://github.com/lin-ycv/EverythingPowerToys) | Get search results from Everything |
| [GitHub Emoji](https://github.com/hlaueriksson/GEmojiSharp) | Search GitHub Emoji |
| [GitKraken](https://github.com/davidegiacometti/PowerToys-Run-GitKraken) | Open GitKraken repositories |
| [Guid](https://github.com/skttl/ptrun-guid) | Guid generator |
| [PowerTranslator](https://github.com/N0I0C0K/PowerTranslator) | Text translator based on Youdao |
| [Quick Lookup](https://github.com/GTGalaxi/quick-lookup-ptrun) | Search across multiple cyber security tools |
| [Visual Studio](https://github.com/davidegiacometti/PowerToys-Run-VisualStudio) | Open Visual Studio recents |
| [WinGet](https://github.com/bostrot/PowerToysRunPluginWinget) | Search and install packages from WinGet |
Original file line number Diff line number Diff line change
Expand Up @@ -269,10 +269,17 @@
</InfoBar.ActionButton>
</InfoBar>

<labs:SettingsCard
x:Uid="Run_PluginUseDescription"
HeaderIcon="{ui:FontIcon FontFamily={StaticResource SymbolThemeFontFamily},
Glyph=&#xEA86;}">
<labs:SettingsCard
x:Uid="Run_PluginUse"
HeaderIcon="{ui:FontIcon FontFamily={StaticResource SymbolThemeFontFamily}, Glyph=&#xEA86;}">
<labs:SettingsCard.Description>
<StackPanel>
<TextBlock x:Uid="Run_PluginUseDescription" />
<HyperlinkButton
x:Uid="Run_PluginUseFindMorePlugins"
NavigateUri="https://aka.ms/powerToysRunPlugins" />
</StackPanel>
</labs:SettingsCard.Description>
<AutoSuggestBox
x:Uid="PowerLauncher_SearchList"
MinWidth="{StaticResource SettingActionControlMinWidth}"
Expand Down Expand Up @@ -477,6 +484,9 @@
<controls:PageLink
x:Uid="LearnMore_Run"
Link="https://aka.ms/PowerToysOverview_PowerToysRun" />
<controls:PageLink
x:Uid="Run_FindMorePlugins"
Link="https://aka.ms/powerToysRunPlugins" />
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link needs to be created

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You want to direct it to https://github.com/microsoft/PowerToys/blob/main/doc/thirdPartyRunPlugins.md , which would be live after merging, is that right?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

</controls:SettingsPageControl.PrimaryLinks>
<controls:SettingsPageControl.SecondaryLinks>
<controls:PageLink
Expand Down
12 changes: 9 additions & 3 deletions src/settings-ui/Settings.UI/Strings/en-us/Resources.resw
Original file line number Diff line number Diff line change
Expand Up @@ -1856,10 +1856,10 @@ Made with 💗 by Microsoft and the PowerToys community.</value>
<data name="Run_AllPluginsDisabled.Message" xml:space="preserve">
<value>Enable at least one plugin to get started</value>
</data>
<data name="Run_PluginUseDescription.Header" xml:space="preserve">
<data name="Run_PluginUse.Header" xml:space="preserve">
<value>Plugins</value>
</data>
<data name="Run_PluginUseDescription.Description" xml:space="preserve">
<data name="Run_PluginUseDescription.Text" xml:space="preserve">
<value>Include or remove plugins from the global results, change the direct activation phrase and configure additional options</value>
</data>
<data name="Run_PositionAppearance_GroupSettings.Header" xml:space="preserve">
Expand Down Expand Up @@ -3592,4 +3592,10 @@ Activate by holding the key for the character you want to add an accent to, then
<data name="MouseUtils_MousePointerCrosshairs_CrosshairsAutoHide.Content" xml:space="preserve">
<value>Automatically hide crosshairs when the mouse pointer is hidden</value>
</data>
</root>
<data name="Run_FindMorePlugins.Text" xml:space="preserve">
<value>Find more plugins</value>
</data>
<data name="Run_PluginUseFindMorePlugins.Content" xml:space="preserve">
<value>Find more plugins</value>
</data>
</root>