-
Or run the script with Python 3.8+:
pip install -r requirements.txt
python SCO.py
The app shows an overlay with replay analysis of StarCraft II Co-op games. It also provides match history, various statistics based on your replays, commander randomizer, info about players shown at the start of the game, custom twitch bot with game integration into MM maps, and more.
For streamers the the overlay can be added as another layer in Open Broadcaster Software (OBS) or other streaming software applications. It's fully customizable through simple editing of the HTML, CSS and JS files.
For bugs, feedback and suggestions check my discord.
Info shown after a game:
Info shown at the start of a game:
- Extract the archive
- Run the executable (SCO.exe)
- Some anti-virus programs are very sensitive to packaged python apps. If you have issues, add an exception to your anti-virus for the directory the app is in.
- Use hotkeys or buttons in the app to control the overlay. It will show automatically after each game as well.
- In StarCraft II set display mode to Windowed fullscreen (borderless)
To exit the app right click the icon in the system tray and click "Quit".
If you are using game capture, you have to add overlay to OBS manually.
Settings:
Settings (Dark theme):
List of games you recently played:
List of players you played with:
Map statistics:
Statistics for your and allied commanders:
Unit statistics:
Commander randomizer:
Twitch chat overlay:
Performance overlay:
- The overlay targets Windows 10. It might not work correctly on older versions of windows (black background under overlay). On Windows 7 enable aero theme and set “Enable Transparency” in “Window Color”.
- On MacOS or Linux run the script with "
sudo python3 SCO.py" after installing required packages. It has been successfully tested on both MacOS and Linux, however every distribution and OS version has its own quirks. - The app connects to the internet only at start to look for a new version, or if you setup automatic replay upload by filling in accout name and password.
- The app is not in conflict with Blizzard's Terms of Service. It uses official Blizzard's library (s2protocol) to parse replays, and what information StarCraft II provides while running.
- You can edit the layout .html file. Changing its style through CSS (custom.css) or other functionality with javascript (custom.js).
- Indirectly killed Interceptors are counted towards player kills which is not the case in kills showed in-game. Directly killed interceptors are counted in both cases.
For customization locate custom.css and custom.js in the overlay folder (in Layouts/). These files contain your customization and are not overridden when the the overlay updates.
1. Change the number of units shown
Add this to custom.js and change the value. Higher numbers might overlap with other elements or won't fit onscreen.
maxUnits = 5;2. Hide bars under units
Add this to custom.css
.unitkillbg {
opacity: 0;
}3. Hide certain charts
Add this to custom.js, and remove those that you don't want.
CC = {
'army': null,
'supply': null,
'killed': null,
'mining': null
}4. Custom function that runs when new replay data is filled
Add something like this to custom.js. The function will run when new data is added.
func_on_new_data = function some_function_name(data) {
// This shows you what's the structure of replay data (can be removed)
for(var key in data) {
console.log(key + ":\t\t" + data[key] + "\t\t")
}
}-
2.43 version
- Bug fixes -
2.42 version
- Bug fixes -
2.41 version
- Player tab shows different stats for different player handles with the same name - Player tab shows the time since last game for each player handle - Bonus objectives are shown as (completed/total) instead of times when they were completed - New games and players are automatically added when scrolling to the end of game/player tab - During update the app checks the hash of the downloaded archive - App now complied with [Nuitka](https://nuitka.net/) - Visual tweaks & bug fixes - Updated packages -
2.40 version
- App is no longer compressed into one big executable. This will make app start faster - Initial and full replay analyses run on all available CPU cores - Mutators are parsed for weekly mutations and retries in Brutal+ - Maps & commanders in stats can be sorted by name and other stats by clicking on headers - Added a button that creates a desktop shortcut - Fast expand hints are shown on the correct monitor - Taskbar progression indicator for mass replay analyses - Various tweaks and fixes -
2.39 version
- Overlay shows how long it was since the last game with your ally - You can filter games with a specific ally in the statistics tab - The number of missiles killed during Missile Command mutator is shown as icon - Fixes for multi-monitor setups - Unique player handles are shown in tooltips for players in the games tab - Various tweaks and fixes -
2.38 version
- Fix for websockets -
2.37 version
- The number of locust and broodlings created is shown in icons - Amon unit bar scaled to be comparable with player kills - Counting kills towards the main player when the ally leaves - Users can define custom javascript function that runs when new data is added (defined in custom.js) - Various tweaks and fixes -
2.36 version
- Added graphs for army value, used supply, kills, mining rate - Bars under units show relative number of kills. These can be compared between commanders. - Abathur P3 correctly identified - Many fixes for unit counting - Minor tweaks and fixes -
2.35 version
- Fast expand hints for certain maps and commanders - Manual parsing of selected replay files - Unlocked prestiges shown instead of tried prestiges - Enemy scarabs not counting to player kills - Minor tweaks and fixes -
2.34 version
- Fixed a crash when launching the app - Unit frequency shown in unit stats - Successful weekly mutation shown in green color - Weekly mutation can be filtered in the game tab by using 'weekly' or 'mutation' keywords - ESO is the default fallback for Mengsk when there is no killing unit - Small fixes and tweaks -
2.33 version
- Median kill percentage calculated for players - Median kills and APM showed with player info - Color tweaks - Safer loading of settings - Small fixes and tweaks -
2.32 version
- Dark theme added - Chat history shows when a player has left the game - Overlay shows if you did the mission in your personal best time - Added option to disable app going into tray - Small fixes and tweaks -
2.31 version
- Reduced RAM usage - Merged cache files into one - Minor fixes and tweaks -
2.30 version
- Chat log shows when a player pings - Added a new checkbox "override folder selection" which forces showing stats for all replays regardless of a selected folder - All data can be dumped to a json file - Fixed stats for certain Abathur morphs - Kills from Glevig's and Murvar's spawns count toward Primal Pack Leaders - Kills from Broodlings count towards Kerrigan's & Stetmann's Brood Lords - Screenshot height fix - Fixed crashes during full analysis - Full analysis won't parse replays from the last session again - Added an option to custom javascript modification (in custom.js) to show units without kills -
2.29 version
- Easier bank management for twitch integration - Fixed stats for Primal Mutalisk -
2.28 version
- Overlay won't show in games where no commanders were found - Fixed a bug with mutator identification - Updated libraries -
2.27 version
- Fixed duration setting not working properly - Fixed monitor setting not working properly - Updated s2protocol -
2.26 version
- Bug fixes and tweaks -
2.25 version
- Counted the total number of mind-controlled units - Fix for mutator identification - Number of games shown in unit stats - Updated s2protocol -
2.24 version
- Fix for mutator identification -
2.23 version
- Mutators identified in custom mutators and MM maps - custom.js and custom.css are not overriden after an update - Weekly mutations and custom mutators shows difficulty - Small fixes and tweaks -
2.22 version
- Player kills limited to Amons units - Amon kills limited to player units - SC2 process isn't checked when overlay is not visible - Mengsk Prestige 3 kills properly counted - Swann's Siege Tank and Thor and Kerrigan's Torrasque losses counted properly - Twitch bot won't fail when the channel name is capitalized - Better identification for bonus objective completion on Malwarfare - Small tweaks and fixes -
2.20 version
- Twitch bot works now with after filling up the channel name - Twitch chat available as overlay - You can search through replays - New performance monitoring available as overlay - Salvaged units aren't counted as losses - Improved scaling for high DPI displays - App cannot be started multiple times - Small tweaks and fixes -
2.10 version
- Frequency added to maps - Maps can be sorted - Last ally showed in the player tab on top and is colored - Checkbox for showing/hiding session information - Randomized commander & prestige can be shown on the overlay - Part and Parcel bonus identification fixed - More replays are parsed successfully - More accurate replay analysis - Player info doesn't show for versus games - Option for full analysis added. Running it will take long time, but it will provide more accurate game lengths and more stats - Added new stats related to player and unit kills, and bonus objective completion. These require full analysis - Default hotkeys changed to be less likely pressed by accident - Fancy changelog -
2.00 version
- Revamped interface (settings, game list, player list, stats, links) - Integrated commander & map randomizer - Integrated control for twitch both to connect to MM maps - Bonus objectives show when they have been completed - Easy updating to new versions - App will survive sleep & awake better - Fixes for certain bugs causing crashes and unreponsivness - New hotkey to show player winrates - Map name is always reported in English - Improved replay analysis for non-english replays - Updated for Zagara mastery changes - Abathur's Swarm Hosts show kills separate from normal Locusts - Artanis top bar kill counts are more accurate, Unbound Fanatics count towards the top bar - Many other tweaks and fixes -
1.18 version
- Commander images are shown in the background of the killbar - In mixed difficulties, the order reflects which player queued for what difficulty - On MM maps commander level isn't shown as 1 - Minor fixes and tweaks -
1.17 version
- You can add notes to players that will show together with the winrate and games played - H&H Mag-mines are shown separately and kills are correctly counted - Fixed random enemy units showing in your units stats - Fixed respawning heroes showing one more death and creation - Fixed player winrate data occasionally showing for the previous player - Fixed player winrate showing in menus - Fixed some issues with primal combat and morphs - Minor fixes and tweaks -
1.16 version
- Masteries show only when players have them - Showing all difficulties (Casual/Normal/Hard/Brutal) - Showing commander level if it's under 15 - Fixed various issues preventing the app from working - Visual tweaks - Updated s2protocol -
1.15 version
- Support for prestige talents - Showing Strike Platforms built, Unbound Archons created, and Artifacts collected - At the start of each game, the app can show the number of games with your ally and winrate - Better player name guess with above activated - Small visual tweaks - Parser is now using just s2protocol to parse replays - Better behavior when write permissions are denied by antivirus -
1.14 version
- The number of created Infested Bunkers and Mecha Infestors is shown as icons - Gary won't show created and lost numbers as they are not accurate (as with Tychus' outlaws) - Odin's precursor no longer counted for created & lost numbers - Perdition and Devastation Turrets renamed to Flaming Betties and Blaster Billies - Easier customization via separate CSS and JS files for custom modifications - Internal reorganization of dictionaries, and many comments added to the code - Proper HH:MM:SS format for game length for games over 60 minutes - Minor visual tweaks -
1.13 version
- Additional icons showing structures destroyed on Dead of Night and certain mutator kills: Void Rifts, Propagators, Void Reanimators, Turkeys, Mines, HftS & TUS, units sacrified to Killbots - APM rescaled according to accurate replay length - Stats no longer contain events that happened during victory cutscenes (e.g. Cradle of Death) - Tweaks to replay analysis (Nova airstrike,...) -
1.12 version
- Masteries identified in [MM] maps - Automatic identification of preferred players if none are specified - Game length more accurate and close to speedrunning times instead of the replay length - Better way to find documents folder - Tweaks to enemy composition identification - Small fixes for replay analysis in custom mutations -
1.11 version
- Identifying enemy unit composition (best guess) - By default there is a single key to show/hide overlay (possible to change by user) - Minor graphical tweaks -
1.10 version
- Multimonitor support - Showing Outlaw order for Tychus - Start up notification shows hotkeys and if an update is available - Shows games even without any kills -
1.9 version
- It's now possible to view analysis of older replays and switch between them freely - Fixed the issue where the replay folder wasn't located correctly on certain systems - Replay analysis tweaked for more accurate stats - Overlay shows map played & winrate in the current session - Minor graphical tweaks - Small tweaks to sc2reader module to prevent load fails -
1.8 version
- Replay analysis tweaks and improvements - Start up notification - Better logging - Bug fixes -
1.7 version
- Colors can be changed via the config file - Bug fixes -
1.6 version
- Replays can be automatically uploaded to https://starcraft2coop.com -
1.0 – 1.5 initial versions
Twitch bot can be set up in this way. bot_oauth has to be generated by twitch for example here. It's also possible to change in the config file greetings, banned units and mutators, and reponses to user commands.
"twitchbot": {
"channel_name": "fluffymaguro",
"bot_name": "veryfluffybot",
"bot_oauth": "oauth:r8b5...............",
"bank_locations": {
"Default": "C:/Users/Maguro/Documents/StarCraft II/Accounts/114803619/1-S2-1-4189373/Banks/1-S2-1-4189373/MMTwitchIntegration.SC2Bank",
"Local": "C:/Users/Maguro/Documents/StarCraft II/Banks/MMTwitchIntegration.SC2Bank",
"EU": "C:/Users/Maguro/Documents/StarCraft II/Accounts/452875987/2-S2-1-7503439/Banks/2-S2-1-1174830/MMTwitchIntegration.SC2Bank"
},
...
}
You can change the offset from the right side of the monitor. Negative values mean more to the left.
"right_offset": 0,
You can change the font size by a relative scaling factor. Default is 1.
"font_scale": 1,