Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
Kapps committed Oct 3, 2014
2 parents 8cea6c1 + 62e988a commit 4ee09bb
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,27 @@
PoEWhisperNotifier
==================
A simple C# application to notify you of whispers you get in PoE (optionally) while your game is minimized.
Other features include storing a history of the whispers received and Windows tray notifications.
PoEWhisperNotifier is a free and open-source tool that runs in the background to notify you of whispers you get in PoE (optionally) while your game is minimized. You can currently be notified through Windows tray notifications, playing a sound, sending an email, or notifying your phone through PushBullet. The program will also record a history of all missed whispers in case you can't immediately get back to PoE.

The program works by parsing client.txt as PoE writes to it in realtime. It should also be fairly light on resources (does not load all of client.txt and uses little CPU) and can remain open even while PoE is closed if desire.
The program works by parsing client.txt as PoE writes to it in realtime. It should be fairly light on resources (does not load all of client.txt and uses very little CPU) and can remain open even while PoE is closed if desired.

For sending notifications to your phone, using PushBullet is highly recommended over SMTP. Simple go to http://pushbullet.com, sign in with your Google account, go to http://pushbullet.com/account and copy that access token into the Configure PushBullet setting in the program (and enable PushBullet notifications in settings).
Please note that this program never actually interacts with the client and therefore will not get you banned for using it.

Direct download link for the compiled version: https://github.com/Kapps/PoEWhisperNotifier/releases/download/v1.4/v1.4.PoEWhisperNotifier.zip
Getting Started
==================
1. Download and run the compiled version using the link at the bottom.
2. Make sure the Log Path selected is valid (the default path is fine if you did not change where PoE is installed to).
3. Press Start (you may wish to enable Auto-Start in settings to skip this step in the future).

The default settings will play a sound and show a Windows notification if you receive a whisper while PoE is minimized.
For sending notifications to your phone, using PushBullet is highly recommended over SMTP.

Phone Notifications (PushBullet)
==================
1. Go to http://pushbullet.com and sign in with your Google account.
2. Go to http://pushbullet.com/account and copy that access token.
3. Go into the Configure PushBullet settings item in the program and paste in the access token.
4. Make sure Enable PushBullet Notifications is checked.

Download
==================
Direct download link for the latest compiled version: https://github.com/Kapps/PoEWhisperNotifier/releases/download/v1.4/v1.4b.PoeWhisperNotifier.zip

0 comments on commit 4ee09bb

Please sign in to comment.