InstanceTime : Instance Timer App

11/23/2015, v 1.0.1: Fix for not correctly finding and running PoE withing right-click menu. Removed experimental fullscreen mode.

InstanceTime 1.0.1
3rd party app for use with Path of Exile
Freely distributed under the LGPL v3
November, 2015

-----===[ System Requirements ]===-----
If Path of Exile runs on your Windows system, InstanceTime will run. Requires at least Windows 2000, but only tested in Windows 7 so far. This application was compiled in AutoHotkey from a script file, so the requirements are tied to AutoHotkey 1.1.22.09 and the functions InstanceTime employs within that script file.


-----===[ How To Operate ]===-----
1.) Extract the compressed zip file to any location (it will extract to a new folder)
2.) Run the InstanceTime executable (InstanceTime.exe)
3.) Use the hot keys on their own, or while Path of Exile is running.


-----===[ Hot Keys ]===-----
By default, the following hotkeys are active...
● Number Pad Add (+) Key:........starts the timer
● Number Pad Subtract (-) Key:..cancels the current timer
● Number Pad Divide (/) Key:......toggles config mode for the following hot keys...
__○ Number Pad Arrow Keys:......moves the timer on the screen 10 pixels
__○ [Shift] NumPad Arrow Keys:..moves the timer on the screen 1 pixel
__○ [Alt] NumPad Arrow Keys:.....moves the timer on the screen 100 pixels


-----===[ Files in InstanceTime.zip ]===-----
_license.rtf...........license for this application
_readme.txt..........this file
InstanceTime.exe..main executable to run
settings.ini...........settings file
tag.png...............the image shown to the left of the timer
tick_soft.wav.......a slightly louder tick sound to use in the settings.ini file (CC License)
tick_softer.wav....default tick sound file (CC License)
tick_warning.wav..final warning sound file (CC License)
[source]
....3rd_Party_Audio.zip...........the two audio files downloaded from FreeSound.org
....InstanceTime.ahk..............AutoHotkey source code for the application
....InstanceTime.ico...............icon for the application
....InstanceTime_Icon.psd......Adobe Photoshop file used to create the icon


-----===[ Notes ]===-----
I created InstanceTime for my own use, but quickly realized it might be of value to the Path of Exile (PoE) community. So I created additional options, documented the script, rolled it into a small application, and released it to the community under a free software license. If you feel that InstanceTime is of some value to you, then please "pay it forward" by contributing back to the community in your own way.

Feel free to edit the original AutoHotkey script file as desired and re-compile using AutoHotkey. The script file is commented and organized in a manner that hopefully makes it easy to read. Please note that this app uses some Windows DLL calls to achieve its functionality, so it will need to be edited to work with other operating system replacements for AutoHotkey, such as AutoKey for Linux.

One stumbling block when editing and compiling your own AutoHotkey scripts: file paths are relative to your source files with includes, not your final compiled executable.

InstanceTime is safe to use as a dual countdown timer outside of PoE.

Timers inside PoE are based on having empty instances open (instance without players in them), not the portal you cast. Therefore PoE's own internal timer starts when you leave an instance, not when you cast a portal. So start your timer after you've entered your portal or have taken the waypoint portal. The first timer is set by default to 8 minutes, which is for area instances that do not have more than one entrance/exit. The second timer is set by default to 15 minutes, which is for area instances that have more than one connection to another area.


-----===[ Settings File ]===-----
The settings.ini file stores all of the user preferences for InstanceTime. It is not required for InstanceTime to function. If InstanceTime is launched without the settings.ini file, it will use default values for those options. InstanceTime will also make changes to the settings.ini file whenever a user enters configuration mode within InstanceTime. The file is commented, and you are welcome to make changes to it.


-----===[ Known Issues ]===-----
● While InstanceTime is running, the "hot keys" it uses on the number page will not be passed through to any other application. This is to prevent hot keys from accidentally triggering multiple times, or to cause confusion by activating two tasks at the same time. In a future version I might try to find a way around this, but for now the number pad is usually a very under-utilized set of keys on the keyboard. I avoided PgUp/PgDn since this would interfere with the default bindings for camera zoom in PoE.


-----===[ License & Credits ]===-----
Created by cipher_nemo, Copyright 2015. This script and any associated files authored by cipher_nemo are released upon the GNU Lesser General Public License (LGPL v3): http://www.gnu.org/licenses/lgpl-3.0.en.html

~~ Other files included with this package ~~
● Clock Tick (tick.wav) by Jagadamba, CC license, https://freesound.org/people/Jagadamba/sounds/254315/

● Small Carriage Clock Sound (tick_warning.wav) by acclivity, CC license, https://freesound.org/people/acclivity/sounds/30608/


-----===[ Useful Resources ]===-----
1.) AutoHotkey: http://ahkscript.org/
Very powerful script engine that allows hooks into almost anything. Super small footprint for compiled binaries makes distributing quick applications very easy. InstanceTime is based upon an AutoHotkey script and its powerful yet tiny engine.

2.) FreeSound.org: https://freesound.org/
I found the two sound files I use for InstanceTime on this site. The best fact is that this site utilizes the CC license, which allows me to redistribute those sound files for free provided I do not use them for commercial use and attribute the authors.

[General]
; General options for InstanceTime...
; values in 1 or 0 (true or false),
; and PoE names/locations in strings
AudibleWarningOnTimer1=1
AudibleWarningOnTimer2=1
MuteSound=0
PathOfExileExecutableLocation=C:\Program Files (x86)\Grinding Gear Games\Path of Exile\
PathOfExileExecutableName=PathOfExile.exe

[Timing]
; Timing of specific events...
; InventoryOpenAndCloseDelay is in ms
; DefaultControlDelay is in ms
; TimerFinishCloseDelay is in seconds
; default timer1 and timer2 lengths: 480 and 900
; TriggerWarning is for turning yellow,
; TriggerAlert is for turning red,
; TriggerAudibleAlert is for playing "TimerWarning"
TimerFinishCloseDelay=3
Timer1Length=480
Timer2Length=900
; set any Trigger to -1 to disable
TriggerWarning=90
TriggerAlert=45
; this is applied only to the final, 15 minute timer...
TriggerAudibleAlert=20

[Position]
; Position of timer on screen...
; X and Y coordinates as reported by operating system,
; change these to move timer, eg: topleft is X=0, Y=0
X=10
Y=30

[Colors]
; Possible colors...
; Black, Silver Gray, White, Marron, Red, Purple, Fuchsia,
; Green, Lime, Olive, Yellow, Navy, Blue, Teal, Aqua,
; or any 6-character hex value (eg: EEAA99)
ColorNormal=Lime
ColorWarning=Yellow
ColorAlert=Red
; do not use ColorAlpha's value in any colors above,
; change ColorAlpha if you want to use its current color
ColorAlpha=554455

[Sounds]
; Sounds: file name of sound file to play,
; uses the folder of the script file as its starting path,
; so copy your own files to this path, or use relative path,
; Example: ..\..\MyFolder\mysound.wav
TickSound=tick_softer.wav
TimerWarning=tick_warning.wav

[Portal]
; Settings that affect opening a portal with a scroll...
; Due to GGG's current policy, these options are no longer
; available. They're listed here for historical purposes
; for when I removed the code that performs this feature
PathOfExileWindowName=Path of Exile
OpenPortalBeforeTimer=0
CloseInventoryAfterPortal=1
InventoryOpenAndCloseDelay=50
DefaultControlDelay=20
PortalScrollX=1883
PortalScrollY=807
KeyInventory=i
KeyCloseAll=Space
KeyRightClick=RButton