|
| 1 | +# Countdown Timer for Tidbyt |
| 2 | + |
| 3 | +A beautiful, customizable countdown timer app for Tidbyt that displays the time remaining until your important events with an animated dot grid visualization. |
| 4 | + |
| 5 | +## Features |
| 6 | + |
| 7 | +### Visual Elements |
| 8 | +- **Dynamic countdown display** - Shows days, hours, minutes, and seconds remaining |
| 9 | +- **Animated dot grid** - Visual representation of time remaining with smooth filling/unfilling animation |
| 10 | +- **Flexible layout** - Toggle any element on/off, with remaining items automatically resizing to fill the display |
| 11 | +- **Smart font sizing** - Automatically adjusts text size based on visible elements for optimal readability |
| 12 | + |
| 13 | +### Customization Options |
| 14 | +- **Title** - Name your countdown (e.g., "Vacation", "Project Launch", "Birthday") |
| 15 | +- **Deadline** - Set any future date and time |
| 16 | +- **Dot Granularity** - Choose what each dot represents: |
| 17 | + - Days - Best for long-term countdowns |
| 18 | + - Weeks - Great for month-long events |
| 19 | + - Hours - Perfect for short-term deadlines |
| 20 | + - Minutes - Ideal for very short countdowns |
| 21 | +- **Color Customization**: |
| 22 | + - Title color |
| 23 | + - Countdown time color |
| 24 | + - Dot animation color |
| 25 | + - Target date color |
| 26 | +- **Visibility Toggles** - Show/hide any element: |
| 27 | + - Title row |
| 28 | + - Countdown time |
| 29 | + - Animated dots |
| 30 | + - Target date |
| 31 | + |
| 32 | +## Display Formats |
| 33 | + |
| 34 | +The countdown intelligently formats the time display: |
| 35 | +- **7+ days**: Shows as "7d 23:59:59" |
| 36 | +- **Less than 7 days**: Shows as "23:59:59" |
| 37 | +- **Time's up**: Displays "TIME'S UP!" with red background |
| 38 | + |
| 39 | +## Animation |
| 40 | + |
| 41 | +The dot grid features a smooth filling animation: |
| 42 | +1. Dots progressively light up from left to right |
| 43 | +2. Once all dots are lit, they dim from right to left |
| 44 | +3. The cycle repeats continuously |
| 45 | +4. Dot color matches your selected preference |
| 46 | + |
| 47 | +## Smart Layout |
| 48 | + |
| 49 | +When you toggle elements on/off, the app automatically: |
| 50 | +- Resizes fonts to maximize readability |
| 51 | +- Centers all content horizontally |
| 52 | +- Ensures text never exceeds the display width |
| 53 | +- Prioritizes the countdown time with larger fonts when space allows |
| 54 | + |
| 55 | +## Installation |
| 56 | + |
| 57 | +### For Personal Use |
| 58 | + |
| 59 | +1. Clone this repository or download `countdowntimer.star` |
| 60 | +2. Use the Tidbyt mobile app: |
| 61 | + - Open the app and select your device |
| 62 | + - Tap the "+" button |
| 63 | + - Choose "Upload" or "Developer" |
| 64 | + - Select the `countdowntimer.star` file |
| 65 | + - Configure your countdown settings |
| 66 | + |
| 67 | +### For Community Submission |
| 68 | + |
| 69 | +To share this app with the Tidbyt community: |
| 70 | + |
| 71 | +1. Fork the [Tidbyt Community repository](https://github.com/tidbyt/community) |
| 72 | +2. Add this app to the `apps/` directory |
| 73 | +3. Include all necessary files: |
| 74 | + - `countdowntimer.star` - The main app code |
| 75 | + - `countdowntimer.webp` - A preview image |
| 76 | + - This README.md |
| 77 | +4. Submit a pull request |
| 78 | + |
| 79 | +## Configuration Examples |
| 80 | + |
| 81 | +### Vacation Countdown |
| 82 | +- Title: "Hawaii Trip" |
| 83 | +- Dot Granularity: Days |
| 84 | +- Colors: Blue title, Yellow time, Cyan dots |
| 85 | + |
| 86 | +### Project Deadline |
| 87 | +- Title: "Launch Day" |
| 88 | +- Show Date: Off (for cleaner look) |
| 89 | +- Dot Granularity: Hours |
| 90 | +- Colors: Red theme for urgency |
| 91 | + |
| 92 | +### Minimal Clock |
| 93 | +- Show Title: Off |
| 94 | +- Show Dots: Off |
| 95 | +- Show Date: Off |
| 96 | +- Result: Large countdown display only |
| 97 | + |
| 98 | +## Development |
| 99 | + |
| 100 | +Built with Pixlet using the Starlark language. Key features implemented: |
| 101 | +- Responsive layout system |
| 102 | +- Color-aware dimming for animations |
| 103 | +- Automatic font sizing based on content |
| 104 | +- Efficient frame generation for smooth animations |
| 105 | + |
| 106 | +## Credits |
| 107 | + |
| 108 | +Created with ❤️ for the Tidbyt community. Feel free to fork, modify, and share! |
| 109 | + |
| 110 | +## License |
| 111 | + |
| 112 | +MIT License - See LICENSE file for details |
0 commit comments