Quick Start

Quick Start

I. System requirements.
1) Windows (any desktop version starting from 2000 or XP should be ok, Windows 98 may not work for those .bat used by application, but they might be rewritten accordingly).

Since application is written in pure Java - it will most likely work with any Linux or other OS, where Oracle/Sun Java5+ is supported, it will require rewrite of start-up scripts from /bin/*.bat to use OS specific commands. Beware of filepaths and their format in /config/globalconfigs.properties - they are OS dependant.

2) Memory (RAM) usage is set in /bin/*.bat files, by default it is between 128-256mb.

3) Space required on the file system: 15mb for the application itself + 5mb for logs + space for players local caches (10000 players will occupy: from 0.7mb for SharkScope up to 5mb for OPR). Therefore, 50mb total is normally enough.

II. Here is a minimum set of installtion and configuration settings.
1) Download usunpokertools_*.zip distribution and unpack it somewhere to the local file system (normally it is recommended to use filepath without spaces in it and only with English/ASCII characters). All paths below will be relative tho the one, where you unpack the distribution.

2) Download and install Java5+ (it is the same as 1.5+) from Oracle/Sun provider.
The easiest thing to do is just to go to Oracle and get the latest Java Development Kit, right now it is:
http://www.oracle.com/technetwork/java/javase/downloads/jdk-7u3-download-1501626.html
Windows x86 (32-bit) 84.12 MB jdk-7u3-windows-i586.exe
Windows x64 (64-bit) 87.41 MB jdk-7u3-windows-x64.exe
It will install somewhere into c:/Program Files/jdk_7u3, but you may specify other filepath - the shortter without spaces in it, for instance: c:/jdk_7u3

Additional info:
You may try to reuse already installed Java (either Java Development Kit - JDK or Java Runtime Environment - JRE) - but it will be bit harder. First of all check what you've currently got by running commands in your OS console:
java -version
echo %JAVA_HOME%

The first command will output something like "Java(TM) SE Runtime Environment (build 1.6.0_32-b05)" for Java6. The second will show "c:/jdk1.6.0_32" for Java6 JDK.
If you don't have successful output for both these commands, it's better to install the new one. Or if you know where is your JDK 5+ on the file system - you may try to reuse it as will be shown below (JAVA_HOME system variable will be point to it). JRE 5+ is a lighter version of JDK, it wil be most likely also ok to use using the same configs.

3) Modify /bin/_setEnv.bat, uncomment (remove "rem " prefix) the "set JAVA_HOME=c:/Program Files/jdk_7u3" command and set the correct filepath to JDK or JRE you've installed.

Additional info:
In case JAVA_HOME is already set as OS environment variable (you can check this by running command in OS console: "echo %JAVA_HOME%"), you can skip this step.

4) Configure /config/globalconfig.properties, minimum configs to set are:

• set list of active host systems to be used by tools (first of all, it is used by "Auto-Scan" tools):
  .hostsystem.active=opr,sharkscope,prolabs,ptr

• for each host system listed as active above, set its account login and password:
  .hostsystem.{host system identifier}.extra.LOGIN={your login for this host system account}
  .hostsystem.{host system identifier}.extra.PASSWORD={your password for this host system account}

• set list of active poker rooms/networks to be used by tools (first of all, it is used by "Auto-Scan" tools):
  .room.active=stars,party,pacific,ongame,ipoker,merge,entraction,fulltilt

• for each poker room listed as active above, set path(s) where its hand histories are stored on the local file system; can contain multiple values separated by comma; each directory will be scanned recursively:
  .room.{poker room identifier}.handHistory.rootDirectories={comma-separated list of directories to search for hand histories, each of them will be scanned recursevely}

Path(s) in .properties file should not be like c:\blah, as "\" is a special character for .properties and should be escaped. Use c:/blah and c:\\blah instead

• *advanced settings allow to disable some active host system support for some active room individually (for instance, there might be no point to scan PokerStars by SharkScope and ProLabs, OPR covers everything, it free and fully permitted by PokerStars without restrictions); in order to do so, update list of numeric aliases for the required room in .room.{poker room identifier}.aliases - each such alias is mapped to the host system, you can see it in config section .room2hostsystem.{numeric alias}={host system identifier}

• set list of active trackers/HUD(s):
  .tracker.active={tracker/HUD identifier}
  In most cases you'll use something one from supported pt3, pt4, hm1, hm2 (HM2 is not fully supported for now), pokerhands (PokerHands is not fully supported for now). However, there can be list of them, if you track some rooms by one HUD and others by other HUD. In this case, tools will add generated player notes into all trackers, where corresponding players can be found.

• for each tracker/HUD listed as active above, set their DB access details, database URL, login and password.

In most cases, you just use the single PostgreSQL server with one or more HUD databases on it and the same administrator login "postgres" and password for it.
In this case, just set login and password as default for all tracker(s)/HUD(s) in this section:
.tracker.default.db.login=postgres
.tracker.default.db.password=postgrespass

You can ignore the rest .tracker.default.* settings - they are overridden by tracker specific ones anyway.

However, you can specify login and password for each tracker individually, in this case just add these settings for active trackers (change login/password):
.tracker.{tracker/HUD identifier}.db.login=postgres
.tracker.{tracker/HUD identifier}.db.password=postgrespass

Set database URL for each active tracker/HUD, for instance:
.tracker.{tracker/HUD identifier}.db.url=jdbc:postgresql://127.0.0.1:5432/PT3 DB

• *By default, OPR and all other host systems removed information about PokerStars players money results. OPR, in partucular, hides ROI,Profit,ABI stats for PokerStars players.

However, it is possible to give a very-very rough estimates to replace these hidden stats based on open data left. usunpokertools can assign text labels rating-like instead of each hidden stat. First of all, there is no way for usunpokertools application to know actual ROI, average buy-in (for OPR only), profit stats, which are hidden by default in online ranking systems. It tries to assign the following text labels:

ROI replacement: d- (the weakest),d+,s-,s+/0 (neutral),f-,f+,w-,w+ (the strongest) - means player strength category;
Profit replacement: 0 (operates small amounts),!,!!,!!!,!!!!,!!!!! (operates highest amounts) - it won't show "+" or "-" sign, so it doesn't say if player is actually winning or loosing, just an indicator of volume;
Average Buy-In replacement (OPR only): l-(lowest stakes),l,l+,m-,m,m+,h-,h,h+,t (highest stakes) - category for game stakes.

If you want to disable estimates, set .hostsystem.opr.extra.ESTIMATED_PLAYER_STATS_ENABLED into false value. Player note generated based on estimates will have E flag in it before ROI replacement stat.

This feature is approved by PokerStars.

• *In case you want to use proxy for some host system, you should ensure two flags are set:
  .hostsystem.{host system identifier}.extra.USE_PROXY=true - for individual active host systems, for which you'd like to enable proxy;
  .transport.http.useProxy=true - general flag if proxies should be used at all; if any of these two flags is false - the proxy won't be used for the corresponding host system

You can either set a single proxy to use in .transport.http.proxyHost, .transport.http.proxyPort, or you can enable list of proxies by:
.transport.http.useProxyListFromFile=true - so application will load proxies from the file mentioned in .transport.http.proxyListFilePath. If proxy fails number of times mentioned in .transport.http.maxAttemptsViaProxy, it is discarded and next proxy from the file list is tried for the corresponding host system.

• *There is a load restriction configured by default for OPR host system. It is 5-10 attempts (for login or playe search) per 2 minutes, It should reduce risk of bans by IP from OPR side. You can change these restrictions or completely remove them, if you want to take a risk, or you use proxies you do not care much about,

# Operation load restrictions (e.g. 5 operations per minute). Only login and search operations are tacked without regard if they were successful or not.
# If load restrictions should be enabled, false if not specified
.hostsystem.opr.extra.USE_LOAD_RESTRICTIONS=true
.hostsystem.opr.extra.USE_LOAD_RESTRICTIONS.type=java.lang.Boolean
# Max operation attempts load per given period of time to track (e.g. 5 operations per minute should have 5 here).
.hostsystem.opr.extra.MAX_LOAD=5
.hostsystem.opr.extra.MAX_LOAD.type=java.lang.Integer
# Period of time to track the load (e.g. 5 operations per minute should have 60000 here).
.hostsystem.opr.extra.LOAD_EXPIRATION_PERIOD=120000
.hostsystem.opr.extra.LOAD_EXPIRATION_PERIOD.type=java.lang.Long

You can disable restriction by setting .hostsystem.opr.extra.USE_LOAD_RESTRICTIONS to false or by removing these settings.
.hostsystem.opr.extra.MAX_LOAD is maximum load during period of time (in milliseconds) configured in .hostsystem.opr.extra.LOAD_EXPIRATION_PERIOD. However, actual max load may reach +5 attempts more. It's unknown what are criterias used by OPR to ban, we can only guess.

If you need sharkscope for Stars, please add 104 value to the list ".tool.playerscan_history_tournament.extra.ROOMS" to make it as:
.tool.playerscan_history_tournament.extra.ROOMS=2,3,4,5,6,101,102,103,104,105,106,107,108,202,203,204,205,206,207,208

5) Run /bin/runGUI.bat - it will open console log, and graphical user interface windown with list of tabs corresponding for each active poker tool configured. Each tool tab by default has control buttons to start and stop it, command line input text field and text area tool output for results. Each tool supports |? command, which will show help about all commands available for the tool. "Auto-scan" tools will scan handhistories and send player search commands to the internal server (its execution log is in the console window) upon tool start, no commands are needed such tools during their normal functioning.

Console application logs are also written to the file /bin/usunpokertools.log. In case of any issues, please provide this file for review.