achievement-watcher

README

A sexy achievement file parser with real-time notification.

Live notification on achievement unlocking

Not as sexy as a directX Overlay but it's the next best thing.
Display a Windows toast notification when you unlock an achievement.
Please verify your notification and focus assistant settings for this to work properly.

You can disable this feature in the settings section.

Note that there might be a slight delay between the event and the display of the notification as running powershell and loading a remote img resource can take a few seconds in some cases.

Game must be set to Window borderless for the notification to be rendered on top of it otherwise you'll just here the sound.

🚑 Not seeing any notification ? Quick fix :

• try to set your game to Window borderless.
• try to disable the automatic game rule in focus assistant
• try to set checkIfProcessIsRunning to false in %appdata%/achievement-watcher/options.ini

Oh and make sure watchdog.exe is running.

Not all games are supported, please see below.

File Supported :

1 achievements.ini

• Progression: no (Always to zero ?)
• Unlock time: yes
• Live notification: yes

2 stats\achievements.ini

• Progression: no (Always to zero ?)
• Unlock time: no (Unknow hex time format)
• Live notification: no (Coz no unlock time)

3 achieve.dat

• Progression: no (None)
• Unlock time: no (None)
• Live notification: no (Coz no unlock time)

In the following location :

• %PUBLIC%\Documents\Steam\CODEX
• %ProgramData%\Steam\
• %localappdata%\SKIDROW
• %appdata%\SmartSteamEmu

Will be scanned too altho there is no achievement file yet at the time of writing :

• Documents\CPY_SAVES
• %appdata%\CPY_SAVES
• %appdata%\Goldberg SteamEmu Saves

Steam Web API Key

Some use of the Steam Web API to fetch data from Steam requires the use of an API Key.
If you leave the field blank in the settings section, it will automagically fetch said data.

An example of a server that feeds you the data is provided within this repo.
This service is not guarantee over time and is solely provided for your own convenience.
If you experience any issues please use your own Steam Web API key.

You can acquire one by filling out this form.
Use of the APIs also requires that you agree to the Steam API Terms of Use.

Options

Options are stored in %AppData%\Roaming\Achievement Watcher\cfg\options.ini

[achievement]

• lang
  default to user locale
  Both UI and data from Steam
  
• showHidden
  default to false
  Wether or not show hidden achievements if any
  
• mergeDuplicate
  default to true
  Try to merge multiple achievement files with the same steam appid
  
• notification
  default to true
  Display or not a Windows toast notification on achievement unlocking.
  (AchievementWatcher.exe doesn't need to be running for this, but watchdogd.exe does).
  

[notifier]

• timeTreshold
  default to 30 sec
  When an achievement file is modified; Amount of sec watchdogd.exe will consider the most recent achieved achievement (from its timestamp value) to be new.
  

• checkIfProcessIsRunning
  default to true
  When an achievement file is modified; Wether to check or not if the corresponding game is running and responding.
  
  Both options are mainly there to mitigate false positive.

Command Line Args | URI Scheme

Args:
--appid xxxxx

URI:
ach:xxxx

xxx is a steam appid

After the loading directly display the specified game.

Windows compatibility

Windows x64 only.
Windows 10 >= 1809 is recommended.

It should work starting with Windows 8 and above but keep in mind that this was mostly tested with Windows 10.

Translation Help

I do my best to translate everything for every supported language by Steam, but it's rather difficult and I don't speak that much languages. Fluent in another language ? Any help to add/modify/improve would be greatly appreciated.

More details here

Auto-Update

This software auto update itself via Windows scheduled tasks. There are .cmd files in the root directory to create, delete and manually run the tasks.

File cache & Logs

in %AppData%\Roaming\Achievement Watcher

Legal

Software provided here is to be use at your own risk. This is provided as is without any express or implied warranty.
In no event or circumstances will the authors or company be held liable for any damage to yourself or your computer that may arise from the installation or use of the free software aswell as his documentation that is provided on this website.
And for anything that may occur as a result of your use, or inability to use the materials provided via this website.

Software provided here is purely for informational purposes and does not provide nor encourage illegal access to copyrighted material.

Software provided here is not affiliated nor associated with Steam, © Valve Corporation and data from its API is provided as is without any express or implied warranty.

Software provided here is not affiliated nor associated with any cracking scene groups.

Other trademarks, copyright are the property of their respective owners. No copyright or trademark infringement is intended by using third-party resources. Except where otherwise specified, the contents of this project is subject to copyright.