{"id":23807029,"url":"https://github.com/shinniuwu/nocoffeinereminder","last_synced_at":"2026-04-18T15:36:16.409Z","repository":{"id":269958332,"uuid":"908964536","full_name":"ShinniUwU/NoCoffeineReminder","owner":"ShinniUwU","description":"A Node.js coffee-limit reminder. Schedules daily alerts with cron \u0026 FFplay","archived":false,"fork":false,"pushed_at":"2025-01-04T10:31:54.000Z","size":1690,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-13T20:40:01.690Z","etag":null,"topics":["caffeine","coffee","cron","daily-reminder","ffmpeg","keyboard-listener","nodejs","productivity","reminder","time-management","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ShinniUwU.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-12-27T12:06:15.000Z","updated_at":"2025-01-04T10:31:57.000Z","dependencies_parsed_at":"2024-12-27T13:19:50.039Z","dependency_job_id":"6620040a-bd44-4692-9cc7-d37827760c31","html_url":"https://github.com/ShinniUwU/NoCoffeineReminder","commit_stats":null,"previous_names":["shinniuwu/nocoffeinereminder"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ShinniUwU/NoCoffeineReminder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShinniUwU%2FNoCoffeineReminder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShinniUwU%2FNoCoffeineReminder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShinniUwU%2FNoCoffeineReminder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShinniUwU%2FNoCoffeineReminder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ShinniUwU","download_url":"https://codeload.github.com/ShinniUwU/NoCoffeineReminder/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShinniUwU%2FNoCoffeineReminder/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31974848,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["caffeine","coffee","cron","daily-reminder","ffmpeg","keyboard-listener","nodejs","productivity","reminder","time-management","typescript"],"created_at":"2025-01-01T23:18:21.851Z","updated_at":"2026-04-18T15:36:16.360Z","avatar_url":"https://github.com/ShinniUwU.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NoCoffeeInReminder\n\n![No coffee sign](./assets/nocoffee.png)\n\nNoCoffeeInReminder is a simple reminder tool designed to help you remember when to stop drinking coffee. It allows you to set a time for a daily reminder, at which point it will play a sound using `ffplay`. You can stop the sound at any time by pressing a global hotkey (`Alt + F` by default).\n\n## Features\n\n- **Reminder Scheduling**: Set a daily reminder time for your caffeine break.  \n- **Sound Notification**: Play a sound to remind you to take a break, using `ffplay`.  \n- **Global Keyboard Listener**: Stop the sound at any time with a custom keybind (default is `Alt + F`).  \n- **Customizable Time**: Use a human-readable time (e.g., \"8:00 PM\") to set the reminder.  \n- **Persistent Settings**: Save the reminder time and cron expression in a JSON file (`settings.json`) for future use.  \n- **Checks FFplay on Startup**: Ensures `ffplay` is available; prints a helpful error and exits if not found.\n\n## Requirements\n\n- **Node.js** (v16 or higher recommended)  \n- **ffplay** (part of `ffmpeg`, ensure it’s installed and available in your system’s PATH)  \n- **node-global-key-listener** (installed automatically via `npm install`)\n\n## Installation\n\n1. **Clone** or **download** this repository.  \n2. **Install dependencies**:\n   ```bash\n   npm install\n   ```\n3. **Ensure `ffplay` is installed** and on your system PATH. For instance:\n   - **macOS**:\n     ```bash\n     brew install ffmpeg\n     ```\n   - **Ubuntu**:\n     ```bash\n     sudo apt install ffmpeg\n     ```\n   - **Windows**: Follow the [FFmpeg installation guide](https://ffmpeg.org/download.html).\n\n4. **Build/Compile** (if using TypeScript):\n   ```bash\n   npm run build\n   ```\n   Or run directly with a TS executor (e.g., `ts-node` or `tsx`):\n   ```bash\n   npx tsx src/index.ts\n   ```\n\n## Usage\n\nWhen the program starts, you’ll see a menu:\n\n1. **Settings**: Set or update the time (e.g., \"8:00 PM\") for your daily reminder.  \n2. **Exit**: Terminate the application.\n\nOnce set, the reminder will **play a sound** at the specified time every day. You can **stop the sound** at any time by pressing `Alt + F` (or your configured keybind).\n\n### Example Workflow\n\n1. **Start the program**:\n   ```bash\n   npx tsx src/index.ts\n   ```\n2. **Set a reminder** time when prompted (e.g., `\"8:00 PM\"`).\n3. **Wait** until the specified time.  \n4. **Sound plays** via `ffplay` at the set time.  \n5. **Press `Alt + F`** (system-wide) to stop the sound if desired.\n\n### Changing the Reminder\n\n- At any time, choose **Settings** from the menu to update your reminder time or keybind.  \n- The time is stored in `settings.json`, along with the generated cron expression.\n\n## File Structure\n\n- **`src/`**: Contains the TypeScript source code (entry point: `index.ts`).  \n- **`assets/`**: Contains the `nocoffee.png` used in this README.  \n- **`settings.json`**: Holds the user-defined reminder time, cron expression, and stop key combination.  \n- **`sound/`**: Should contain the `sound.mp3` (or other audio file) played when the reminder triggers.  \n\n## Troubleshooting\n\n- **FFplay not found**: If the script exits immediately and warns about `ffplay`, make sure you have **FFmpeg** installed and that `ffplay` is accessible on your system PATH.  \n- **Keybind issues**: On some systems, “Alt” may be recognized as “Option,” or conflicts might occur with other apps. Try a different combo (e.g., `Ctrl+Q`).  \n- **Permissions**: Ensure you can write to the project folder so that `settings.json` can be created/updated.\n\n## Contributing\n\n1. **Fork** the repository.  \n2. **Create a feature branch** (`git checkout -b feature/foo`).  \n3. **Commit your changes** (`git commit -m 'Add some feature'`).  \n4. **Push** to your fork (`git push origin feature/foo`).  \n5. **Create a Pull Request**.\n\nAll contributions are welcome—bug reports, improvements, or new features.\n\n## License\n\nThis project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinniuwu%2Fnocoffeinereminder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshinniuwu%2Fnocoffeinereminder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinniuwu%2Fnocoffeinereminder/lists"}