38 Commits

• Fix legacy beatmap export dropping background specification (#37892)

  - Closes https://github.com/ppy/osu/issues/37884
  - Closes https://github.com/ppy/osu/pull/37890
  
  Due to lack of population of `Storyboard.Beatmap` and
  `Storyboard.BeatmapInfo` post-decoding, `LegacyBeatmapExporter` would
  completely drop background specifications on exported beatmap packages.
  This affects both direct legacy export to file (`.osz`) as well as
  beatmap submission.
  
  I will not pretend that the API here is optimal but I do not see very
  easy opportunities to curtail misuse. Storyboards can be treated as
  either parts of a beatmap or standalone entities, and if a requirement
  is added to forcibly provide a beatmap and its info when encoding out a
  storyboard, I also foresee a requirement to bypass this later when
  design mode is implemented, which would be a return to square one.
  
  There is likely room for cleanup around `Storyboard` to maybe make this
  nicer (remove passing of both `Beatmap` and `BeatmapInfo` and just pass
  `Beatmap` instead, maybe shuffle some properties from `Beatmap` to
  `Storyboard` to remove the requirement of having to bolt the beatmap on
  to begin with). I leave voicing opinions on that, and how soon that
  should be done, to reviewers. My primary intent at this time is to
  hotfix a major issue in a released build.
  
  The external editing feature is not involved in this bug and any
  attempts to claim so are misdirections.

  Bartłomiej Dach · 2026-05-24 20:55:53 +09:00
  d89d6ed13f
• Add legacy storyboard encoder (#37790)

  - Closes https://github.com/ppy/osu/issues/37757
  
  Commit-by-commit reading is recommended. Commits will be split to PRs on
  request but I consider this to be the minimal viable functional
  increment.
  
  ## Done
  
  - This adds a first version of a full storyboard encoder
  (a66dc406f498e35d4e0c8f2a462e946a9a1aeccc). I expect there to be hiccups
  due to weird corners of the `.osb` format; this is only intended to be
  somewhat correct as a start to build upon. Storyboarders are asked to
  file issues as necessary.
  - Due to the fact that storyboard definitions can reside both in the
  `.osu` and the `.osb`, b60698a95c4de1bfeb36fbb159fd5a6028920832 adds the
  required storage to be able to tell which storyboard element lives
  where, so that it can be decoded properly later.
  - In c9d3e04a4135886b5b0943c85f3cc6f4fe99c84c, the storyboard decoder is
  weaved into the beatmap decoder to handle the `.osu` part of the
  storyboard, via the
  `LegacyStoryboardEncoder.Encode{General,Events}ToBeatmap()` methods. For
  `.osb`s, `LegacyStoryboardEncoder.EncodeStandaloneStoryboard()` is
  intended, but for now is not used outside tests.
  - Because of the above, dd1c4e43dc51154cd67860f096712f8b4f229661 removes
  `Beatmap.UnhandledEventLines` as no longer required.
  - 26ac417ed98a8937c42e5f52c4e15ef065a48902 adds tests. They are mostly
  handwritten to ensure basic encode-decode roundtripping. Using existing
  storyboards is difficult, see "Known issues" section as to why.
  - 5cc542366db7caac38eb0729260d884905a2c0d5 fixes a bug in the storyboard
  decoder where the trigger group number was not properly negated on
  decode (see inline comment reference to relevant stable code).
  
  ## Known issues
  
  - Any and all variables in the `[Variables]` section are inlined into
  their usages by `LegacyStoryboardDecoder`, and as such
  `LegacyStoryboardEncoder` will end up inlining them and discarding the
  `[Variables]` section. As far as I can tell stable will also do this.
  - `LegacyStoryboardDecoder` splits all `M` (move) commands into
  `MX`/`MY` commands. Therefore, `LegacyStoryboardEncoder` will write out
  things in the same split way. I did not put in effort to attempt to
  reconcile this, for reasons of part laziness, part not wanting to bloat
  this already-large diff.
  - Ordering of storyboard samples on decode may not match the order on
  decode. I'm crossing fingers this doesn't matter.

  Bartłomiej Dach · 2026-05-20 17:46:51 +09:00
  0e443b1c47
• Clamp grid size when exporting for stable (#37094)

  Closes https://github.com/ppy/osu/issues/36990.

  Dean Herbert · 2026-03-25 18:13:42 +09:00
  bddfc993af
• Fix compatibility export using platform-dependent line endings (#37051)

  The compatibility export was creating .osu files with CRLF line endings
  on Windows and LF line endings on Linux/macOS, because StreamWriter
  defaults to Environment.NewLine.
  
  This caused the server to detect spurious file changes when a mapper
  alternated between platforms, leading to unnecessary wipes of local
  scores and noise in the beatmap update history.
  
  Fix by explicitly setting NewLine = "\r\n" on the StreamWriter, ensuring
  CRLF is always used regardless of platform.
  
  Closes #36846
  
  ---------
  
  Co-authored-by: Dean Herbert <pe@ppy.sh>

  antfaia · 2026-03-23 17:04:41 +09:00
  f73807919a
• Add localisation support for some more notifications (#36353)

  Co-authored-by: Dean Herbert <pe@ppy.sh>

  Denis Titovets · 2026-01-16 22:58:20 +09:00
  06b89919be
• Add explicit menu item for exporting guest difficulties from editor

  A few facts of life:
  
  - Guest difficulties are at this point a staple of mapping.
  
  - People are very much used to flinging `.osu`s around (because there's
    no better alternative).
  
  - Currently there are two ways to get an `.osu` out of lazer. You can:
  
    - Export the beatmap as "compatibility" to an `.osz`, then
      transmogrify the `.osz` to a `.zip`, then extract the `.zip`, then
      pluck out the `.osu`. This is the "correct" way to make sure stable
      works, but is also stupidly arcane.
  
    - Use "edit externally" to mount the beatmap files to disk, then
      copy-paste out the `.osu`. This is the *wrong* way to make sure
      stable works, because the mounting process exposes the raw "for
      editing" format with features stable doesn't support, but it the
      actual easy one.
  
  - Reports about guest difficulties exported from lazer "working wrong on
    stable" are prevalent. Probably mostly because of the preceding point.
  
  What this PR does is introduce a *third* method to export an `.osu`,
  which is designed to be both the easiest one yet *and* correct. I am
  hoping this will curb the complaints until support for direct submission
  of guest difficulties is added - which I still hope to see, but it will
  be a significant effort *client-side* (the server side has been ready
  for years now).
  
  And yes, you will notice that much of the code added in
  `LegacyBeatmapExporter` related to manipulation of the path is
  copy-pasted from `LegacyExporter`. I don't care enough to invent
  protected / abstract / whatever else OOP faff for something that may not
  survive review and is mostly a weird semi-temporary wart.

  Bartłomiej Dach · 2025-12-22 11:36:23 +01:00
  3712093158
• Use MathF instead of casting
  Bartłomiej Dach · 2025-10-17 08:44:58 +02:00
  8f8f605748
• Fix code quality
  Bartłomiej Dach · 2025-10-17 08:44:30 +02:00
  5f9ade6610
• Also round slider control points to integer positions if it has less than 2 segments
  kennyaja · 2025-10-16 19:25:43 +07:00
  cf1834b080
• Round instead of truncating slider control points to integer positions
  kennyaja · 2025-10-16 14:44:44 +07:00
  3fbe777f33
• Implement special exporter intended specifically for submission flows
  Bartłomiej Dach · 2025-02-05 14:01:37 +01:00
  fff99a8b40
• Do not double up first control point of path
  Bartłomiej Dach · 2025-01-31 09:01:42 +01:00
  20280cd195
• Move control point double-up logic to LegacyBeatmapExporter

  Done for two reasons:
  
  - During review it was requested for the logic to be moved out of
    `BezierConverter` as `BezierConverter` was intended to produce
    "lazer style" sliders with per-control-point curve types,
    as a future usability / code layering concern.
  
  - It is also relevant for encode-decode stability. With how the logic
    was structured between the Bezier converter and the legacy beatmap
    encoder, the encoder would leave behind per-control-point Bezier curve
    specs that stable ignored, but subsequent encodes and decodes in lazer
    would end up multiplying the doubled-up control points ad nauseam.
    Instead, it is sufficient to only specify the curve type for the
    head control point as Bezier, not specify any further curve types
    later on, and instead just keep the double-up-control-point for new
    implicit segment logic which is enough to make stable cooperate
    (and also as close to outputting the slider exactly as stable would
    have produced it as we've ever been)

  Bartłomiej Dach · 2025-01-30 15:28:47 +01:00
  b4f63da048
• Round object coordinates to nearest integers rather than truncating

  Addresses https://github.com/ppy/osu/issues/31256.

  Bartłomiej Dach · 2024-12-27 11:10:29 +01:00
  e9762422b3
• Fix timing point truncation in legacy beatmap export
  OliBomby · 2024-11-13 14:23:28 +01:00
  b6eff38520
• Truncate break times for legacy beatmap export
  Dan Balasescu · 2024-06-26 16:20:56 +09:00
  276d8fe158
• Fix incorrect legacy conversion when B-splines are used
  Bartłomiej Dach · 2023-11-20 15:08:58 +09:00
  6d7d826b8b
• Generalize Bezier curves to BSplines of Nth degree
  Thomas Müller-Höhne · 2023-11-11 13:32:53 +01:00
  926636cc03
• Replace inline comment with actual explanation of what's happening
  Bartłomiej Dach · 2023-08-21 07:27:02 +02:00
  a942b6ff74
• fix The last slider point has effect on previous inherited
  OliBomby · 2023-08-16 16:44:08 +02:00
  8686b6b1e6
• Fix LegacyBeatmapExporter not converting beatmap between decode and re-encode
  Bartłomiej Dach · 2023-08-12 00:50:31 +02:00
  253392409e
• fix skin using wrong stream
  OliBomby · 2023-07-18 13:08:05 +02:00
  e7a9175aea
• use base.GetFileContents to get file stream
  OliBomby · 2023-07-18 12:40:48 +02:00
  63dd8bd991
• truncate end time before start time
  OliBomby · 2023-07-18 12:28:35 +02:00
  bcdf531039
• truncate hit object end time
  OliBomby · 2023-07-18 12:18:43 +02:00
  c02684d985
• Move all conversion code to LegacyBeatmapExporter
  OliBomby · 2023-07-13 00:20:01 +02:00
  1d837a8725
• Add xmldoc to clarify the purpose of BeatmapExporter
  OliBomby · 2023-07-12 14:49:49 +02:00
  465cc759f0
• Mark exporter extensions as untranslatable
  Bartłomiej Dach · 2023-05-06 19:42:28 +02:00
  510484011c
• use Live<TModel>

  Use RealmAccess only when needed

  cdwcgt · 2023-04-09 22:21:15 +09:00
  de21b4a2f7
• change abstract implement
  cdwcgt · 2022-12-15 21:39:48 +09:00
  6900d0120a
• Group export methods into their respective managers
  cdwcgt · 2022-12-11 18:30:24 +09:00
  e02b8cb199
• refactor based on reviews

  removed LegacyExportManager
  
  Separated the method of CreateZip method and the default export method

  cdwcgt · 2022-11-21 18:58:01 +09:00
  e37d30a373
• working with test
  cdwcgt · 2022-11-19 01:02:35 +09:00
  fc4a6cb125
• add LegacyExportManager
  cdwcgt · 2022-11-18 20:00:00 +09:00
  4b29941b47
• create a task to export to avoid block main thread

  Code quality and remove some #nullable disable

  cdwcgt · 2022-11-17 01:08:06 +09:00
  e1a21e0cf9
• Automated #nullable processing
  Dan Balasescu · 2022-06-17 16:37:17 +09:00
  f8830c6850
• Remove unnecessary manager parameter

  Confused why I added this in the first place..

  Dean Herbert · 2021-11-25 18:36:03 +09:00
  e2ebcf7a26
• Split out legacy model export logic into LegacyModelExporter classes
  Dean Herbert · 2021-11-25 16:41:12 +09:00
  cc1b91e4bd