Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Pdawg-bytes/GyroShell

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.
https://github.com/Pdawg-bytes/GyroShell

csharp customizable dotnet plugin shell wasdk win10 win11 windows winui3

Last synced: 3 months ago
JSON representation

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.

Awesome Lists containing this project

README

        



---

[![GitHub issues](https://img.shields.io/github/issues/pdawg-bytes/GyroShell?label=Issues&style=flat-square)](https://github.com/Pdawg-bytes/GyroShell/issues)
[![GitHub pull requests](https://img.shields.io/github/issues-pr/pdawg-bytes/GyroShell?label=Pull%20Requests&style=flat-square)](https://github.com/Pdawg-bytes/GyroShell/pulls)
[![GitHub](https://img.shields.io/github/license/pdawg-bytes/GyroShell?label=License&style=flat-square)](https://github.com/Pdawg-bytes/GyroShell/blob/master/LICENSE)
[![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/m/pdawg-bytes/GyroShell/main?label=Commit%20Activity&style=flat-square)](https://github.com/Pdawg-bytes/GyroShell/graphs/commit-activity)
[![GitHub contributors](https://img.shields.io/github/contributors/Pdawg-bytes/GyroShell?style=flat-square&label=Contributors)](https://github.com/Pdawg-bytes/GyroShell/graphs/contributors)
[![GitHub Repo stars](https://img.shields.io/github/stars/Pdawg-bytes/GyroShell?label=Stargazers&style=flat-square)](https://github.com/Pdawg-bytes/GyroShell/stargazers)

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.


## :package: Building
To build GyroShell, you're gonna need a few things.
1. Install Microsoft Visual Studio 2022 (any edition works)
2. Make sure you've installed the `.NET Desktop Development` workload, with `Windows App SDK C# Templates` checked in extras.
3. Open the GyroShell project by clicking the `GyroShell.sln` file in your file explorer.
4. 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](https://github.com/Pdawg-bytes/GyroShell/wiki).

## 💿 Installing
To install GyroShell, download the [latest release](https://github.com/Pdawg-bytes/GyroShell/releases), 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](https://github.com/Pdawg-bytes/GyroShell/blob/main/CONTRIBUTING.md). 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.

## :balance_scale: License
GyroShell is licensed under the **Modified BSD License (3-clause)**, found [here](https://github.com/Pdawg-bytes/GyroShell/blob/main/LICENSE).

# Screenshots (***subject to change***)
![image](https://github.com/Pdawg-bytes/GyroShell/assets/83825746/2c440e92-4ea8-4717-a1de-ee1f8cd63def)
![image](https://github.com/Pdawg-bytes/GyroShell/assets/83825746/ebec31aa-ef2c-4366-9f6d-34ef845f59a7)
![image](https://github.com/Pdawg-bytes/GyroShell/assets/83825746/87c15bf0-e91e-47d8-91ff-4722b86cb43d)
![image](https://github.com/Pdawg-bytes/GyroShell/assets/83825746/8ff5f9b5-e67f-43f6-bff9-ba5b4b93dd5e)