Metadata-Version: 2.4
Name: lumisync
Version: 0.1.0
Summary: A Python library for syncing Govee led strips with audio and screen content.
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: colorama>=0.4.6
Requires-Dist: colour>=0.1.5
Requires-Dist: dxcam>=0.0.5
Requires-Dist: numpy>=2.2.4
Requires-Dist: pillow>=11.1.0
Requires-Dist: soundcard>=0.4.4
Dynamic: license-file


<h1 align="center">
  <br>
  LumiSync
  <br>
</h1>

<h4 align="center">A program that allows you to easily sync your Govee lights.</h4>
<p align="center">
    <a href="https://github.com/Minlor/LumiSync/stargazers"><img src="https://img.shields.io/github/stars/Minlor/LumiSync.svg?style=social&label=Star"></a>
    <a href="https://github.com/Minlor/LumiSync/watchers"><img src="https://img.shields.io/github/watchers/Minlor/LumiSync.svg?style=social&label=Watch"></a>
</p>

<p align="center">
  <a href="#key-features">Key Features</a> •
  <a href="#how-to-use">How To Use</a> •
  <a href="#download">Download</a> •
  <a href="#credits">Credits</a> •
  <a href="#related">Related</a> •
  <a href="#license">License</a>
</p>

![screenshot](https://cloud.minlor.net/raw/Minlor/py_FNHoNbJ5c6.png)
> **Note**
> This project is in early development.

## Key Features

* Easy to use - Simple UI that allows you to easily control your lights.
* MonitorSync - Sync your lights to your monitor. (Alpha)
* Easy to use - Simple UI that allows you to easily control your lights.
* MusicSync - Sync your lights to your music. (Alpha)
* CustomSync - Sync your lights to a custom color/animation. (WIP)
* Open Source - LumiSync is open source and free to use.
* Availability - LumiSync is available for Windows and hasn't been tested on Linux or MacOS. (WIP)

## TODO

* [ ] Make a wiki page for the project.
* [ ] Add Multiple MusicSync modes and improve the current one.
* [ ] Add CustomSync feature.
* [ ] Add a GUI.
* [ ] Support for basic brightness control.
* [ ] Support for basic color control.
* [ ] Support for turning lights on/off.

## How To Use

Currently, the only way to use LumiSync is to download the source code and run it yourself. This will be changed in the future.

> **Note**
>
> This requires you to download [python](https://www.python.org/downloads/).
>
> All of the python requirements will be installed automatically when you run the program for the first time.

## Download

You can [download](https://codeload.github.com/Minlor/LumiSync/zip/refs/heads/main) the latest installable version of LumiSync here.

## Credits

Tools used:
* [**Wireshark**](https://wireshark.org/) (Massive thanks to the Wireshark team for making this amazing tool.)

This software uses the following open source packages:

* [dxcam](https://github.com/ra1nty/DXcam)
* [Pillow](https://github.com/python-pillow/Pillow)
* [soundcard](https://github.com/bastibe/SoundCard)
* [colour](https://github.com/colour-science/colour)
* [colorama](https://github.com/tartley/colorama)

## Related

[Govee Desktop](https://www.govee.com/download/desktop) - Official Govee desktop app. (Windows only, supports basic color control and monitor sync.)

## Support

<p>Giving a star to this project is the easiest way to show your support.</p>

![GitHub stars](https://img.shields.io/github/stars/Minlor/LumiSync.svg?style=social&label=Star)

## License

MIT

---

> [minlor.net](https://minlor.net) &nbsp;&middot;&nbsp;
> [cloud.minlor.net](https://cloud.minlor.net) &nbsp;&middot;&nbsp;
> GitHub [@minlor](https://github.com/minlor)
