Contribute
PropMesh is free, open source, and built for the home haunt and holiday display community. You don’t need to write code to help.
Ways to help
Section titled “Ways to help”- Report what happened. Bugs, confusing screens, something this site got wrong: open an issue. Photos and screenshots make a report much easier to act on.
- Show your props. How you wired a jaw, which flood lights paired, what your schedule looks like. That is exactly what the next person needs to see.
- Improve these docs. Every page has an Edit page link at the bottom. Fix a typo or add a tip right on GitHub.
- Request a board. Ask for one on GitHub. The requests decide which boards come next.
- Add a board. A board works with PropMesh once it has a profile: a short file listing what each pin can do. Copy one from
boards/, fill it in from the seller’s pinout, and send it in. The board’s page on this site is generated from that file. - Write code. The firmware (ESP32, PlatformIO) and the console (React, TypeScript) live in the same repository.
How changes come in
Section titled “How changes come in”Changes go to GitHub as pull requests into the dev branch. Read CONTRIBUTING.md first. It is short, and it explains the sign-off line each commit needs.
Licenses
Section titled “Licenses”PropMesh is copyleft open source. Use it, change it, and sell things you build with it. If you share a changed version, share its source too.
| Part | License |
|---|---|
| Firmware and tools | GPL-3.0 |
| Console | AGPL-3.0 |
| Board designs | CERN-OHL-S-2.0 |
| These docs | CC BY-SA 4.0 |
The details and the reasoning are in LICENSING.md. The PropMesh name is covered separately in TRADEMARK.md.