{"id":16584617,"url":"https://github.com/volorf/vr-notifications","last_synced_at":"2025-09-02T13:13:59.081Z","repository":{"id":115040448,"uuid":"537870967","full_name":"Volorf/VR-Notifications","owner":"Volorf","description":"Simple Notification System for VR.","archived":false,"fork":false,"pushed_at":"2024-08-09T19:48:19.000Z","size":2828,"stargazers_count":16,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-03T21:11:12.211Z","etag":null,"topics":["alert","csharp","message","notification","package","popup","prototypes","prototyping","snackbar","unity","unity-3d","unity3d","virtual-reality","vr","xr"],"latest_commit_sha":null,"homepage":"","language":"C#","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/Volorf.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}},"created_at":"2022-09-17T16:46:29.000Z","updated_at":"2025-03-29T23:15:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"d0da13e3-25c7-4fe8-a772-4a8431c76bb6","html_url":"https://github.com/Volorf/VR-Notifications","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Volorf/VR-Notifications","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Volorf%2FVR-Notifications","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Volorf%2FVR-Notifications/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Volorf%2FVR-Notifications/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Volorf%2FVR-Notifications/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Volorf","download_url":"https://codeload.github.com/Volorf/VR-Notifications/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Volorf%2FVR-Notifications/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273288254,"owners_count":25078691,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-02T02:00:09.530Z","response_time":77,"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":["alert","csharp","message","notification","package","popup","prototypes","prototyping","snackbar","unity","unity-3d","unity3d","virtual-reality","vr","xr"],"created_at":"2024-10-11T22:45:04.012Z","updated_at":"2025-09-02T13:13:59.055Z","avatar_url":"https://github.com/Volorf.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VR Notifications\n\nIt's a simple, easy-to-use Notification System for your wonderful VR project.\n\nInitially, I developed this package for [VR Boxel Editor](https://twitter.com/Volorf/status/1305406161710125056).\n\n\n\n# How to install the package\nEasy-peasy:\n\n1. Copy Git URL\n2. Open `Window/Package Manager`\n3. Add VR Notifications package via `Add package from git URL`\n\n\u003cimg src=\"Images/install-via-git-url.gif\" width=\"800\"\u003e\n\n\n\n# How to add it to your project\n\nSuper simple. Find the `Notification Manager` prefab and drop it into your scene.\n\n\u003cimg src=\"Images/add-to-scene.gif\" width=\"800\"\u003e\n\n\n\n# How to send a notification\n\nI love binding `SendMessage` to UnityEvents to make it decoupled as much as possible.\n\n```csharp\nusing System;\nusing UnityEngine.Events;\n\n// Create a custom Unity Event\n[Serializable]\npublic class NotificationEvent: UnityEvent\u003cstring\u003e {}\n```\n\n```csharp\nusing UnityEngine;\n\npublic class MyScript : MonoBehaviour\n{\n    [SerializeField] private string MyMessage = \"Space has been pressed.\";\n    // Expose the custom Unity Event in the Editor\n    [SerializeField] private NotificationEvent MyEvent;\n\n    private void Update()\n    {\n        if (Input.GetKeyDown(KeyCode.Space))\n        {\n            MyEvent.Invoke(MyMessage);\n        }\n    }\n}\n```\n\n\u003cimg src=\"Images/bind-to-event.gif\" width=\"800\"\u003e\n\nAlso, since `Notification Manager` is `Singleton`, you can call its methods without having a direct reference to the object. Very straightforward:\n\n```csharp\nprivate void Update()\n{\n    if (Input.GetKeyDown(KeyCode.Space))\n    {\n        NotificationManager.Instance.SendMessage(\"Space has been pressed.\");\n    }\n} \n```\n\n\n\n# How to set up\n\nAll properties are in a Scriptable Object Asset called \"Notification Settings\". \n\n\u003cimg src=\"Images/notification-settings.png\" width=\"800\"\u003e\n\nIt is very useful to have multiple data assets when you tweak values a lot during the design iterations. You don't need to recompile the script each time you make changes.\n\nTo create `Notification Settings`, go to `Create` / `Create Notification Settings`. Then drop the asset to the `Notification Manager`.\n\n\u003cimg src=\"Images/notification-settings.gif\" width=\"800\"\u003e\n\n# Contacts\n[Twitter](https://www.twitter.com/volorf) | [Linkedin](https://www.linkedin.com/in/oleg-frolov-6a6a4752/) | [Dribbble](https://dribbble.com/Volorf) | [Personal Site](https://olegfrolov.design/)\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvolorf%2Fvr-notifications","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvolorf%2Fvr-notifications","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvolorf%2Fvr-notifications/lists"}