github ppy/osu-framework 2022.223.0

latest releases: 2024.423.0, 2024.419.0, 2024.418.0...
2 years ago

Thanks for following along! This is a tagged release (2022.223.0).

Breaking Changes

Visual test projects now use native .NET 6 "Hot reload"

Over the years we have maintained our own version of hot reload, affectionately named "dynamic compilation". Even after multiple complete rewrites of the system, there are still edge cases where it will unexpectedly fall over due to being too greedy in including what it considers required for the recompile.

The startup cost when running in debug was considerable (around 10-30s initialisation) and the first-compile overhead could also be high (5-60s). In addition, the dependencies required to make it work increased the final assembly size of osu!framework, even for release deploys.

With the introduction of cross-platform support for hot reload in .NET 6 we have made the decision to switch to the natively supported version.

To use this new version:

  • From Rider, you'll get a popup that you have to click "Apply Changes" when a change is made to code while running. You can bind a key to Apply Hot Reload Changes in Rider (defaults to Alt+F10) to make it quicker to apply changes.
  • Running dotnet watch from CLI on your test project will automatically watch files and recompile when a hange is seen.

New limitations:

  • The limitations of hot reload are listed here.
  • Notably, adding new override methods or classes are not supported. You can workaround this for the common scenario of prototyping new components by creating subclasses and adding the override methods before the initial hot reload.

We are interested in hearing feedback on this change, especially troubling cases where the previous behaviour worked better for you. Hope is that the limitations of the new method are outweighed by the leaner assembly, better performance, and (in general) up-front error when a change can't be applied, rather than an error that can be delayed longer than it would take to run a full recompile/restart.

What's Changed

  • Ban MSBuild assembly from dynamic class compiling by @smoogipoo in #5040
  • Round test video corners when using rounded shader by @smoogipoo in #5042
  • Replace manual dynamic compilation with .NET Hot Reload by @smoogipoo in #5041
  • Fix crash in SafeAreaContainer when working with negative sizing by @peppy in #5047
  • Update FFmpeg libraries with LGPL versions and move out macOS dylibs to osx for arm64 support by @nekodex in #5043
  • Fix sub-menu getting an invalid position when parent menu is transferred to another drawable by @smoogipoo in #5049
  • Allow Alt+Enter to still toggle fullscreen when a textbox is focused by @peppy in #5048
  • Add a way to exit/minimize the app on Android when back is pressed by @Susko3 in #5044

Full Changelog: 2022.217.0...2022.223.0

Don't miss a new osu-framework release

NewReleases is sending notifications on new releases.