Skip to main content

Module credits

Module credits 

Source
Expand description

The credits: every third-party work a game uses, for its credits screen. Music and sounds are credited in the audio manifest (crate::audio); everything else (fonts, bought art, vendored software) in a credits file. merge makes the two one list, so nothing is typed twice.

A bought work names the files of the game’s private folder it covers (the bought art, kept out of the public repository). It is shown only in a build that has files there, and uncredited finds the bought files no credit covers (game ADR-0051). As a format (ADR-0007): CreditsRon.

Structs§

CreditEntry
One work as the credits screen shows it.
Credits
Every credit the screen shows: sorted by group (CreditGroup::ALL), audio works by title within their group, the file’s in file order.
CreditsFile
The validated credits file, in file order, hidden entries included.
CreditsRon
A credits file (credits, .ron), checked as from_source says, its errors naming the game’s other files as Places does.
FileCredit
One entry of the credits file.
Places
Where the game keeps what a credits file’s errors point to.

Enums§

CreditGroup
The kinds of work the credits screen groups by, in the order it shows them.

Constants§

LICENSES
Licenses an entry of the credits file may have, unless it is a bought work (FileCredit::private): game ADR-0013’s code and font lists.

Functions§

from_source
Parses and validates credits source, attributing errors to file and naming the game’s other files by places. Reports every problem found.
merge
The credits the screen shows: the third-party works audio’s music cues name, then those its sound cues name (each once, by title; a work used for both counts as music), then file’s entries that aren’t hidden. Our own work (audio::OWN) isn’t listed, and a bought work only when one of bought (the build’s files from the private folder) is its: a build without the art doesn’t use it.
uncredited
The bought files among paths (relative to the private folder) that no credit of file covers. Each needs one before it ships (game ADR-0051).