t1k:unity:tof:notification-campaigns
| Field | Value |
|---|---|
| Module | tof |
| Version | 3.46.8 |
| Effort | low |
| Tools | — |
Keywords: notification big picture, notification blueprint, notification campaign, notification deep link, notification large icon, notification sound, NotificationAssetValidator, NotificationOpenedService, OnNotificationOpenedSignal, UITemplateNotificationBlueprint
How to invoke
Section titled “How to invoke”/t1k:unity:tof:notification-campaignsTheOne Notification Campaigns
Section titled “TheOne 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) andPackages/are read-only from this repo (reproducible-on-every-machine-unity.md).
Decision Tree
Section titled “Decision Tree”| Intent | Read |
|---|---|
| New campaign / change text or schedule | Step 1 below |
| Add a sound | Step 2 + references/assets-and-formats.md |
| Add large icon or big picture | Step 3 + references/assets-and-formats.md |
| Tap should open a screen | Step 4 + references/tap-routing.md |
| Prove it works | references/verification.md |
Files (verified in this repo)
Section titled “Files (verified in this repo)”| Piece | Path under UnityTheOneFeatureProject/ |
|---|---|
Campaign blueprint (Addressables entry, address = UITemplateNotificationBlueprint) | Assets/Blueprints/UITemplateNotificationBlueprint.csv |
| Sounds | Assets/NotificationSounds/ |
| Images | Assets/StreamingAssets/Notifications/ |
| Tap router | Assets/Scripts/Services/NotificationOpenedService.cs, registered in Assets/Scripts/GameLifetimeScope.cs |
| Asmdef refs it needs | Assets/Scripts/Game.asmdef: TheOne.UI.Common.Deeplink.Core, UITemplate.LiveOps |
Recipe
Section titled “Recipe”- Campaign text/schedule. Edit the CSV. Columns:
CampaignId,DelayDays,TimeToShows,TriggerStrategy,Reminder,NotificationId,Title,Bodythen the optionalSound,LargeIcon,BigPicture,DeepLink. A campaign = one first row (carriesCampaignId, timing and the four optional values) followed by rows with onlyNotificationId,Title,Body. Optional values live on the FIRST row only. Blank cell = default. Copy an existing campaign block as the template. - Sound. Drop the file in
Assets/NotificationSounds/, put its file name WITH extension inSound. Replacing a sound needs a NEW file name (Android channel id derives from the name). - Images. Drop
.png/.jpg/.jpeginAssets/StreamingAssets/Notifications/, put the bare file name (no path) inLargeIcon/BigPicture. iOS shows ONE attachment:BigPicture, elseLargeIcon. - Deep link. Put
<Application.identifier>://<Feature>/<data>inDeepLink. Only a feature with a registeredIDeeplinkHandlerroutes; seereferences/tap-routing.md. - Verify per
references/verification.md. Sound/image need a real device.
Hard rules
Section titled “Hard rules”- The scheme MUST equal
Application.identifier, length <= 2048;NotificationOpenedServicedrops anything else with a warning. The framework has no scheme allow-list, so that check is the consumer’s job. DeeplinkManager.OnDeeplinkActivatedTHROWS 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.jsonand*.slnxchange 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.CoreandUITemplate.LiveOpsinGame.asmdef,NotificationOpenedServicedoes not compile.
Related
Section titled “Related”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).