Lemmy Notify is a desktop application that sits in your system tray and monitors your Lemmy account for new posts and private messages. It acts as a lightweight indicator, allowing you to stay updated without constantly checking your browser.
Note: Currently, this functions primarily as a system tray indicator.
- Cross-Platform Support: Works on Windows, Linux, and macOS.
- System Tray Integration:
- Displays status icons (No updates, New Messages, New Posts).
- Tooltip with quick summary (New Posts/Messages count).
- Context menu for quick actions (Refresh, Settings, Show App, Quit).
- Notifications:
- Detects new private messages.
- Detects new posts in your subscribed communities (checking for unread posts or posts with unread comments).
- Secure: Uses secure storage for saving your password.
- Configurable:
- Set your Lemmy instance URL.
- Adjust polling interval (default: 5 minutes).
- Option to start minimized to the system tray.
- Interactive UI:
- Main window displays clickable links to new posts and your instance.
- Shows delta counts for updates.
| Icon | Meaning |
|---|---|
| No Updates: You are all caught up. | |
| New Messages: You have unread private messages. | |
| New Posts: There are new posts or comments to view. |
Check the Releases page for the latest binaries for your platform.
If you prefer to build the application yourself, follow these steps.
- Flutter SDK: Ensure you have Flutter installed (SDK version >=3.1.5 <4.0.0). Install Flutter.
- Git: To clone the repository.
If you are building on Linux, you will need the following development packages:
sudo apt-get update
sudo apt-get install -y clang cmake ninja-build pkg-config libgtk-3-dev libappindicator3-dev libsecret-1-dev libjsoncpp-dev libnotify-dev-
Clone the repository:
git clone https://github.com/arran4/lemmy_notify.git cd lemmy_notify -
Install dependencies:
flutter pub get
-
Run the app:
# For Windows flutter run -d windows # For Linux flutter run -d linux # For macOS flutter run -d macos
-
Build for release:
flutter build windows flutter build linux flutter build macos
- Launch the application.
- Open Settings (either from the window or the system tray context menu).
- Enter your Lemmy Server URL (e.g.,
https://lemmy.world). - Enter your Username and Password.
- Set the Timer Interval (in minutes) for how often to check for updates.
- Click Save.
The status will update to "Configured" and then "Updated" once it successfully connects and fetches data.
The main application logic is contained within lib/main.dart. It utilizes the lemmy_api_client (v3) for API interaction and tray_manager/window_manager for desktop integration.
This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).