SC2Ranks Custom Division Profiler


Developers Last Update Started Language Tools License	Kevin Gardthausen 2013-08-08 2011-08-12 VB.Net 4.0 Visual Studio 2012 GNU GPL v3

Windows Desktop application for generating a statistical (HTML) snapshot of a custom division of SC2Ranks. Also works under Linux using Mono (v3.3.0).

Examples:
http://www.hwc-clan.com/sc2-stats/
http://www.deviationgaming.com/index.php/dvg-rankings

What is SC2Ranks?

SC2Ranks is a StarCraft II statistics aggregation site for all realms.

Download

[wpfilebase tag=file id=1 /]

Command Line Switches

/config=FILEPATH
- The path to the config file. Other command line flags override the config.
/customdivisionid=51e882c969d5386f5900cac4 OR /cid=51e882c969d5386f5900cac4
- Set the custom division. Default: 51e882c969d5386f5900cac4 (HwC Clan Division)
/commandline OR /cl
- Starts the app in command line mode.
/refresh OR /r
- Refreshes the players in the custom division.
/autodownload OR /ad
- Automatically start the download the when the program starts.
/autoclose OR /ac
- Automatically close the program after a download has automatically started (/autodownload).
/disableautosave OR /das
- When specified does not automatically save the data to file.
/filename=FILENAME
- Specify output file name. Default: StarCraft 2 Rankings.htm
/savepath=DIRECTORYPATH
- Specify save path. Default: Program working directory
/template
- Specify a template for writing data. Values:
  - $achievement$
    - Achievement Points Ranking Table
  - $1v1$
    - 1v1 Ranking Table
  - $2v2$
    - 2v2 Ranking Table
  - $3v3$
    - 3v3 Ranking Table
  - $4v4$
    - 4v4 Ranking Table
  - $timestamp$
    - Timestamp when the file was generated (Format: yyyy-MM-dd HH:mm:ss.fff)
  - $version$
    - Version used (Format: vMajor.Minor.Build [SVN Revision Revision])
  - $generatedby$
    - User who generated the file (Format: Computer\Username)
  - $generatedin$
    - The time in seconds it took to retrieve all data and generate the file
  - $customdescription$
    - As specified in custom description.
/verbose OR /v
- Provides more details in error messages.
/retrycount=3
- The number of retries per data request to SC2Ranks.com before giving up. Default: 3 (Valid Range: 0-5)
/retrywaittime=15
- The number of seconds to wait between retries. Default: 15 (Valid Range: 0 -180)
/reset
- Sets all saved setting back to application default.

Windows

Requires the Microsoft .Net Framework 4.0: http://www.microsoft.com/en-us/download/details.aspx?id=17718

Unix

Installing Mono on Ubuntu 12.04 LTS/13.04

Mono 3.3.0 or higher is required to run the NuGardt Custom Division Profiler. You can install the deb packages from Meebey or compile Mono 3.3.0 yourself (not shown here).

Add “deb http://debian.meebey.net/experimental/mono /” (without quotation marks) to the file “/etc/apt/sources.list” and run the commands below (Source: http://www.meebey.net/posts/mono_3.0_preview_debian_ubuntu_packages/).

sudo apt-get -y install mono-runtime libmono-microsoft-visualbasic10.0-cil libmono-system-runtime-serialization4.0-cil
wget https://www.nugardt.com/download/software/nugardt-sc2ranks-customdivisionprofiler-2013.08.09.zip
unzip nugardt-sc2ranks-customdivisionprofiler-2013.08.09.zip
mono NuGardt.SC2Ranks.CustomDivisionProfiler.exe

sudo apt-get -y install mono-runtime libmono-microsoft-visualbasic10.0-cil libmono-system-runtime-serialization4.0-cil

wget https://www.nugardt.com/download/software/nugardt-sc2ranks-customdivisionprofiler-2013.08.09.zip

unzip nugardt-sc2ranks-customdivisionprofiler-2013.08.09.zip

mono NuGardt.SC2Ranks.CustomDivisionProfiler.exe

Setting up a cronjob

Included in the setup is a shell script called ‘nscdp_run_cron.sh’. Find these in the “\Tools\Linux” folder. These scripts must be amended to reflect you path on Linux.

Open the crontab editor via the command line

crontab -e

1	crontab -e

Add the following line to start job every day at 02:00:

0       2       *       *       *       /your_path_to_script/nscdp_run_cron.sh         # NuGardt Custom Division Profiler

1	0 2 * * * /your_path_to_script/nscdp_run_cron.sh # NuGardt Custom Division Profiler

Open source

Download the source at https://github.com/NuGardt/sc2ranks-customdivisionprofiler

Developed with Microsoft Visual Studio 2010 in .NET Framework 4.0.

Support

Home Page: https://www.nugardt.com/open-source/sc2ranks-custom-division-profiler/
Code: https://github.com/NuGardt/sc2ranks-customdivisionprofiler
SC2Ranks: http://sc2ranks.com/
Issue Tracking: http://jira.nugardt.com:9080/browse/NSCDP
Create issue via e-Mail: nscdp-jira [at] nugardt [dot] com

E-mail: [email protected]
Twitter: https://www.twitter.com/NuGardt
Facebook: https://www.facebook.com/NuGardt

Changelog

V2.0.0.1 (2013-08-09)
- Fixed retry count of 0.
- Entering an incorrect API key no longer results in retries.
V2.0.0.0 (2013-08-08)
- Open Source release.
- Removed custom division refresh.
- Faster server query through new API (less calls) provided by SC2Ranks.

V1.3.0.157 (2013-06-30)
- Maintenance release.
V1.3.0.122 (2013-05-31)
- Fixed an exception that could occur when refreshing characters under the Mono framework.
- Fixed a typo in the settings description for Win/Loss ratio.
- Added settings for ignoring local cache if desired. Not recommended though.
- Added command line shortened switches.
- Added settings for cache duration.
- Fixed problem where the cache was not saved when an error (403 Fobidden/Too many requests) occurred.
- Added setting for display custom division rank.
- Added setting to hide the “Last update”, “Region Rank” and “World Rank”, “Region (R.)” column.
V1.3.0.94 (2013-05-14)
- Queries are now cached as specified by SC2Ranks.
- Added race icons.
- League icons are now in one image and chosen via CSS.
- Added more CSS tags to output.
V1.2.0.55 (2013-05-08)
- Added support for clan tag in API.
- Cleaner HTML output.
- More CSS classes. Refer to the “Base Template.htm” in \Tools
V1.2.0.53 (2013-05-02)
- Added support for expansions.
- The timestamp for teams no longer shows the update timestamp for the character.
V1.2.0.29 (2013-03-07)
- Fixed parsing error where character code could be Nothing.
V1.2.0.18 (2012-08-04)
- Added option to link all players to SC2Ranks.com URL.
V1.1.0.14 (2012-04-13)
- Working under Linux with mono. Tested with Ubuntu 10.04/12.04 LTS with mono (http://badgerports.org/ for 10.04 backport)
- Read the Linux section above to details on how to setup a cronjob.
V1.0.0.10 (2012-03-18)
- Added command line mode (/commandline)
- Added option to hide certain columns (last update, losses and win/loss ratio).
V1.0.0.x (2011-08-30)
- Code optimized.
V1.0.0.x (2011-08-24)
- Fixed problem where settings where not saved.
V1.0.0.x (2011-08-23)
- Refreshing the profiles of an entire custom division is now supported.
V1.0.0.x (2011-08-18)
- When /autoclose is specified, the output file is no longer opened automatically.
- Code optimized.
- Base Template (Base Template.htm) is now included. To use it, specify your template with ‘/template=”BaseTemplate.htm”’ You can edit the file by opening it in a HTML editor.
V1.0.0.x (2011-08-13)
- Fixed a typo.
Fixed a sorting issue when the world and region rank is not available to a team that has no points.
V1.0.0.x (2011-08-12)
- Initial release.

License

NuGardt SC2Ranks Custom Division Profiler
Copyright (C) 2011-2013 NuGardt Software
https://www.nugardt.com

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.