-
Notifications
You must be signed in to change notification settings - Fork 175
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Map Format Rework #579
Merged
Merged
Map Format Rework #579
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
XAce1337manX
reviewed
Mar 9, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Content looks good. Just a few typos and a note.
Co-authored-by: Bullet <[email protected]>
bloodcloak
approved these changes
Mar 10, 2024
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.
This PR overhauls the entire Map Format section of the wiki, providing a new structure and better organizational flow for content. The motivation is to make it easier for future maintainers to accommodate future changes to the schema and allow developers to better understand the semantics and relationships between versions.
Early documentation is also available for the v4 schema as introduced in 1.34.5, based on current knowledge from internal testing and clarifications from community members and official developers.
A preview deployment is available below if you'd like to preview all changes in action:
https://officialmech.github.io/wiki/mapping/map-format.html
I've summarized the main changes below, but if you have any additional questions or amendments that are necessary before merging feel free to let me know or request changes if necessary.
Summary
vitepress
) are used to visually illustrate the changes between schemas. The intent is for the developer to be able to better identify the relationships between the different schemas, such that each snippet would ideally produce the same result when building wrappers or compatibility layers.Warning
There will most certainly be dead links in this PR that will need to be updated in external services, so if needed you can use the following conversions to handle redirects if necessary:
/mapping/infodat-format
->/mapping/map-format/info
/mapping/difficulty-format-v2
->/mapping/map-format/beatmap
/mapping/difficulty-format-v3
->/mapping/map-format/beatmap
Other Changes
vitepress-plugin-tabs
was added as a dependency and configured for the project. The plugin allows you to define tabs for sectioned content without needing to wrap the content in a code group.