Doc: explain the binary structure of scripts custom data #9425
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
glx22
force-pushed
the
script_save_format
branch
from
1c905d3
to
6fe1cba
Compare
TrueBrain
reviewed
Jul 10, 2021
glx22
force-pushed
the
script_save_format
branch
2 times, most recently
from
b447e63
to
db20891
Compare
TrueBrain
reviewed
Jul 10, 2021
glx22
force-pushed
the
script_save_format
branch
4 times, most recently
from
426174e
to
f315be8
Compare
TrueBrain
previously approved these changes
Jul 10, 2021
glx22
force-pushed
the
script_save_format
branch
from
f315be8
to
ff8ca63
Compare
TrueBrain
previously approved these changes
Jul 10, 2021
glx22
force-pushed
the
script_save_format
branch
from
ff8ca63
to
9b53a8d
Compare
TrueBrain
approved these changes
Jul 10, 2021
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.
Motivation / Problem
Scripts can add custom data when a game is saved. The format is only understandable when looking at the source code, and not really documented.
Description
Document the format in the most logical place.
Limitations
Checklist for review
Some things are not automated, and forgotten often. This list is a reminder for the reviewers.