Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kde/snoretoast
Command-line application capable of creating Windows Toast notifications
https://github.com/kde/snoretoast
Last synced: 3 days ago
JSON representation
Command-line application capable of creating Windows Toast notifications
- Host: GitHub
- URL: https://github.com/kde/snoretoast
- Owner: KDE
- License: lgpl-3.0
- Created: 2013-07-03T13:16:03.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T12:27:05.000Z (almost 2 years ago)
- Last Synced: 2024-06-21T06:40:21.312Z (5 months ago)
- Language: C++
- Homepage: https://invent.kde.org/libraries/snoretoast
- Size: 456 KB
- Stars: 302
- Watchers: 8
- Forks: 33
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: COPYING.LGPL-3
Awesome Lists containing this project
README
[](https://binary-factory.kde.org/job/SnoreToast_Nightly_win64)
Snoretoast
==========
A command line application capable of creating Windows Toast notifications on Windows 8 or later.
If SnoreToast is used without the parameter --appID an default appID is used and a shortcut to SnoreToast.exe is created in the startmenu, notifications created that way will be asigned to SnoreToast.
If you want to brand your notifications you need to create the application startmenu entry with `snoretoast.exe --install "MyApp\MyApp.lnk" "C:\myApp.exe" "My.APP_ID"`.
This appID then needs to be passed to snoretoast.exe with the `--appID`` parameter.
# Releases and Binaries
[Get releases and binaries](https://download.kde.org/stable/snoretoast/)
[Get the latest nightly](https://binary-factory.kde.org/job/SnoreToast_Nightly_win64)
# Contact us
- [Report Bugs](https://bugs.kde.org/enter_bug.cgi?product=Snoretoast)
- [Find us on Irc](https://web.libera.chat/?channels=#kde-windows)
- [Send us a mail](mailto:[email protected])
----------------------------------------------------------
```
Welcome to SnoreToast 0.7.0.
A command line application capable of creating Windows Toast notifications.
---- Usage ----
SnoreToast [Options]
---- Options ----
[-t] | Displayed on the first line of the toast.
[-m] | Displayed on the remaining lines, wrapped.
[-b] | Displayed on the bottom line, can list multiple buttons separated by ";"
[-tb] | Displayed a textbox on the bottom line, only if buttons are not presented.
[-p] | Display toast with an image, local files only.
[-id] | sets the id for a notification to be able to close it later.
[-s] | Sets the sound of the notifications, for possible values see http://msdn.microsoft.com/en-us/library/windows/apps/hh761492.aspx.
[-silent] | Don't play a sound file when showing the notifications.
[-d] (short | long) | Set the duration default is "short" 7s, "long" is 25s.
[-appID] | Don't create a shortcut but use the provided app id.
[-pid] | Query the appid for the process , use -appID as fallback. (Only relevant for applications that might be packaged for the store)
[-pipeName] <\.\pipe\pipeName\> | Provide a name pipe which is used for callbacks.
[-application] | Provide a application that might be started if the pipe does not exist.
-close | Closes a currently displayed notification.
-install | Creates a shortcut in the start menu which point to the executable , appID used for the notifications.
-v | Print the version and copying information.
-h | Print these instructions. Same as no args.
Exit Status : Exit Code
Failed : -1
Success : 0
Hidden : 1
Dismissed : 2
TimedOut : 3
ButtonPressed : 4
TextEntered : 5
---- Image Notes ----
Images must be .png with:
maximum dimensions of 1024x1024
size <= 200kb
These limitations are due to the Toast notification system.
```
----------------------------------------------------------
# Shortcut creation with Nsis
```
!include LogicLib.nsh
!include WordFunc.nsh
Function SnoreWinVer
ReadRegStr $R0 HKLM "SOFTWARE\Microsoft\Windows NT\CurrentVersion" CurrentVersion
${VersionCompare} "6.2" $R0 $R0
${If} $R0 == 1
Push "NotWin8"
${Else}
Push "AtLeastWin8"
${EndIf}
FunctionEnd
!macro SnoreShortcut path exe appID
Call SnoreWinVer
Pop $0
${If} $0 == "AtLeastWin8"
nsExec::ExecToLog '"${SnoreToastExe}" -install "${path}" "${exe}" "${appID}"'
${Else}
CreateShortCut "${path}" "${exe}"
${EndIf}
!macroend
```
# Register Snoretoast with Appx
Be sure to also pass the `-pid` to Snoretoast.
Replace SNORETOAST_CALLBACK_GUID with the one from https://github.com/KDE/snoretoast/blob/master/CMakeLists.txt#L5
```
# https://docs.microsoft.com/en-us/windows/uwp/design/shell/tiles-and-notifications/send-local-toast-desktop
SnoreToast = f"""
```