ppy / osu

rhythm is just a *click* away!
https://osu.ppy.sh
MIT License
15.53k stars 2.31k forks source link

Ruleset API breaking changes / announcements #19068

Closed peppy closed 9 months ago

peppy commented 2 years ago

This issue is intended to be a place custom ruleset developers can subscribe to so we can forward critical information on incoming breaking changes (or convey error reports we are seeing) to avoid breakage.

While this thread will be locked to keep traffic low, if you have any concerns about changes in this thread, or need further help, please don't hesitate to open a new issue or discussion!

cc/ @LumpBloom7 @Beamographic @taulazer @EVAST9919 @andy840119 @swoolcock

peppy commented 2 years ago

Please check in on https://github.com/ppy/osu/pull/19066 (NRT nullable support being added to the Ruleset class). While not finalised yet, it would be good to cross-check and bring any concerns to light before it is merged. It may also be a good opportunity to make other breaking changes, if there are any outstanding requests.

peppy commented 2 years ago

A few updates here:

I am in the process of adding ruleset versioning, which will initially be opt in, but may become a requirement at some point. Will leave another message here when that is ready. It should avoid all game crashes surrounding breaking changes (by not loading the ruleset in the first place unless it's up-to-date).

Joehuu commented 9 months ago

Unpinning for now because of no new updates since 2022. Can be converted to an "announcement" discussion instead as it's a better fit there.