We have redirected you to our new domain: store.godotengine.org. Please update your bookmarks!

Description
Changelog
Reviews

      

Godot Notification Scheduler Plugin

A unified GDScript interface for scheduling local notifications on Android and iOS.

Features:

  • Schedule local notifications with customizable titles, content, and delays.
  • Schedule repeating notifications with intervals.
  • Manage notification channels and badges.
  • Handle permissions and user interactions via signals.
  • Plugin handles system restart allowing scheduled notifications to survive device reboots

Table of Contents

Demo

Try the demo app located in the demo directory.

Installation

Uninstall previous versions before installing. If using both Android & iOS, ensure same addon interface version.

Options:

  1. AssetLib
    • Search for Notification Scheduler
    • Click Download → Install
    • Install to project root, Ignore asset root checked
    • Enable via Project → Project Settings → Plugins
    • Ignore file conflict warnings when installing both versions
  2. Manual
    • Download release from GitHub
    • Unzip to project root
    • Enable via Plugins tab

Usage

  1. Add a NotificationScheduler node to your scene.
  2. Connect signals:
    • initialization_completed
    • notification_opened
    • notification_dismissed
    • permission_granted
    • permission_denied
  3. Check permission: 
    if not $NotificationScheduler.has_post_notifications_permission():
    $NotificationScheduler.request_post_notifications_permission()
  4. To send user to App Info (manual enable): 
    $NotificationScheduler.open_app_info_settings()
  5. Create a notification channel: 
    var res = $NotificationScheduler.create_notification_channel(
     NotificationChannel.new()
          .set_id("my_channel_id")
          .set_name("My Channel Name")
          .set_description("My channel description")
          .set_importance(NotificationChannel.Importance.DEFAULT))
  6. Build & schedule notification: 
    var data = NotificationData.new()
     .set_id(1)
     .set_channel_id("my_channel_id")
     .set_title("My Title")
     .set_content("My content")
     .set_small_icon_name("ic_custom_icon")
     .set_delay(10)

var res = $NotificationScheduler.schedule(data)

Signals

  • initialization_completed(): Emitted when the plugin is initialized.
  • post_notifications_permission_granted(permission_name: String): Emitted when notification permission is granted to app.
  • post_notifications_permission_denied(permission_name: String): Emitted when notification permission is denied to app.
  • notification_opened(notification_data: NotificationData): Emitted when user taps notification.
  • notification_dismissed(notification_data: NotificationData): Emitted when user dismisses notification.

Android-only Signals

  • battery_optimizations_permission_granted(permission_name: String): Emitted when battery optimization exemption permission is granted to app.
  • battery_optimizations_permission_granted(permission_name: String): Emitted when battery optimization exemption is denied to app.
  • schedule_exact_alarm_permission_granted(permission_name: String): Emitted when permission to schedule exact alarms is granted to app.
  • schedule_exact_alarm_permission_denied(permission_name: String): Emitted when permission to schedule exact alarms is denied to app.

Methods

  • initialize() - initialize plugin
  • create_notification_channel(NotificationChannel) - create a new notification channel with given data
  • schedule(NotificationData) - schedule a new notification with given data
  • cancel(id) – cancel notification with given Id before opened/dismissed
  • get_notification_id() – get ID of last opened notification
  • has_post_notifications_permission() – returns true if app has already been granted permissions to post notifications
  • request_post_notifications_permission() – request permissions to post notifications from user
  • open_app_info_settings() - open the system settings screen for app

Android-only Methods

  • has_battery_optimizations_permission() – returns true if app has already been granted permissions to ignore battery optimizations
  • request_battery_optimizations_permission() – request permissions to ignore battery optimizations from user
  • has_schedule_exact_alarm_permission() – returns true if app has already been granted permission to schedule exact alarms
  • request_schedule_exact_alarm_permission() – request permission to schedule exact alarms rom user

iOS-only Methods

  • set_badge_count(count) – show/hide app icon badge with count (on Android, use NotificationData's set_badge_count() method)

Error Codes

Constant Value Description
ERR_ALREADY_EXISTS 32 Channel ID already exists
ERR_INVALID_DATA 30 Invalid notification/channel data
ERR_UNAVAILABLE 2 Not supported on current platform
ERR_UNCONFIGURED 3 Plugin not initialized
OK 0 Success

Classes

NotificationChannel

  • Encapsulates data that defines the notification channel.
  • Properties: id, name, description, importance, badge_enabled

NotificationData

  • Encapsulates data that defines the notification.
  • Properties: notification_id, channel_id, title, content, small_icon_name, large_icon_name, delay, deeplink, interval, badge_count, custom_data
  • Note: small_icon_name and large_icon_name are only used on Android.

CustomData

  • Encapsulates extra data to be sent and received along with other notification data.
  • Allows setting of any number of bool, int, float, or String properties.

Platform-Specific Notes

Android

  • Default icon: ic_default_notification in res://assets/NotificationSchedulerPlugin
  • Custom icon:
    1. Generate via Android Studio → Image Asset Studio → Notification Icons
    2. Copy generated drawables into res://assets/NotificationSchedulerPlugin
    3. Use set_small_icon_name("icon_name")
  • App Optimization:
    • Check app optimization settings
    • If app settings are set to Optimized or Restricted, notifications may not be delivered when app is not running
  • MIUI:
    • request_post_notifications_permission() may not work reliably on Xiaomi devices to fully exempt an app from MIUI's custom battery management features.
  • App Optimization and Exact Alarm:
    • The plugin will schedule an exact alarm to deliver the notification if the SCHEDULE_EXACT_ALARM permission has been granted, else the plugin will fall back to non-exact scheduling.
    • Obtaining the IGNORE_BATTERY_OPTIMIZATIONS permission will also allow scheduling of exact alarms - additionally requesting SCHEDULE_EXACT_ALARM permission is not necessary.
  • Troubleshooting:
    • Logs: adb logcat | grep 'godot' (Linux), adb.exe logcat | select-string "godot" (Windows)
    • No small icon error: ensure icons exist in assets directory.
    • Battery restrictions: check Settings → Apps → Your App → Battery.

iOS

  • Set notification icons in Project → Export → iOS.
  • System limits:
    • Max repeating notifications: 64
    • Min interval: 60 seconds
  • View XCode logs while running the game for troubleshooting.
  • See Godot iOS Export Troubleshooting.

Video Tutorials

Notification Scheduler Plugin on Android -- _by Code Artist_

Notification Scheduler Plugin on Android

Links

All Plugins

Plugin Android iOS Free Open Source License
Admob ✅ ✅ ✅ ✅ MIT
Notification Scheduler ✅ ✅ ✅ ✅ MIT
Deeplink ✅ ✅ ✅ ✅ MIT
Share ✅ ✅ ✅ ✅ MIT
In-App Review ✅ ✅ ✅ ✅ MIT
Native Camera ✅ ✅ ✅ ✅ MIT
Connection State ✅ ✅ ✅ ✅ MIT
OAuth 2.0 ✅ ✅ ✅ ✅ MIT
QR ✅ ✅ ✅ ✅ MIT

Credits

Contributing

See our guide if you would like to contribute to this project.

Changelog for version v5.2-Multi

No changelog provided for this version.

Reviews (0)

Notification Scheduler Plugin has no reviews yet.

Login to write a review.