Change saved song file encoding to UTF-8 without BOM #428
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously the encoding was System.Text.Encoding.UTF8, which produces a BOM at the beginning of the saved file. Now it is a new System.Text.UTF8Encoding, which does not produce a BOM.
basisbit
approved these changes
Dec 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Currently Ultrastar Play song editor saves all song files as UTF-8 with BOM. This happens because in code the encoding is
System.Text.Encoding.UTF8, which produces a BOM according to documentation.This PR changes the encoding for saved song files to UTF-8 without BOM.
Closes Issue(s)
Motivation
The Ultrastar format specification was recently updated. It now specifies that all song files should use UTF-8 without BOM as their encoding. There are also tools in the Ultrastar ecosystem, such as Performous Composer, that fail to open song files with BOM.
There is some discussion about UTF-8 BOMs in this Ultrastar format issue UltraStar-Deluxe/format#42
More
Additional Notes
I have not tested this code. The change seems trivial enough that I'm confident it would work.