{"id":13442460,"url":"https://github.com/Windos/BurntToast","last_synced_at":"2025-03-20T14:30:33.528Z","repository":{"id":35126562,"uuid":"39326380","full_name":"Windos/BurntToast","owner":"Windos","description":"Module for creating and displaying Toast Notifications on Microsoft Windows 10.","archived":false,"fork":false,"pushed_at":"2024-09-03T21:29:05.000Z","size":33379,"stargazers_count":1483,"open_issues_count":26,"forks_count":129,"subscribers_count":42,"default_branch":"main","last_synced_at":"2025-03-13T21:09:49.199Z","etag":null,"topics":["hacktoberfest","notifications","powershell","toast","windows","windows-10"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","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/Windos.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"Windos","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2015-07-19T07:43:43.000Z","updated_at":"2025-03-12T18:13:49.000Z","dependencies_parsed_at":"2024-01-12T07:18:17.670Z","dependency_job_id":"fecf827c-951b-4b6a-95d6-33e151d951f1","html_url":"https://github.com/Windos/BurntToast","commit_stats":{"total_commits":371,"total_committers":27,"mean_commits":13.74074074074074,"dds":"0.14016172506738545","last_synced_commit":"5be44e3395bf0b5607fe8a6c9b877f47375b6f40"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Windos%2FBurntToast","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Windos%2FBurntToast/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Windos%2FBurntToast/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Windos%2FBurntToast/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Windos","download_url":"https://codeload.github.com/Windos/BurntToast/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244629973,"owners_count":20484288,"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","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":["hacktoberfest","notifications","powershell","toast","windows","windows-10"],"created_at":"2024-07-31T03:01:45.988Z","updated_at":"2025-03-20T14:30:33.523Z","avatar_url":"https://github.com/Windos.png","language":"PowerShell","readme":"# BurntToast\n\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/5c96b736ff1b45d98666160ab37dcad5)](https://www.codacy.com/manual/Windos/BurntToast?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=Windos/BurntToast\u0026amp;utm_campaign=Badge_Grade)\n[![codecov](https://codecov.io/gh/Windos/BurntToast/branch/main/graph/badge.svg)](https://codecov.io/gh/Windos/BurntToast)\n[![Build Status](https://dev.azure.com/windosnz/BurntToast/_apis/build/status/Windos.BurntToast-Build?branchName=main)](https://dev.azure.com/windosnz/BurntToast/_build/latest?definitionId=2\u0026branchName=main)\n[![PowerShell Gallery Version](https://img.shields.io/powershellgallery/v/BurntToast.svg)](https://www.powershellgallery.com/packages/BurntToast)\n[![PowerShell Gallery Downloads](https://img.shields.io/powershellgallery/dt/BurntToast.svg)](https://www.powershellgallery.com/packages/BurntToast)\n[![Open Issues](https://img.shields.io/github/issues-raw/Windos/BurntToast.svg)](https://github.com/Windos/BurntToast/issues)\n\n![BurntToast Logo Banner](/Media/BurntToast-Wide.png)\n\nPowerShell Module for displaying **Windows 10** and **Windows Server 2019** Toast Notifications\n\n## Install\n\n### PowerShell Gallery Install (Requires PowerShell v5)\n\n```powershell\nInstall-Module -Name BurntToast\n```\n\nSee the [PowerShell Gallery](http://www.powershellgallery.com/packages/BurntToast/) for the complete details and instructions.\nDon't forget to set the correct [Execution Policy](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-7.1).\n\n### Manual Install\n\nDownload [BurntToast.zip](https://github.com/Windos/BurntToast/releases/latest/download/BurntToast.zip) from [Releases page](https://github.com/Windos/BurntToast/releases/latest) and extract the contents into `$env:userprofile\\Documents\\WindowsPowerShell\\modules\\BurntToast` (you may have to create these directories if they don't exist.)\n\nIf you are using PowerShell 6 or later, extract into `$env:userprofile\\Documents\\PowerShell\\Modules\\BurntToast`\n\n*Please remember to \"**unblock**\" the zip file before extracting the contents. Not doing so will result in the module not working correctly. This can be done via the file properties or with `Unblock-File`.*\n\n## Examples\n\n### [Default Toast](/Examples/Example01/)\n\n```powershell\nNew-BurntToastNotification\n```\n\n![BurntToast Notification Example Default](/Examples/Example01/Example1-Default.png)\n\n### [Customized Toast](/Examples/Example02/)\n\n```powershell\nNew-BurntToastNotification -AppLogo C:\\smile.jpg -Text \"Don't forget to smile!\",\n                                                       'Your script ran successfully, celebrate!'\n```\n\n![BurntToast Notification Example Custom](/Examples/Example02/Example2-Custom.png)\n\n### [Alarm Clock](/Examples/Example03/)\n\n```powershell\nNew-BurntToastNotification -Text 'WAKE UP!' -Sound 'Alarm2' -SnoozeAndDismiss\n```\n\n![BurntToast Notification Example Alarm](/Examples/Example03/Example3-Alarm.png)\n\n## Releases\n\n**Please note:** as of v0.5.0, BurntToast no longer works on Windows 8.\n\n- [0.8.5](https://github.com/Windos/BurntToast/releases/download/v0.8.5/BurntToast.zip)\n\n  - Actually implement the ability to use a UniqueIdentifier with the Remove-BTNotification function (which was half implemented in 0.8.4)\n\n- [0.8.4](https://github.com/Windos/BurntToast/releases/download/v0.8.4/BurntToast.zip)\n\n  - Enhancement: Header ID on New-BTHeader is now optional. An ID will be auto generated if not specified ([#125](https://github.com/Windos/BurntToast/issues/125))\n\n    - Thanks [@glennsarti](https://github.com/glennsarti)\n\n  - Enhancement: Hero images can now be specified using the New-BurntToastNotification function using the -HeroImage parameter ([#80](https://github.com/Windos/BurntToast/issues/80))\n\n    - Thanks [@UniverseCitiz3n](https://github.com/UniverseCitiz3n)\n\n  - Enhancement: AppIDs can now be specified using the New-BurntToastNotification function using the -AppId parameter.\n\n    - Thanks [@cedarbaum](https://github.com/cedarbaum)\n\n  - Enhancement: You can now specify a UniqueIdentifier when using the Remove-BTNotification function rather than component Tag and Group strings.\n\n  - Fix: Weird edge cases when taking text from Twitch/IRC and using them in a toast is now sorted.\n\n    - Thanks [@potatoqualitee](https://github.com/potatoqualitee) and [@vexx32](https://github.com/vexx32)\n\n- [0.8.3](https://github.com/Windos/BurntToast/releases/download/v0.8.3/BurntToast.zip)\n\n  - Fix: Error when running Update-BTNotification on PowerShell 6.0+ ([#120](https://github.com/Windos/BurntToast/issues/120))\n\n  - Fix: Error when using actionable toast parameters on any version ([#122](https://github.com/Windos/BurntToast/issues/122))\n\n  - Fix: Multiple warnings about events not being supported when specifying multiple event types.\n\n- [v0.8.2](https://github.com/Windos/BurntToast/releases/download/v0.8.2/BurntToast.zip)\n\n  - Add: AdaptiveGroups are now usable via New-BTColumn\n\n- [v0.8.1](https://github.com/Windos/BurntToast/releases/download/v0.8.1/BurntToast.zip)\n\n  - Fix: Toast alias removed in 0.8.0 has been restored\n\n  - Deprecation: Signalling removal of Shoulder Tap cmdlets in future version, v0.9.0\n\n  - Deprecation: Signalling removal of Path parameter from New-BTAudio in future version, v0.9.0.\n\n    - See [MicrosoftDocs/windows-uwp Issue #1593](https://github.com/MicrosoftDocs/windows-uwp/issues/1593)\n\n- [v0.8.0](https://github.com/Windos/BurntToast/releases/download/v0.8.0/BurntToast.zip)\n\n  - Fix: Images from UNC path failing ([#111](https://github.com/Windos/BurntToast/issues/111))\n\n  - Add: Ability to force a refresh of cached images via IgnoreCache switch on New-BTImage\n\n  - Add: ACTIONABLE NOTIFICATIONS! Exposed via ActivatedAction and DismissedAction parameters on Submit-BTNotification and New-BurntToastNotification\n\n- [v0.7.2](https://github.com/Windos/BurntToast/releases/download/v0.7.2/BurntToast.zip)\n\n  - Fix: Curly Braces when \"Reminder\" pops up ([#72](https://github.com/Windos/BurntToast/issues/72))\n\n  - Fix: Caching remote gifs are saved based on their remote filename and not overwritten ([#105](https://github.com/Windos/BurntToast/issues/105))\n\n    - Thanks [@KelvinTegelaar](https://github.com/KelvinTegelaar)\n\n  - Fix: BurntToast and .NET 5 ([#101](https://github.com/Windos/BurntToast/issues/101))\n\n- see more in the [Full Change Log](CHANGES.md)\n\n## Contributors\n\n- [Windos](https://github.com/Windos)\n- [jeremytbrun](https://github.com/jeremytbrun)\n- [KelvinTegelaar](https://github.com/KelvinTegelaar)\n- [steviecoaster](https://github.com/steviecoaster)\n- [glennsarti](https://github.com/glennsarti)\n- [UniverseCitiz3n](https://github.com/UniverseCitiz3n)\n- [cedarbaum](https://github.com/cedarbaum)\n\n## License\n\n- See [LICENSE](LICENSE) file\n\n## Image Credit\n\nThe [default image](/Media/BurntToast.png) for BurntToast Notifications is a photo taken by [Craig Sunter](https://www.flickr.com/photos/16210667@N02/17230428864)\n\n## Contact\n\n- Twitter: [@WindosNZ](https://twitter.com/windosnz)\n- Blog: [ToastIT.dev](https://toastit.dev/)\n","funding_links":["https://github.com/sponsors/Windos"],"categories":["PowerShell","📚 UI","UI"],"sub_categories":["REST"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWindos%2FBurntToast","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FWindos%2FBurntToast","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWindos%2FBurntToast/lists"}