Go to file
renovate[bot] 376ab7c7d8
Update dependency @types/qs to v6.9.12
2024-02-27 21:31:31 +00:00
.github Update frontend package management to use pnpm instead of yarn v1 2024-02-26 12:55:07 +11:00
.vscode Add configurations to debugger for temporary configs and different port 2024-01-20 15:12:15 +11:00
docs Update frontend package management to use pnpm instead of yarn v1 2024-02-26 12:55:07 +11:00
frontend Update dependency @types/qs to v6.9.12 2024-02-27 21:31:31 +00:00
ledfx Merge pull request #805 from bigredfrog/segments3 2024-02-25 16:59:54 -05:00
ledfx_assets reduce blade from 3.4 to 0.4 Meg 2024-02-04 21:26:30 -05:00
ledfx_frontend Fix QLC integration, add Effect Set event type and frontend assets 2024-02-24 08:35:16 +11:00
loopback new portaudio binary built from source 2024-02-23 22:15:14 +11:00
tests Harden tests and test on M1 runners 2024-01-29 18:33:10 +11:00
.flake8 Fix duplicates. 2023-12-27 08:29:57 +01:00
.git-blame-ignore-revs Add Black Update to git-blame-ignore 2023-02-09 12:29:43 +11:00
.gitignore build: refactor sentry init, refactor spec files, wheel workflow, add sha and release to info.py 2024-02-13 07:48:49 +11:00
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate 2024-02-20 01:08:56 +00:00
.readthedocs.yml Build docs if README.rst is modified 2023-07-03 16:54:56 -07:00
AUTHORS.rst Update AUTHORS.rst 2021-01-21 06:43:58 -08:00
CHANGELOG.rst fix: update LedFx configuration and backup functionality to respect custom config dirs. Add Docs 2024-02-14 10:51:25 +11:00
CODE_OF_CONDUCT.md Update to v2.1 2022-07-02 12:23:25 +10:00
LICENSE.txt Update License, Readme and installing 2022-07-02 11:54:32 +10:00
README.rst Update documentation and re-add frontend development setup 2024-02-22 22:53:09 +11:00
SECURITY.md Bump Supported Version 2023-12-28 09:19:50 +11:00
droplet_creator.py Update droplet_creator.py 2021-11-30 12:28:13 +00:00
hiddenimports.py Remove unnecessary imports and show console in CI/dev builds 2024-02-12 17:01:09 +11:00
osx-binary.spec build: refactor sentry init, refactor spec files, wheel workflow, add sha and release to info.py 2024-02-13 07:48:49 +11:00
performance_analyser.py Fix linting issues 2024-01-20 21:50:33 +11:00
poetry.lock Update dependency pytest to v8.0.2 2024-02-25 10:57:46 +00:00
pyproject.toml Release 2.0.94 2024-02-22 22:57:12 +11:00
windows-binary.spec build: refactor sentry init, refactor spec files, wheel workflow, add sha and release to info.py 2024-02-13 07:48:49 +11:00

README.rst

=====================================================
   Welcome to LedFx ✨ *Making music come alive!*
=====================================================
|Build Status| |License| |Build Status Docs| |Discord|
|Contributor Covenant|

.. image:: https://raw.githubusercontent.com/LedFx/LedFx/main/ledfx_assets/banner.png

What is LedFx?
----------------
LedFx makes your LEDs dance to audio!
What LedFx offers is the ability to take audio input, and instantaneously processes the audio into realtime light show to multiple LED strips/matrix.
No need to spend hours on end to program one song to program your LEDs, as LedFx will do this all for you!

LedFx real-time LED strip music visualization effect controller using is a network based devices (ESP8266/ESP32/Raspberry Pi 4) with support for advanced real-time audio effects! LedFx can control multiple devices and works great with cheap ESP8266/ESP32 nodes allowing for cost effective synchronized effects across your entire house!

Demos
-------

Visit `our website`_ to see LedFx in action!

You can also join our `Discord`_ where community members show off their projects. Check out the #projects or #showcase channels.

📑 Quick start guide and documentation📖
------------------------------------------

Head over to `releases`_ to get the latest releases for Windows and Mac. For linux, use pip.

**Bleeding edge (Experimental)**

If you want the absolute bleeding edge and are not afraid of using the terminal, take a look at the detailed installation instructions here: `Installation documentation`_.

**Documentation**

Documentation for the latest release can be found here: `Stable documentation`_

Documentation built against this repository can be found here: `Latest documentation`_


😍 Show me how to make one!
-----------------------------

The below image describes a basic setup - LedFx running on PC, communicating with a WLED Device controlling an LED strip.

.. image:: https://raw.githubusercontent.com/LedFx/LedFx/main/docs/_static/topology.png

.. list-table::
   :widths: 75 75
   :header-rows: 1

   * - Component
     - Example
   * - Computer running LedFx
     - Windows 10, `LedFx.exe`_
   * - Networked device controlling LED Strip
     - ESP8266 NODEMCU v3 running `WLED`_
   * - Addressable LED strip
     - DC5V WS2812B 5 meters 60LED/m IP67
   * - Power supply for LED Strip and ESP
     - 5V 10 amps LED Power Supply
   * - Something to connect the wires together!
     - Soldering iron/solder

#. **Build your networked LED Strip.**
      - For most, this is the difficult step. Don't worry! There's guides here and online, and plenty of people able to help on WLED and LedFx Discord.
      - Follow the `WLED guide to connect the LED strip and ESP together <https://kno.wled.ge/basics/getting-started/>`_.
      - `Flash WLED to the ESP device <https://kno.wled.ge/basics/install-binary/>`_.
      - Ensure all WLED devices are powered on, and connected to your Wi-Fi.
      - Test you can access the WLED web interface from your PC. If so, then you're good to go!

#. **Install LedFx.**
      - For PC and Mac, see our `releases`_, or see the `installation documentation`_ for more information.
      - For linux, you can use pip to install ledfx - however you may need to install some dependencies first. See the `installation documentation`_ for more information.

#. **Direct computer audio output to LedFx.**
      - By default on Windows LedFx will attempt to listen to your system audio.
      - More information for `Linux and macOS users here <https://ledfx.readthedocs.io/en/latest/directing_audio.html>`_.
      - Play some music in the background.

#. **Start LedFx.**
      - Your WLED devices should appear in LedFx, automagically configured and ready to go! 🎆🔥
      - If not, on the bottom click Home,  -> ``Scan for WLED devices`` button, or click on the big plus sign and ``Add Device`` to add them manually.
      - If they're still not showing up, make sure they're powered on and properly connected to your WiFi.

#. **Start using effects!**
      - Click on the device, select an effect eg ``scroll`` under Classic
      - Your lights should now be reacting realtime to your music! Enjoy the show 🌈


🧑‍💻 Join the LedFx Community
------------------------------

Join the Discord server to discuss everything about LedFx!  |Discord|

To join, click on the Discord button below:

.. image:: https://discordapp.com/api/guilds/469985374052286474/widget.png?style=banner2
   :width: 30%
   :target: https://discord.com/invite/xyyHEquZKQ

Contributing
--------------
Pull requests are welcome. Once tested, contact LedFx developer community on Discord to discuss the next step.
We expect and require all contributors to read, understand and follow our code of conduct.

Credits: `Contributors-&-About`_

License
---------
`GPL-3`_


.. _`GPL-3`: https://choosealicense.com/licenses/gpl-3.0/
.. _`LedFx.exe`: https://github.com/LedFx/LedFx/releases/latest
.. _`LedFx Guide`: https://ledfx.readthedocs.io/en/latest/index.html
.. _`WLED`: https://kno.wled.ge
.. _`releases`: https://github.com/LedFx/LedFx/releases/latest
.. _`Installation documentation`: https://ledfx.readthedocs.io/en/latest/installing.html
.. _`Stable documentation`: https://ledfx.readthedocs.io/en/stable/
.. _`Latest documentation`: https://ledfx.readthedocs.io/en/latest/
.. _`our website`: https://ledfx.app
.. _`Discord`: https://discord.gg/xyyHEquZKQ
.. _`Contributors-&-About`: https://ledfx.app/about/
.. _`How to: Enable Stereo Mix in Windows 10`: https://thegeekpage.com/stereo-mix/


.. |Build Status| image:: https://github.com/LedFx/LedFx/actions/workflows/ci-build.yml/badge.svg
   :target: https://github.com/LedFx/LedFx/actions/workflows/ci-build.yml
   :alt: Build Status
.. |Build Status Docs| image:: https://readthedocs.org/projects/ledfx/badge/?version=main
   :target: https://ledfx.readthedocs.io/
   :alt: Documentation Status
.. |License| image:: https://img.shields.io/badge/license-GPL3-blue.svg
   :alt: License
.. |Discord| image:: https://img.shields.io/badge/chat-on%20discord-7289da.svg
   :target: https://discord.gg/xyyHEquZKQ
   :alt: Discord
.. |Contributor Covenant| image:: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg
   :target: CODE_OF_CONDUCT.md