|
![[image loading]](http://i.imgur.com/TB9Tz.png)
Hi TL,
Introduction
I present to you SC2ReplayHandler. A utility that automatically renames/stores/cleans replay files to keep things neat. the software monitors the folder(s) that your replay files are saved at, and then renames/copies them based on meta information in the files to a more managable naming convention that you can customize on your own using placeholders.
This will forever remain FREE, at some point I intend to release this as Open Source.
Im always happy to accept any sort of feedback and add/change things as time goes by, since even though I had quite a few users for the initial beta, different people come with different needs, so feel more than welcome to post requests in comments or PM me.
Examples
+ Show Spoiler +
- "somefile1.SC2Replay" --> "2012-01-16 PvT on Antiga Shipyard - WhiteRa vs EmpireKas.SC2Replay"
- "somefile2.SC2Replay" --> "Private Game - WhiteRa(P) vs EGIdrA(Z) on Xel'naga Caverns [ver1.4.2.20141].SC2Replay"
Common uses for the tool can be ( based on beta users feedback so far )
- Replay file management
- Creating copies of your own ladder games for replay packs
- Cleanup
Why Did You Write It ?
For a while now I wanted to try and do something for the general SC2 community, I guess EGiNcontrol's blog last year helped in finding some motivation, then A few days ago I stumbled upon Ascend's library, which made me decide to try and solve something that me and some friends were talking about - effortless replay housekeeping.
anyway, I guess every one can contribute in their own ways, this is mine.
How Does It Work ?
The software monitors the folders where Replays are saved/kept at, and on the appearance of a new replay, it parses it for information such as player names and races, maps, dates, matchups, etc ... and then renames the file and possibly copies/moves it for you, therefor keeps it hassle-free. also, since its .NET based and does nothing else fancy, its really fast and barely uses resource.
Latest Version : 1.18
Last Update : 03-02-2012
Download
Click Here to download the latest package.
User Group and Bug Report
Click Here for the Google Group to discuss bugs, and usage. version announcements are automatic for group members.
Instructions
+ Show Spoiler +Install and Basic Configuration- extract the files to a directory of your choice
- run the SC2ReplayHandler.exe
- in the system tray, right click on the Icon and press "Settings"
- follow the easy steps of Lookup-Match-Rules which means --
- in "Lookup" you choose where the replays are saved on your computer, which is normally "C:\Users\USERNAME\Starcraft II\Accounts\" ( including subdirectories ).
- in "Match" you define which type of files to look at ? specific player files, ladder only, or if no criteria is chosen then - Everything.
- "Rules" - what should we actually do with files we find..
- the "File Pattern" is the most important one, since it describes the structure of the name of files after rename, click on the arrow for examples and on "Legend" for the place holder list.
- once done hit "Ok"
you are now done with the configuration. note the following : - it is recommended to Run manually once by right clicking on the tray icong Run >> Run Now, since it will go through everything in the lookup folder for the first time
- the software listens to windows events, everytime a new file is added to the directory you monitor, it will invoke the tool
- on first run, the software might ask you to update your ".NET Framework" through Microsoft's Windows Update
it is recommended to put a link to the sotware in the Start>>Programs>>Startup folder, so the tool automatically loads for you and you dont have to think about it, after all... effortless is the idea ... here is a Video that should simplify usage : http://www.youtube.com/v/zKce5nfZMpw
Screenshots
+ Show Spoiler +settings![[image loading]](http://i.imgur.com/vmQ0r.png) tray icon![[image loading]](http://i.imgur.com/jAlzz.png) placeholder legend![[image loading]](http://i.imgur.com/peGlW.png)
Changelog
+ Show Spoiler +
v1.18
- rewrote the log mechanism for debug messages, much more verbose now.
- improved MD5 utility
- fixed a bug where 2 or more replays that appear to be the same, only first will be handled.
- fixed a bug where date was not the correct date of the actual replay.
- new behavior, if a resulting file name for 2 diffrent files is the same, a __UID<number> will be added
v1.17
- new settings.xml required, previous users need to reconfigure.
- added [MD5SC2GEARS] predicate that outputs the same MD5 Hash format as SC2Gears
- added Sort function that always matches the selected player as Player 1
1.16
- added a choice on the specific folder execution, to choose rename only or use all rules
- changed the Legend screen into a more readable screen
v1.15
- fixed a bug where if you change folders you needed to restart the tool
- fixed a bug where version would show game length instead
- added [VER] which is like [VERSION] but only show 3 digits of the version ( i.e. "142" )
v1.1
- added [MD5] option, that calculates MD5 hash based on the file.
- added [LENGTH] option, that returns the total running minutes of the replay.
- fixed the legend, it missed "[MAP]" even though it was coded.
v1.0
- Initial Release.
Libraries Used and other Credits
+ Show Spoiler +- SC2Replay-CSharp by Ascend - MpqLib by Magos - the Icon is a variation of Ascend's Starboard Icon, using the PSD. - thanks András Belicza (author of SC2Gears ) for the MD5 Encoding algorithm of SC2Gears
all I can conclude with is some wishes for you all..
never Stim in front of children, dont Forcefield other people's ramps, and always clean after yourself when injecting Larvae.
GLHF!
Sectorix.
|
Why would I use this over SC2 Gears when I already have that up and running?
|
On January 17 2012 05:58 Barett wrote:
Why would I use this over SC2 Gears when I already have that up and running?
I use SC2Gears too, mostly for analysis. its just a different approach i guess.. i wanted something that runs regardless to anything and does things without me having to remember run, and a few ppl i know have asked me if i can write something like this. you can use either or both... choice is great isnt it ? 
Edit : also some comments i got from users that downloaded is that its really fast since it does only that, plus runs on .NET and not Java.. i didnt check but thats the feedback.
|
Actually this is very useful to me.
SC2Gears was a bit too heavy to run at the same time as SC2 on my computer, and made split seconds freezes from time to time, so I stopped using it. Because of this, to save replays, I had to manually select all replays in the Multiplayer folder, then "Rename all" and "Move all" every time. I also couldn't put downloaded replays in a subfolder in Multiplayer, because SC2Gears includes subfolders, which means I couldn't use the ingame menu to watch replays I've downloaded.
This seems to be much lighter, has an option to exclude subfolders, and can be run seperately after a game session in one click.
The only thing missing right now is that I can't completely simulate the rename pattern I was using in SC2Gears because it's missing the MD5 tag option. Adding MD5 as part of the name apparently speeds up searches and analysis in SC2Gears which is why I'm saving all these replays to begin with. If you could add that, that would completely replace my use of SC2Gears replay save.
|
On January 17 2012 06:32 Wiwiweb wrote:
Actually this is very useful to me.
SC2Gears was a bit too heavy to run at the same time as SC2 on my computer, and made split seconds freezes from time to time, so I stopped using it. Because of this, to save replays, I had to manually select all replays in the Multiplayer folder, then "Rename all" and "Move all" every time. I also couldn't put downloaded replays in a subfolder in Multiplayer, because SC2Gears includes subfolders, which means I couldn't use the ingame menu to watch replays I've downloaded.
This seems to be much lighter, has an option to exclude subfolders, and can be run seperately after a game session in one click.
The only thing missing right now is that I can't completely simulate the rename pattern I was using in SC2Gears because it's missing the MD5 tag option. Adding MD5 as part of the name apparently speeds up searches and analysis in SC2Gears which is why I'm saving all these replays to begin with. If you could add that, that would completely replace my use of SC2Gears replay save.
thanks for the feedback, ill add MD5 for the next release. right now i'm collecting some feedback from people like yourself to see if anything is missing, i was also asked for Game Length, which i will add as well.
|
Update to version 1.1 -- download link updated.
changes ( also in changelog ) :
- added [MD5] option, that calculates MD5 hash based on the file.
- added [LENGTH] option, that returns the total running minutes of the replay.
thanks Wiwiweb for the suggestion.
|
Works great Barry.
Thanks for this :D
Question, what's the best way to update this then?
Just download the new package and run it? (If I do that, I have to re-enter all of the pathing and settings)
|
On January 17 2012 07:42 Fruity wrote:
Works great Barry.
Thanks for this :D
Question, what's the best way to update this then?
Just download the new package and run it? (If I do that, I have to re-enter all of the pathing and settings)
to update, overwrite the files from the package. but you can keep "settings.xml" which contains your configuration.
unless, its stated in the Changelog that it contains new settings.xml file ( if i add functionality of some sort ) then new settings file need to be used
|
Wow!
This is one sick addon!
|
awesome stuff, thanks alot for investing your time in such a small, yet very useful program , tbh , i know alot of ppl that used sc2gears only for the sake of the replay saving so this will be very useful for them , and for me too!
keep up the great work !
|
thanks for the support
due to some feedback i got i did update to fix a couple of bugs that were pointed out, plus added a [VER] predicate for a short 3 digit version name ( for example for 1.4.2.20141 it will show 142 ).
i also have some very good feedback so far on performance and low mem/cpu/io even with very large libraries. thanks for those of you who sent me messages so far.
|
On January 17 2012 07:26 Sectorix wrote:
thanks Wiwiweb for the suggestion.
No, thank you for adding it
|
Updated to 1.16, this is mostly cosmetic to add an easier to read Legend screen and add some more basic functionality to the specific folder execution.
I would have waited until i add more stuff, but some users complained that the legend screen was hard to read, so I remade it.
screenshot :
+ Show Spoiler +new Legend screen
|
For some reason the MD5 I get from a replay doesn't seem to end up being the same with SC2Gears and SC2ReplayHandler... Multiple ways of calculating MD5?
![[image loading]](http://i.imgur.com/WM3Jc.jpg)
( I used "[DATE] - [MATCHUP] - [MAP] (MD5_[MD5]).[EXT]" )
I don't really know the technical details, but as long as the name is different for every replay, it should still improve search speed, so it shouldn't matter, right? If you really want to follow SC2Gears's pattern, you can change this I suppose.
|
well, look at a tools like MD5sums for Windows , it produces the value that my MD5 hash calculation creates, so its the correct MD5. I believe that SC2Gears does an interpretation on the MD5 and doesnt use the actual hash, maybe it does a Base64 on it or something similar.
i believe speed is the same as long as you use a hash, regardless to which one, but that's my concept of it.
|
Dakota_Fanning
Hungary2359 Posts
On January 18 2012 06:07 Sectorix wrote:well, look at a tools like MD5sums for Windows , it produces the value that my MD5 hash calculation creates, so its the correct MD5. I believe that SC2Gears does an interpretation on the MD5 and doesnt use the actual hash, maybe it does a Base64 on it. from what i've tested the speed is the same as long as you use a hash, regardless to which one, but that's my experiance with it.
Unfortunately this is not the case.
MD5 is a standard algorithm, Sc2gears does not re-define it. After calculating the MD5 Sc2gears shortens it (encodes it) so the file name will be shorter (as seen in the picture). Using the original MD5 will not result in faster search and analysis. If it's not the same as produced/expected by Sc2gears, it will not give speed advantage.
|
On January 18 2012 06:57 Dakota_Fanning wrote:Show nested quote +On January 18 2012 06:07 Sectorix wrote:well, look at a tools like MD5sums for Windows , it produces the value that my MD5 hash calculation creates, so its the correct MD5. I believe that SC2Gears does an interpretation on the MD5 and doesnt use the actual hash, maybe it does a Base64 on it. from what i've tested the speed is the same as long as you use a hash, regardless to which one, but that's my experiance with it. Unfortunately this is not the case. MD5 is a standard algorithm, Sc2gears does not re-define it. After calculating the MD5 Sc2gears shortens it (encodes it) so the file name will be shorter (as seen in the picture). Using the original MD5 will not result in faster search and analysis. If it's not the same as produced/expected by Sc2gears, it will not give speed advantage.
thank Dakota_Fanning, i will check with you regarding the option to use the same encoding.
love your work btw !
|
This is really cool.
Would it be possible to include an option that lists the specifically selected player (and their race) first, irrelevant of whether they're actually Player 1 or 2 or whatever?
Since I sometimes moonlight as Protoss / Zerg, this would make it easier to identify replays from those times, and see the race I'm playing and what race I'm playing against. So PvT would always mean I was Protoss, and TvP would always mean I was Terran, instead of having to guess.
|
On January 18 2012 07:51 netherh wrote:
This is really cool.
Would it be possible to include an option that lists the specifically selected player (and their race) first, irrelevant of whether they're actually Player 1 or 2 or whatever?
Since I sometimes moonlight as Protoss / Zerg, this would make it easier to identify replays from those times, and see the race I'm playing and what race I'm playing against. So PvT would always mean I was Protoss, and TvP would always mean I was Terran, instead of having to guess.
you got it, i will add it to the next build.
|
Updated to 1.17
- thanks to Dakota_Fanning, added the calculation of the SC2Gears compatible MD5 Encoded Hash.
- added the sort by selected player functionality
- this build requires scratch config, since the settings.xml changed.
|
Thanks for the new functionality.
|
Nice job with the MD5. 
I've found a little bug, the Date tag (and I suppose the Time tag though I haven't tested it) takes the current date instead of the date that the game was played. Which means if you rename old replays, the date will be incorrect.
|
On January 19 2012 06:09 Wiwiweb wrote:Nice job with the MD5. I've found a little bug, the Date tag (and I suppose the Time tag though I haven't tested it) takes the current date instead of the date that the game was played. Which means if you rename old replays, the date will be incorrect.
ill check that for the next build hope you enjoy using it so far..
|
adding a short video explaining how to use the tool, following some requests from people via PM.
video
+ Show Spoiler +
|
Did you end up fixing the date bug?
|
Many thanks! I needed something like this for my 450 mb of pro replays.
|
On January 27 2012 20:22 Wiwiweb wrote:
Did you end up fixing the date bug?
Didnt find the time yet, but i will look at it this week
|
Oh I found out another bug. I have 2 games with the same opponent, same map, same day, but only one of them is processed, even though both should have different names since I use MD5. The second replay simply isn't seen by the program ("0 files processed!"). I've unchecked all the filter options too. Sorry I don't have much info on this bug, if you want I can send you replay that's not working.
About the Date bug, I found that the Date tag isn't actually using the current date like I thought before, but the "Date created" field from Windows. That doesn't always match up with the match date though (for instance when you copy paste a replay) which is why there's some problems.
|
|
|
On January 31 2012 05:10 Wiwiweb wrote:
Oh I found out another bug. I have 2 games with the same opponent, same map, same day, but only one of them is processed, even though both should have different names since I use MD5. The second replay simply isn't seen by the program ("0 files processed!"). I've unchecked all the filter options too. Sorry I don't have much info on this bug, if you want I can send you replay that's not working.
About the Date bug, I found that the Date tag isn't actually using the current date like I thought before, but the "Date created" field from Windows. That doesn't always match up with the match date though (for instance when you copy paste a replay) which is why there's some problems.
Wiwiweb, thanks a ton on all the feedback so far ! it really helps, could you send me bugs you find via PM ? would be easier for me to track than in the thread. do send me examples of things not working, i can share my email with you via PM to make life easier for both of us
At the moment i did not yet have a chance to go and check the code ( my Son was born a few days ago and that's all i do for the time being :-D ) but i do have these 2 listed to check as soon as i got some PC time.
|
Dakota_Fanning
Hungary2359 Posts
On January 31 2012 16:42 Sectorix wrote:Show nested quote +On January 31 2012 05:10 Wiwiweb wrote:
Oh I found out another bug. I have 2 games with the same opponent, same map, same day, but only one of them is processed, even though both should have different names since I use MD5. The second replay simply isn't seen by the program ("0 files processed!"). I've unchecked all the filter options too. Sorry I don't have much info on this bug, if you want I can send you replay that's not working.
About the Date bug, I found that the Date tag isn't actually using the current date like I thought before, but the "Date created" field from Windows. That doesn't always match up with the match date though (for instance when you copy paste a replay) which is why there's some problems. Wiwiweb, thanks a ton on all the feedback so far ! it really helps, could you send me bugs you find via PM ? would be easier for me to track than in the thread. do send me examples of things not working, i can share my email with you via PM to make life easier for both of us At the moment i did not yet have a chance to go and check the code ( my Son was born a few days ago and that's all i do for the time being :-D ) but i do have these 2 listed to check as soon as i got some PC time.
Congrats on your son 
|
Wow this is great! Thanks a lot for posting this!
|
I think I found a bug where on some replays the game length would show as 0.
|
On January 31 2012 18:43 FreeFruitFly wrote:
I think I found a bug where on some replays the game length would show as 0.
PM me an example and i would be happy to look into it.
|
i found a bug, sometimes it displays the correct winner, and sometimes it doesn't =\
happens more in mirror matchups, but i'm not sure
|
Ok,
Ive looked at some cases that ppl sent me, which all seem to lead to some parsing issues derived from the parser library im using. I have talked to its author to check with me and see how can we fix these small but bothering issues.
Will update here
As always, thanks for using the tool, and thanks for your feedback !
|
today, to assist the growing number of users and to make it easier for me to understand found bugs and feature requests, i added a Google Group which allows the following :
1. post bug reports and feature requests
2. get announcements when i release updates
3. discuss in general the usage of the application
anyone can join the group and you are all welcome --> http://groups.google.com/group/sc2replayhandler
|
On January 31 2012 05:10 Wiwiweb wrote:
Oh I found out another bug. I have 2 games with the same opponent, same map, same day, but only one of them is processed, even though both should have different names since I use MD5. The second replay simply isn't seen by the program ("0 files processed!"). I've unchecked all the filter options too. Sorry I don't have much info on this bug, if you want I can send you replay that's not working.
About the Date bug, I found that the Date tag isn't actually using the current date like I thought before, but the "Date created" field from Windows. That doesn't always match up with the match date though (for instance when you copy paste a replay) which is why there's some problems.
solved for upcoming 1.18 --> https://groups.google.com/d/topic/sc2replayhandler/pnXansOKUm8/discussion
|
|
|
Updated v1.18.
this solves several reported bugs, all info in the google group, download link in main thread message as always
hope you like it
|
hm, im not abel to start the program for some reason :S
|
On February 04 2012 04:26 Invasion wrote:
hm, im not abel to start the program for some reason :S
check in your system tray, it will appear as an icon.
( if its the first time you run it, it may ask you to download .NET framework 4.0 first from Microsoft ).
|
On February 04 2012 07:10 Sectorix wrote:
check in your system tray, it will appear as an icon.
( if its the first time you run it, it may ask you to download .NET framework 4.0 first from Microsoft )
I don't get any icons at the bottom right and i tried to install NET framework 4.0 again, but that changed nothing.
Is it a cearten directory i should have the the folder or anyhting else i could try?
|
On February 04 2012 13:59 Invasion wrote:Show nested quote +On February 04 2012 07:10 Sectorix wrote:
check in your system tray, it will appear as an icon.
( if its the first time you run it, it may ask you to download .NET framework 4.0 first from Microsoft )
I don't get any icons at the bottom right and i tried to install NET framework 4.0 again, but that changed nothing. Is it a cearten directory i should have the the folder or anyhting else i could try?
Did yoou check the instructions section of the post ? It also includes a video tutorial
|
On February 04 2012 17:11 Sectorix wrote:Show nested quote +On February 04 2012 13:59 Invasion wrote:On February 04 2012 07:10 Sectorix wrote:
check in your system tray, it will appear as an icon.
( if its the first time you run it, it may ask you to download .NET framework 4.0 first from Microsoft )
I don't get any icons at the bottom right and i tried to install NET framework 4.0 again, but that changed nothing. Is it a cearten directory i should have the the folder or anyhting else i could try? Did yoou check the instructions section of the post ? It also includes a video tutorial
I never get to start the program itself, there is no icon at the bottom right. When i go to folder and press SC2ReplayHandler.exe nothing happens
|
On February 05 2012 07:02 Invasion wrote:Show nested quote +On February 04 2012 17:11 Sectorix wrote:On February 04 2012 13:59 Invasion wrote:On February 04 2012 07:10 Sectorix wrote:
check in your system tray, it will appear as an icon.
( if its the first time you run it, it may ask you to download .NET framework 4.0 first from Microsoft )
I don't get any icons at the bottom right and i tried to install NET framework 4.0 again, but that changed nothing. Is it a cearten directory i should have the the folder or anyhting else i could try? Did yoou check the instructions section of the post ? It also includes a video tutorial I never get to start the program itself, there is no icon at the bottom right. When i go to folder and press SC2ReplayHandler.exe nothing happens
pm me, ill walk you through skype or smtg
|
Now i got it to work! much appreciation for the help Sectorix! now my replay folder should be clean :D
|
|
|
On February 23 2012 03:21 Inf1n1teabyss wrote:
execution failed
what failed ?
|
when i launch it just says execution failed
|
like its starts up fine but when i go to it in the panel and select run it says execution failed
|
On February 23 2012 20:15 Inf1n1teabyss wrote:
like its starts up fine but when i go to it in the panel and select run it says execution failed
"Execution Failed" message will come if the lookup folder does not exist. it means you didnt direct the Lookup Folder parameter correctly to point to your replay folder.
just as a reminder , this is usually the folder you are after : C:\Users\<YOUR USERNAME HERE>\Documents\StarCraft II\Accounts
|
Hi there.
I've been using this regularly over the past few months and finding it really useful, but it doesn't seem to work any more for Patch 1.5. (It says execution successful, but doesn't do anything with the 1.5 replays (I guess due to the format changes it doesn't recognise them or something)).
It would be awesome if it could be updated for the new patch.
|
im going to.. in weekend
|
Hopefully you have resolved the issue since im a great fan of the app
|
Any progress on the 1.5 version?
|
|
|
new replays not being renamed ? issue with the HotS replays ?
|
Hi, it takes a long "weekend" is there any progress on the 1.5 version?
|
I still get the following error:
"Invalid Input, or Non Existing Folders." Still no upgrade? :-/
|
|
|
|
|
|
EPT
