Official and community widgets for the Lumy digital signage platform.

🎉 NEW: Local Testing Now Available!
Develop widgets with instant feedback - no backend access required!
40x faster development with our built-in test harness. Learn more →

These widgets are bundled in the Lumy Android app and available to all users:

Internal widgets are:

• ✅ Compiled directly into the Lumy Android app
• ✅ Available to all users without APK download
• ✅ Optimized for performance
• ✅ Open source under MIT license
• ✅ Maintained by Lumy team and community
• ✅ Can also be built as standalone APKs for testing DEX loading or use as examples

Browse our collection of community-created widgets:

More widgets coming soon! Share yours by following our Contributing Guide.

Legend:

• 📥 Pre-built APK available - Download and use immediately (no coding required)
• 🔨 Source only - Requires Android Studio and build tools (for developers)

Want to use widgets without coding? Download pre-built APKs directly:

1. Browse widgets in this organization

2. Download the APK:

   • Go to the widget's repository (e.g., Clock Widget)
   • Click on Releases (right sidebar)
   • Download the latest .apk file

   💡 Note: If no release exists, request a build in the widget's Issues tab.

3. Upload to Lumy Manager:

   • Go to Custom Widgets section
   • Click "Upload Widget"
   • Select the downloaded APK file
   • Fill in widget details and upload

No programming or build tools required! ✨

🎉 NEW: Test widgets locally before uploading! No backend access needed.

1. Start with the template:

   git clone https://github.com/lumy-signage/lumy-widget-template.git my-widget
   cd my-widget

2. Setup Android SDK (automatic):

   # Windows
   .\setup-android-sdk.bat
   
   # Linux/Mac
   ./setup-android-sdk.sh

3. Test locally (recommended):

   • Open project in Android Studio
   • Select test-app from run configurations
   • Click Run ▶️
   • See your widget instantly with live preview!
   • Edit code → Hot reload (Ctrl+F9) → See changes in 15 seconds

   No Lumy installation required! Works completely offline!

4. Build when ready:

   # Windows
   .\build-widget.bat
   
   # Linux/Mac
   chmod +x build-widget.sh
   ./build-widget.sh

5. Create a Release with the built APK:

   • Tag your version (e.g., v1.0.0)
   • Create GitHub Release
   • Upload the APK file
   • This allows non-technical users to download and use your widget! ✨

6. Share your widget:

   • Create a repository (your account or this organization)
   • Open an issue to request it be added to the gallery
   • See Contributing Guide

⚡ Pro tip: Use the test-app for rapid development (40x faster than build-upload-test cycle)

Help non-technical users by building widgets:

1. Clone any widget repository
2. Build: ./gradlew :app:assembleRelease
3. Create a GitHub Release with the APK file
4. Non-technical users can now download without building!

High-quality custom widgets can be promoted to internal widgets (bundled in the app)!

Benefits of promotion:

• Available to all Lumy users
• Better performance (compiled into app)
• Official support and maintenance
• Recognition as official widget
• Open source contribution

How to get promoted:

1. Create a high-quality custom widget
2. Demonstrate usefulness and demand
3. Submit for review (open GitHub issue)
4. Pass quality and security review
5. Agree to open source under MIT license

See the Widget Promotion Guide for details.

• Widget Template - Complete template to start developing
• Widget Development Guide - Complete guide
• Widget Promotion Guide - Promotion process
• Widget Schema Specification - Schema format
• Contributing Guidelines - How to contribute
• CustomWidget Interface - Interface reference
• Lumy Documentation - Platform docs

We welcome contributions! Widget development is now easier than ever with our local test harness.

1. Clone the template → Open in Android Studio → Run test-app
2. See it working instantly (no Lumy backend needed!)
3. Edit code → Hot reload → See changes in 15 seconds
4. Build APK when satisfied
5. Upload to Lumy and share!

Total time from zero to first widget: ~15 minutes ⚡

1. Base your widget on the lumy-widget-template
2. Test locally using the built-in test app (see template README)
3. Follow our contribution guidelines
4. Create a repository (your account or this organization)
5. Submit a pull request to update this README

Each widget maintains its own license. Check individual repositories for license information.

• Lumy Website
• Lumy Documentation
• Report Issues