Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/brunostjohn/zefirs-flashy-cooler

Elevate your cooler with modern and reactive themes.
https://github.com/brunostjohn/zefirs-flashy-cooler

cooler rgb rust svelte tauri

Last synced: 3 months ago
JSON representation

Elevate your cooler with modern and reactive themes.

Host: GitHub
URL: https://github.com/brunostjohn/zefirs-flashy-cooler
Owner: brunostjohn
License: agpl-3.0
Created: 2022-12-28T04:51:05.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-03-24T15:18:44.000Z (10 months ago)
Last Synced: 2024-05-01T22:55:11.952Z (8 months ago)
Topics: cooler, rgb, rust, svelte, tauri
Language: Rust
Homepage: https://zefirsflashycooler.app
Size: 19.1 MB
Stars: 13
Watchers: 4
Forks: 3
Open Issues: 2
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        






  

    

  

Zefir's Flashy Cooler


  


    Elevate your cooler with modern and reactive themes.

    


    Explore the docs »

    


    


    Download now

    ·

    Report Bug

    ·

    Request Feature

  

  

    

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  



## Current project status

I am currently in a very busy period in life so work on this project has significantly slowed down. I'm still here and it's all still happening, it's just going to take much longer until this new version is usable. It's getting there. **Contributions are both welcome and needed.** It's hard to estimate how long it'll take to get this new version off the ground, but it will come. Thanks for waiting. Issues will all be dealt with in due course, I understand that the current JS implementation of this is kind of crap. This new version will be much more robust and much cooler, and most importantly, much more powerful. Cheers.

## 💖 Sponsors

Thank you for your ongoing support. [Click here to become my sponsor.](https://github.com/sponsors/brunostjohn)

## 📔Table of Contents



  

    About The Project

    

      Built With

    

  

  

    Getting Started

    

      Prerequisites

      Installation

    

  

  Usage

  Roadmap

  Contributing

  License

  Contact

  Acknowledgments



## 🌟 About The Project

This project aims to entirely replace iCUE and other pieces of software like it in control of CPU coolers etc. with LCD displays.

(back to top)


### 👾 Built With

![Rust](https://img.shields.io/badge/Rust-000000?style=for-the-badge&logo=rust&logoColor=white)

![Svelte](https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00)

![TailwindCSS](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)

![C#](https://img.shields.io/badge/C%23-239120?style=for-the-badge&logo=c-sharp&logoColor=white)

![C](https://img.shields.io/badge/C-00599C?style=for-the-badge&logo=c&logoColor=white)

![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)

![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white)

(back to top)


## 🧰 Getting Started

To build this project locally, you will need a few dependencies set up.

### ‼️ Prerequisites

1. Set up a Rust toolchain using [Rustup](https://rustup.rs/).

2. Install Visual Studio Community 2022 with a C# workload.

3. Install the .NET AOT runtime package from NuGet.

4. Install Chocolatey.

5. Install the following dependencies from Chocolatey:

   - LLVM 15.0.7

   - NASM

   - CMake

6. Run `cargo tauri dev`.

In case of issues, follow the error messages until everything works. For support, try messaging me through [our discord server](https://discord.gg/KXmnwA6zWK).

### ⚙️ Installation

1. Download the [latest app release from GitHub](https://github.com/brunostjohn/zefirs-flashy-cooler/releases/).

2. Follow the installer.

(back to top)


## 🏃 Usage

To use this app without making themes, just download some from the Theme Store and enjoy. It should work right out of the box.

_For more information, please refer to the [Documentation](https://zefirsflashycooler.app)_

(back to top)


## 🎯 Roadmap

- [ ] A complete rewrite in Rust.

- [ ] Support for more coolers (including NZXT).

- [ ] More app stability.

- [ ] More services for theme creators.

- [ ] Better performance metrics.

- [ ] Linux support.

(back to top)


## 👋 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

1. Fork the project.

2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`).

3. Commit your changes (`git commit -m 'Add some AmazingFeature'`).

4. Push to the branch (`git push origin feature/AmazingFeature`).

5. Open a Pull Request.

(back to top)


## ⚠️ License

Distributed under the AGPLv3 License. See `LICENSE` for more information.

(back to top)


## 🤝 Contact

Bruno St. John - [email protected]

Project Link: [https://github.com/brunostjohn/zefirs-flashy-cooler](https://github.com/brunostjohn/zefirs-flashy-cooler)

Website: [https://zefirsflashycooler.app](https://zefirsflashycooler.app)

Discord: [https://discord.gg/KXmnwA6zWK](https://discord.gg/KXmnwA6zWK)

(back to top)


## 💎 Acknowledgments

- Zefir for being the best cat on Planet Earth.

- Klaudia for living with me as I am visibly frustrated at a computer.

- The King Boardstar for being willing to test software that doesn't even work on his hardware.

- Dordo for bootstrapping this project by helping with reverse engineering the Capellix LCD.

- Heal-bot for yelling at me when I do stupid stuff.

- Joe.

(back to top)


[contributors-shield]: https://img.shields.io/github/contributors/brunostjohn/zefirs-flashy-cooler.svg?style=for-the-badge

[gh_dls]: https://img.shields.io/github/downloads/brunostjohn/zefirs-flashy-cooler/total?style=for-the-badge

[contributors-url]: https://github.com/brunostjohn/zefirs-flashy-cooler/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/brunostjohn/zefirs-flashy-cooler.svg?style=for-the-badge

[forks-url]: https://github.com/brunostjohn/zefirs-flashy-cooler/network/members

[stars-shield]: https://img.shields.io/github/stars/brunostjohn/zefirs-flashy-cooler.svg?style=for-the-badge

[stars-url]: https://github.com/brunostjohn/zefirs-flashy-cooler/stargazers

[issues-shield]: https://img.shields.io/github/issues/brunostjohn/zefirs-flashy-cooler.svg?style=for-the-badge

[issues-url]: https://github.com/brunostjohn/zefirs-flashy-cooler/issues

[license-shield]: https://img.shields.io/github/license/brunostjohn/zefirs-flashy-cooler.svg?style=for-the-badge

[license-url]: https://github.com/brunostjohn/zefirs-flashy-cooler/blob/master/LICENSE.txt

[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555

[linkedin-url]: https://linkedin.com/in/brunostjohn

[product-screenshot]: static/images/screenshot.png

[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00

[Svelte-url]: https://svelte.dev/

[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white

[Bootstrap-url]: https://getbootstrap.com