A simple GUI application to sort and rename replay files from the popular RTS game starcraft brood war. There is also an (outdated) console version that is unfortunately not written with the linux philosophy in mind.
After an optional installation, run the .exe file (ending in .UI for the GUI or without .UI for the console). Provide a directory containing your replays and it will try to parse all the replays, and allow you to both rename them according to a custom format, and order them in a mapping hierarchy.
IMPORTANT: Due to the presence of some bugs and it being hard to verify edge case behavior, I suggest not working on your original replay folder but instead always making a copy and working on that one!
-
Playername
You can specify whether to make folders for winner-only, loser-only, both or none (this latter essentially allows you to extract/copy all replays from a directory tree, and rename them according to a custom format).
-
Map
-
Duration
You can specify your own intervals.
5 10 30will result in the intervals 0-5min, 5-10min, 10-30min, and 30+min. -
Matchup
You can specify which gametypes you want to include since it might not be so useful to know the "matchup" for a UMS game.
-
Gametype
Finally it is possible to combine multiple sort criteria. For example map playername will sort your replays first on the map the game was played on, and then create additional folders per playername within the map folder.
In case you just want to rename your replays, check out the next section.
This release includes support for direct renaming of replays after parsing. You can do any of the following:
- After sorting you decide you wanted to rename your replays? Use the rename last sort option.
- You want to rename the replays inside the folder you've parsed? Use rename in place.
- You want to copy all replays to another directory and rename them? Specify an output directory and rename!
Currently you will get a warning if you try to rename in place after sorting or renaming to an output directory. This is to warn you that you will not be able to rename the last sort, or undo a rename any more. To continue, you have to "restore replay names". Be careful however! See remarks and known issues.
It is also possible to "undo" (see clarification below) your last renaming action, whether it was a rename in place, a rename last sort, or a rename to another directory.
To clarify:
- Restoring replays is an interal operation you can do if stuff isn't working any more. This precludes having to parse replays again from scratch. Generally you shouldn't need it unless you decide you want to do a rename in place after a sort or rename to output directory.
- However do not use restore after "rename in place" because you will have to parse again and won't be able to undo the rename since it won't be able to find the replay files any more!
- Undo last rename is badly named. It restores the replay names to whatever they were when you parsed them.
The current syntax is quite sensitive, so be careful to not include any unnecessary spaces anywhere. The syntax consists of:
- T[separator] with separator being a single character (for example
,or_). This will extract the teams from the replay and separate individual players per team using the separator. - WT[separator] only extracts the winning team.
- LT[separator] only extracts the losing team.
- MU gets the matchup.
- M gets the map.
- DU gets the game length.
- D gets the date the game was played on.
- WR extracts the winning race.
- LR extracts the losing race.
You have to use vertical bars | to separate arguments. So for example:
For a replay with the following characteristics: +
DU|M|WT[_]: will give a replay of the format:15min13sFightingSpirit(CrispyDrone_Jaedong).repD|MU|M|DU: will give a replay of the format:11-03-19ZZvsTTFightingSpirit15min13s.rep
Currently there are 3 ways to get the program:
- Use the setup.exe installer from .rar archive
- Use the non-setup based .exe from the .rar archive labelled as such
- Compile from source
You can find the latest release here: https://github.com/CrispyDrone/BWSort/releases/tag/v0.9
- Do NOT use restore after "rename in place". It will force you to reparse the replays and you won't be able to undo the renaming. Restore is for when the program for some reason doesn't seem to work any more. Or you want to rename your replays in place after sorting or renaming to an output directory.
- For now only 1.18 or later replays are supported. I was looking into a way to decompress the PKWARE compressed replay files, but the algorithm used in other parsers didn't make much sense to me. If anyone wants to help me implement this, feel free to contact me.
- There will be errors for certain criteria like playername. If you specify to make a folder for the winner or for both, but the replay doesn't have a winner, it'll show an error.
- Another common error is the "unable to distinguish player from observer", which means that not a single player did a build, unit training, or unit morph action. In most cases, this is a replay of a few seconds long where no player did anything, so you can safely ignore these too.
- If a replay shows up in a non-terminal folder (in case of multipe sort criteria), this means one of the errors as mentioned above occurred, meaning it was impossible to determine the winner, the matchup,...
- When using multiple sort criteria (nested sort), the sort folder's name will not be in the correct order.
- The order of the matchup from a replay, and using the T[] argument, will not necessarily be the same (so it could say ZvP, while the first player is the protoss, and the second one the zerg)
- When using nested sorting, it creates an intermediary folder for each sort criteria, instead of directly adding the result folders. For example: map duration will create the following folders Map,Duration => Fighting spirit => duration => 0-10m instead of Map,Duration => Fighting spirit => 0-10m
- Teams aren't extracted properly because for most game types the team number is the same for opposing teams... I think I do know a way to fix this.
- Restore after "rename in place" will force you to reparse replays.
For users:
- Support to search replays based on criteria, and then select the filtered replays to perform a sort or renaming action.
- Improved GUI, more intuitive with more features
- Unix style console application accepting parameters instead of acting like a wizard.
- Trying to improve the parsing algorithm which will mean more reliable sorting and renaming
- Support for 1.16 replays
- Fixing team extraction (this will also fix matchups not being determined properly)
- Bug fixing
For my reputation:
- A complete rewrite from scratch with a much better designed codebase. I started this project roughly 1.5 months after I had started programming. Many of the important design decisions were made during this period when I had no experience with writing bigger projects.
- Added support for renaming replays without sorting.
- Rename replays in place
- Rename the last sort
- Rename replays to an output directory
- Added support to "undo" (i.e. reset) replay names to their originals at time of parsing.
- Fixed major issue with nested sorts resulting in replays being sorted into the wrong folder, and receiving the wrong names.
- Added a simple graphical user interface
- Fixed issue with wrong replays being sorted/renamed in case you opted to not move replays that encountered errors during parsing.
- Added the possibility to specify output directories for "bad replays" and sorting.
First release:
- Sort replays according to criteria, and optionally rename them according to a custom format.
Many thanks to SimplySerenity for porting the replay parser to C#. You can find the original project here: https://github.com/SimplySerenity/SCReplayFileParser