Skip to content

t1k:unity:tof:notification-campaigns

FieldValue
Moduletof
Version3.46.8
Effortlow
Tools—

Keywords: notification big picture, notification blueprint, notification campaign, notification deep link, notification large icon, notification sound, NotificationAssetValidator, NotificationOpenedService, OnNotificationOpenedSignal, UITemplateNotificationBlueprint

/t1k:unity:tof:notification-campaigns

Add or change a local notification campaign: text, schedule, sound, large icon, big picture, and the deep link a tap opens. Framework contract is the UITemplate README (Assets/UITemplate/Sources/Scripts/Modules/LiveOps/Notification/README.md); this skill is the consumer-side recipe. Read the README for anything not stated here.

Scope: indexes this project’s wiring only. A capability missing here is not proof it is absent: grep source (state the scope) before concluding. Submodule (Assets/UITemplate) and Packages/ are read-only from this repo (reproducible-on-every-machine-unity.md).

IntentRead
New campaign / change text or scheduleStep 1 below
Add a soundStep 2 + references/assets-and-formats.md
Add large icon or big pictureStep 3 + references/assets-and-formats.md
Tap should open a screenStep 4 + references/tap-routing.md
Prove it worksreferences/verification.md
PiecePath under UnityTheOneFeatureProject/
Campaign blueprint (Addressables entry, address = UITemplateNotificationBlueprint)Assets/Blueprints/UITemplateNotificationBlueprint.csv
SoundsAssets/NotificationSounds/
ImagesAssets/StreamingAssets/Notifications/
Tap routerAssets/Scripts/Services/NotificationOpenedService.cs, registered in Assets/Scripts/GameLifetimeScope.cs
Asmdef refs it needsAssets/Scripts/Game.asmdef: TheOne.UI.Common.Deeplink.Core, UITemplate.LiveOps
  1. Campaign text/schedule. Edit the CSV. Columns: CampaignId,DelayDays,TimeToShows,TriggerStrategy,Reminder,NotificationId,Title,Body then the optional Sound,LargeIcon,BigPicture,DeepLink. A campaign = one first row (carries CampaignId, timing and the four optional values) followed by rows with only NotificationId,Title,Body. Optional values live on the FIRST row only. Blank cell = default. Copy an existing campaign block as the template.
  2. Sound. Drop the file in Assets/NotificationSounds/, put its file name WITH extension in Sound. Replacing a sound needs a NEW file name (Android channel id derives from the name).
  3. Images. Drop .png/.jpg/.jpeg in Assets/StreamingAssets/Notifications/, put the bare file name (no path) in LargeIcon / BigPicture. iOS shows ONE attachment: BigPicture, else LargeIcon.
  4. Deep link. Put <Application.identifier>://<Feature>/<data> in DeepLink. Only a feature with a registered IDeeplinkHandler routes; see references/tap-routing.md.
  5. Verify per references/verification.md. Sound/image need a real device.
  • The scheme MUST equal Application.identifier, length <= 2048; NotificationOpenedService drops anything else with a warning. The framework has no scheme allow-list, so that check is the consumer’s job.
  • DeeplinkManager.OnDeeplinkActivated THROWS for an unregistered feature, so the hand-off stays wrapped in try/catch. Never call it unwrapped with notification-sourced strings.
  • Every valid file in Assets/NotificationSounds/ ships, referenced or not; an invalid file name in the folder is a validator error. Delete sounds you do not want shipped.
  • Never “Reimport All”, never kill or restart the Editor, run headless (unity-headless-by-default.md, unity-forbidden-operations.md).
  • Do not commit Unity side effects: Packages/packages-lock.json and *.slnx change on a Unity run and are not part of the campaign change; stage only the files you meant to touch.
  • Asmdef refs are required: without TheOne.UI.Common.Deeplink.Core and UITemplate.LiveOps in Game.asmdef, NotificationOpenedService does not compile.

t1k-unity-tof-notification (permission prompts, smart-prompt; owns the generic notification keywords) · t1k-unity-tof-addressables (blueprint/audio groups) · t1k-unity-tof-registration (DI triplet) · UITemplate notification README (Sound, Images and Deep Links section).