pdawg-bytes / gyroshell Goto Github PK

A shell for Windows 11 (and maybe 10) that aims to allow for a much more customizable and streamlined shell experience. Fully written in C# WASDK.

License: BSD 3-Clause "New" or "Revised" License

C# 100.00%

customizable shell windows wasdk csharp win10 win11 dotnet plugin winui3

gyroshell's Introduction

GyroShell is a shell for Windows 11 (and maybe 10) that aims to provide a customizable and functional shell experience. The shells UI is written in WinUI 3 XAML, and the backend is composed of C#; all brought together by WASDK.

Warning

GyroShell is currently under heavy development and may not be stable.

📦 Building

To build GyroShell, you're gonna need a few things.

Install Microsoft Visual Studio 2022 (any edition works)
Make sure you've installed the .NET Desktop Development workload, with Windows App SDK C# Templates checked in extras.
Open the GyroShell project by clicking the GyroShell.sln file in your file explorer.
At the top of Visual Studio, click the GyroShell (Packaged) button to compile and start the shell in Debug mode.

⌨️ Developing for GyroShell

GyroShell is an extensible platform that supports external plugins. These plugins enable the community to easily create custom UIs or backend features for the shell. To create custom plugins, check out the wiki.

💿 Installing

To install GyroShell, download the latest release, then install the app package in the downloaded release.

Note

Since GyroShell is under development, you may not see any releases. Once a build is stable, it will be released.

🤝 Contributing

To contribute to GyroShell, follow the contribution guide. All contributions are appreciated!

❤️ Major Contributors

People in this section have contributed a significant amount to GyroShell. Thank you, contributors!

Pdawg - Lead developer of GyroShell. Works on the UI, backend, and design.
AnalogFeelings - Implemented Dependency Injection, refined the UI, and cleaned up the backend.
Rounak - Implemented the taskbar icon system and some shell hooking code.

⚖️ License

GyroShell is licensed under the Modified BSD License (3-clause), found here.

Screenshots (subject to change)

gyroshell's People

Contributors

Stargazers

Watchers

Forkers

donut2008 analogfeelings zoomer1234 starnumber12046 mishaproductions pronoy2108 redpcat useful-stuff prelevatedinsider17763 rounk-ctrl pa-0 pocketappz grandiras izuku-sevilla

gyroshell's Issues

[Suggestion] Use GitHub actions after Public Alpha testing

Using GitHub Actions would auto-build binaries for development builds and I think it'll improve feedback and development for the program.

[GyroShell BUG]

Describe the bug
Taskbar disappears after running then stopping Gyroshell.

To Reproduce
Steps to reproduce the behavior (provide the most specific actions you can):

Go to 'visual studio'
Click on 'run the program'
Stop the program
Taskbar disappears

Expected behavior
Taskbar should come back after stopping Gyroshell.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

OS: [Windows 11]
OS Version [22621]
GyroShell Version [latest]
Architecture [X64]

Additional context
Add any other context about the problem here.

[Feature Request] Plugin support

Is your feature request related to a problem? Please describe.
At the moment, I have to either modify the source code and recompile it, or inject dlls into the shell in order to modify its behaviour.

Describe the solution you'd like
A plugin system with a flexible API, for modifying the behaviour of the shell.

Describe alternatives you've considered
I can hook into it, but that is a hack. Also recompiling is an option but pretty annoying, as you have to merge changes when new versions come out.

Additional context
I do not expect this to be added for the moment, but I'd like for this to become a thing, at some point.

Cannot download GyroShell.

In the README.md, it is written the following: "To install GyroShell, just download the app package from releases and install the certificate to "Local Machine > Trusted People"."
There is no app package in releases, it's empty.

How to install

How do I install this?

[GyroShell -> Finish AppBar implementation.]

The shell needs to hide explorer and keep it hidden, while creating its AppBar on top of the main bars hit box.

BUGS:

Taskbar keeps coming back.

(reason: AppBar autohide works, but then the taskbar randomly appears. When I use SWP, there is a space below the appbar where the taskbar should be. When I use both, GyroShell does go to the right spot, but then the taskbar randomly comes back.

[GyroShell -> Add working taskbar icons.]

The shell needs working taskbar icons.

(Question) Is this safe on windows 11 insider canary builds

Is this safe to install? When I installed explorer patcher on a windows 11 canary build It looped crashed windows explorer so I am asking if it is safe