2025-05-11 16:19:03 +00:00
# Usermods
2019-11-26 20:21:54 +00:00
2020-04-09 13:06:44 +00:00
This folder serves as a repository for usermods (custom `usermod.cpp` files)!
2019-11-26 20:21:54 +00:00
2022-12-10 15:12:55 +00:00
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!
2019-11-26 20:21:54 +00:00
In order for other people to be able to have fun with your usermod, please keep these points in mind:
2025-05-11 16:19:03 +00:00
* 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!
2019-11-26 20:21:54 +00:00
2022-12-10 15:12:55 +00:00
While I do my best to not break too much, keep in mind that as WLED is updated, usermods might break.
2019-11-26 20:21:54 +00:00
I am not actively maintaining any usermod in this directory, that is your responsibility as the creator of the usermod.
2020-05-28 00:20:02 +00:00
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!
2020-02-19 18:24:56 +00:00
Thank you for your help :)
