v210817.21

SC releases require .NET5(x86) runtime. Download & Install it from >>HERE<< (Microsoft site)

pp values are now updated with recent performance/star rating changes

Added:

• Tokens:
  • (updated) songSelectionScores - scores now also contain accuracy, grade & mods props
  • mapArtistTitleUnicode
• There are now 2 distributions of SC: setup and portable. Any existing SC installation can be "converted" to portable one by creating .portableMode file in SC install directory.
  While in portable mode SC will not auto-update, but it will still notify you about new releases.

Fixed:

• Default web overlays not rounding star rating value
• Map stats/pp values not being updated with modded values whenever DT/HT/HR/EZ was not enabled
• Missing mapId & mapSetId with old maps
• Map stats not always updating when song was changed and started right after

Misc:

• All live tokens are now not computed unless necessary(requested in web overlays or output patterns)
• All osu events are now processed after a short (350ms by default) delay. This reduces the amount of useless map processing whenever songs are quickly changed in song selection. This can be changed or disabled(set to 0) by editing ConserveCpuInterval in settings.ini
• Settings window was slightly redesigned
• Updated difficulty calculator with recent changes
• All internal pp values are now capped to 3 decimal places
• Text and browser ingame overlays will now automatically restart SC whenever either is toggled

v210710.12

SC releases require .NET5(x86) runtime. Download & Install it from >>HERE<< (Microsoft site)

web overlays breaking changes:

• With this release, custom web overlays depending on any value inside Web\lib\consts.js may end up broken. To fix this, you may need to update it to not directly use values defined inside, and instead use window.overlay object. For example: SC_BeatOsu used to directly access the global osuGrade variable, which was replaced with window.overlay.osuGrade.
• /skins & /songs web endpoints were renamed to /Skins & /Songs

Added:

• Accuracy in results screen is now available
• Browser overlay can now display multiple overlays at the same time
• Web overlays:
  • SC_URBar - round unstable rate component
  • SC_Template - basic template overlay displaying one token value
• Tokens:
  • state was renamed to rankedStatus - map ranked status, with is now read from osu memory
  • mapBreaks - array of map breaks (start/end time & if break has "arrow" animation ingame)
  • mapTimingPoints - array of map timing points (get bpm at specific map times)
  • currentBpm - bpm value at current map time (can be also calculated manually from above)
  • osu_97PP, osu_96PP, osu_m97PP, osu_m96PP - more nomod/modded pp ranges
  • modsEnum - raw mods number value
  • backgroundImageFileName - Filename of current map background
  • chatIsEnabled - 0/1 value indicating whenever ingame chat is visible or not
  • ingameInterfaceIsEnabled - 0/1 value indicating whenever ingame playing interface is visible or not (Shift+Tab when playing)
  • firstHitObjectTime - map time at with first hit object appears
  • keyOverlay - object representing current keyPress states for current play, pressed/count (K1,K2,M1,M2)
  • Song selection ranking related:
    • songSelectionRankingType - selected ranking type (local,global,country,friends,mods)
    • songSelectionTotalScores - total (server-side) scores count for selected ranking type
    • songSelectionScores - list of player score objects
    • songSelectionMainPlayerScore - top player score

Fixed:

• Issue where a diferent beatmap was loaded than one selected ingame (#152)
• Issues with reading score v2 on some PCs
• Browser overlay crashing with Steam overlay
• mStars token always showing star rating for osu gamemode, instead of the selected mode
• Star rating tokens being capped to 2 decimal places
• Slider ticks not being included in combo count used in pp calc, until slider has ended
• comboLeft token not being filled at the start of the beatmaps
• Small memory leak in osu event processing loop
• Handle failed browser overlay assets download instead of introducing crash-loop on failed download

Misc:

• SC beatmap cache was completely removed and replaced with live loaded maps(all data comes from local .osu files) (#293)
• Added support for additional overlays. See readme in Files/overlays/static for instructions
• Browser overlay now lists loaded modules before activating in order to help with potential application conflicts
• Log if SC is running as administrator at startup
• Ensure low memory footprint between map changes
• Bail early if gamemode read from memory is invalid instead of sending malformed osu event
• Log unknown osu! memory scenes

v210412.08

SC releases require .NET5(x86) runtime. Download & Install it from >>HERE<< (Microsoft site)

bugfix v3

Added:

• Tokens:
  • osuIsRunning - 0/1 value indicating if osu! is detected or not

Fixed:

• Crash when live loading really old .osu file versions(missing beatmapSetId, unicode title/artist etc...)

Misc:

• LeaderBoard MainPlayer data should be again updating at a normal, live rate
• Failing memory value reads are now logged

v210402.17

SC releases require .NET5(x86) runtime. Download & Install it from >>HERE<< (Microsoft site)

critical bugfix v2

Fixed:

• Disabled keyOverlay ingame breaking memory reads
• Flaky leaderboard reading(was breaking in some cases)

v210331.17

SC releases require .NET5(x86) runtime. Download & Install it from >>HERE<< (Microsoft site)

critical bugfix

Fixed:

• Play data(hitCounts, accuracy) not updating during gameplay
• Leaderboard data reading not being throttled

v210330.17

SC releases require .NET5(x86) runtime. Download & Install it from >>HERE<< (Microsoft site)

Added:

• Reading of score results screen data - whenever user enters results screen tokens that would normally update during gameplay, fill with data according to result screen values
  • Known issue: accuracy is not yet calculated
• Reading of leaderboard data in single & multi player, live tokens:
  • leaderBoardPlayers - Array of players listed on leaderboard - updates every 250ms (configurable in settings under MultiplayerLeaderBoardUpdateRate) in future this value will update only once per play in singleplayer, thus you should be using next token for current player data
  • leaderBoardMainPlayer - Object representing current player only in array above(subset) - "live" updates

Fixed:

• Reading of ScoreV2
• Gamma plugin was always enabled
• Reduced amount of flickering happening on some AMD cards in Browser ingameOverlay
• Browser/Text ingameOverlays crashing with discord/steam overlays
• Crash whenever performance calculator instance couldn't be initialized for whatever reason(not accessible/corrupted .osu file)
• Crash whenever map loading took more than 10s(another instance)
• Crash in browser overlay osu! process watchdog
• rather frequent shutdown crashes related to cancellation tokens
• Invalid validation for web overlay /backgroundImage crop parameter

Misc:

• Adjusted min-max values in gamma plugin
• SC will now attempt to continue to run whenever an exception is encountered in osu event source processing loop, and instead of crashing will silently report these to sentry

v210314.18

SC releases require .NET5(x86) runtime. Download & Install it from >>HERE<< (Microsoft site)

bugfix release

Added:

• Browser overlay now allows for inputting negative position values (drawing partially off-screen)
• 2 new functional HTTP endpoints:
  • /songs/ - list of folders/data inside user songs folder
  • /skins/ - list of folders/data inside user skins folder
• Tokens:
  • username - username of currently playing player

Fixed:

• Web overlays requiring browser cache to be cleared to see any changes(CTRL+F5)
• Return proper error code/message if no width or height are provided in backgroundImage http request with crop active instead of logging a non-crashing error
• Invalid Updater CPU platform (x64 instead of x86)
• Attempting to run both ingame overlays at the same time resulted in an osu! crash. Running both at the same time is now blocked.
• Incorrect mods being used for live pp calculation
• Crash in osu memory data provider(multi-threaded access to same memoryReader instance)
• Crash whenever an attempt was made to save more data than memory mapped file allowed for
• Crash on faulty prop memory read
• Crash whenever processing of beatmap via lazer took more than 10s
• Crash in settings window with multi-monitor setups using custom DPI settings
• Startup crash in ClickCounter

Misc:

• browserOverlay and ingameOverlay were renamed to BrowserIngameOverlay & TextIngameOverlay
• Decreased amount of allocated memory in memory mapped files for each output pattern from 15MB to 2MB

v210307.16

SC releases require .NET5(x86) runtime. Download & Install it from >>HERE<< (Microsoft site)

This release replaces now removed v210307.12 to deliver UR tokens hotfix

Added:

• Browser overlay plugin - display any web overlay inside osu! itself(even in fullscreen!) https://github.com/Piotrekol/StreamCompanion/wiki/9.-Ingame-browser-overlay
• Gamma plugin - brighten or darken your screen depending on current AR settings - disabled by default
• Tokens:
  • isBreakTime - live token, outputs 1 if map is in break section, otherwise 0
  • comboLeft - live token, how much combo is left in the beatmap
• BeatOsu web overlay

Fixed:

• Long maps freezing SC
• Strains not being affected by mods
• Changed test text in output patterns to contain numbers

Misc:

• 2 tokens were renamed:
  • osu_99.9PP=>osu_99_9PP
  • osu_m99.9PP=>osu_m99_9PP
• More optimization around pp calculator resulting in less memory/cpu usage

v210206.19

This and future SC releases require .NET5(x86) runtime. Download & Install it from >>HERE<< (Microsoft site)

Added:

• Full CTB mode support
• Updated pp with recent difficulty changes
• Tokens:
  • liveStarRating - star rating at current point in the beatmap

Fixed:

• Newly loaded beatmaps having -1 star rating/no bpm values
• Beatmaps sometimes not being identified right after loading them (map had to be re-selected ingame for SC to update)
• Beatmap length rounding issue in map example overlay

Misc:

• Ingame overlay plugin is now enabled right after installing
• Live pp values don't reset to 0 anymore when switching maps
• MSN is now deprecated and disabled by default

v201222.19

Fixed:

• Crash when writing to memory-mapped files with more data than its max capacity
• Crash whenever any websocket exception appeared
• Crash while extracting background image name from corrupted .osu file
• Random crashes in GDI+ while generating mods image
• Crash whenever logs write attempt failed for whatever reason
• Crash whenever SC was closed before map loading has started
• Silent non-crashing error whenever memory reader returned corrupted song string, with was then sometimes used in map search

Misc:

• Logs(with are always enabled since last release) are automatically removed after 14days on startup