Skip to content
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

Doc: explain the binary structure of scripts custom data #9425

Merged
merged 1 commit into from Jul 10, 2021

Conversation

@glx22
Copy link
Contributor

@glx22 glx22 commented Jul 10, 2021

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.

  • The bug fix is important enough to be backported? (label: 'backport requested')
  • This PR affects the save game format? (label 'savegame upgrade')
  • This PR affects the GS/AI API? (label 'needs review: Script API')
    • ai_changelog.hpp, gs_changelog.hpp need updating.
    • The compatibility wrappers (compat_*.nut) need updating.
  • This PR affects the NewGRF API? (label 'needs review: NewGRF')
@glx22 glx22 force-pushed the script_save_format branch from 1c905d3 to 6fe1cba Jul 10, 2021
docs/savegame_format.md Outdated Show resolved Hide resolved
Loading
docs/savegame_format.md Outdated Show resolved Hide resolved
Loading
docs/savegame_format.md Outdated Show resolved Hide resolved
Loading
docs/savegame_format.md Outdated Show resolved Hide resolved
Loading
docs/savegame_format.md Outdated Show resolved Hide resolved
Loading
docs/savegame_format.md Outdated Show resolved Hide resolved
Loading
docs/savegame_format.md Outdated Show resolved Hide resolved
Loading
@glx22 glx22 force-pushed the script_save_format branch 2 times, most recently from b447e63 to db20891 Jul 10, 2021
docs/savegame_format.md Outdated Show resolved Hide resolved
Loading
@glx22 glx22 force-pushed the script_save_format branch 4 times, most recently from 426174e to f315be8 Jul 10, 2021
@glx22 glx22 merged commit 92cdfff into OpenTTD:master Jul 10, 2021
15 checks passed
Loading
@glx22 glx22 deleted the script_save_format branch Jul 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants