WLED/usermods
srg74 a3a5bffce4
Update readme.md
Fixed typo
2023-12-24 12:10:51 -05:00
..
2022-12-31 15:24:35 -06:00
2021-10-31 11:57:41 +01:00
2023-01-12 20:35:34 +01:00
2020-12-14 20:50:48 -05:00
2023-12-17 22:15:28 +01:00
2022-11-30 09:15:07 +01:00
2023-12-24 12:10:51 -05:00
2023-06-21 23:31:15 +02:00
2023-11-27 22:47:07 -05:00
2023-05-30 19:36:14 +02:00
2023-05-30 19:36:14 +02:00
2023-01-12 20:35:34 +01:00
2023-05-30 19:36:14 +02:00
2022-12-10 16:12:55 +01:00

Usermods

This folder serves as a repository for usermods (custom usermod.cpp files)!

If you have created a usermod you believe is useful (for example to support a particular sensor, display, feature...), feel free to contribute by opening a pull request!

In order for other people to be able to have fun with your usermod, please keep these points in mind:

  • Create a folder in this folder with a descriptive name (for example usermod_ds18b20_temp_sensor_mqtt)
  • Include your custom files
  • If your usermod requires changes to other WLED files, please write a readme.md outlining the steps one needs to take
  • Create a pull request!
  • If your feature is useful for the majority of WLED users, I will consider adding it to the base code!

While I do my best to not break too much, keep in mind that as WLED is updated, usermods might break.
I am not actively maintaining any usermod in this directory, that is your responsibility as the creator of the usermod.

For new usermods, I would recommend trying out the new v2 usermod API, which allows installing multiple usermods at once and new functions! You can take a look at EXAMPLE_v2 for some documentation and at Temperature for a completed v2 usermod!

Thank you for your help :)