SZGF Schema

Classes:

• Section –

  A section, anything can be written, like additional explanations.

• Character –

  A character in ZZZ.

• WeaponSection –

  A weapon section for a character.

• DiscSetSection –

  A drive disc set section.

• DiscSection –

  A drive disc section for a character.

• DiscMainStatSection –

  Main stat section for a drive disc.

• StatSection –

  Stat section for a character.

• MindscapeSection –

  A mindscape cinema section for a character.

• SkillType –

  Types of skills in ZZZ.

• SkillPrioritySection –

  Skill priority section for a character.

• TeamMember –

  A team member in a team.

• Team –

  A team that a character can be part of.

• TeamSection –

  Team section for a character.

• Skill –

  A skill of a character.

• OriginalGuide –

  The standardized ZZZ guide format (SZGF) schema.

Section pydantic-model

A section, anything can be written, like additional explanations.

Fields:

• title (str)
• description (str)

title pydantic-field

title: str

Title of the section

description pydantic-field

description: str

Description of the section

Character pydantic-model

A character in ZZZ.

Fields:

• name (str)
• rarity (Literal[4, 5])
• banner (str | None)

name pydantic-field

name: str

Name of the character

rarity pydantic-field

rarity: Literal[4, 5]

Rarity of the character, either 4 (A-rank) or 5 (S-rank) stars.

banner pydantic-field

banner: str | None = None

A custom banner can be provided, otherwise defaults to M6 art.

WeaponSection pydantic-model

A weapon section for a character.

Fields:

• name (str)
• description (str)
• title (str | None)
• icon (str | None)

name pydantic-field

name: str

Name of the weapon

description pydantic-field

description: str

Description of the weapon

title pydantic-field

title: str | None = None

Title of the section. A custom title for the section can be provided, otherwise shows the ranking of the weapon, e.g. '2nd Best W-Engine.'

icon pydantic-field

icon: str | None = None

Icon of the weapon. A custom icon can be provided, otherwise an icon will be fetched based on the name.

DiscSetSection pydantic-model

A drive disc set section.

Fields:

• name (str)
• description (str)
• icon (str | None)

name pydantic-field

name: str

Name of the drive disc set

description pydantic-field

description: str

Description for this section

icon pydantic-field

icon: str | None = None

Icon of the drive disc set. A custom icon can be provided, otherwise an icon will be fetched based on the name.

DiscSection pydantic-model

A drive disc section for a character.

Fields:

• four_pieces (list[DiscSetSection])
• two_pieces (list[DiscSetSection])
• extra_sections (list[Section])

four_pieces pydantic-field

four_pieces: list[DiscSetSection]

List of four-piece disc sets.

two_pieces pydantic-field

two_pieces: list[DiscSetSection]

List of two-piece disc sets.

extra_sections pydantic-field

extra_sections: list[Section]

Additional sections that can be added to the disc section.

DiscMainStatSection pydantic-model

Main stat section for a drive disc.

Fields:

• stat_priority (str)
• pos (Literal[4, 5, 6])

stat_priority pydantic-field

stat_priority: str

Priority of the main stat for this position's disc, e.g. 'ATK > CRIT DMG > CRIT RATE'.

pos pydantic-field

pos: Literal[4, 5, 6]

Position of the disc, either 4, 5, or 6.

StatSection pydantic-model

Stat section for a character.

Fields:

• main_stats (list[DiscMainStatSection])
• sub_stats (str)
• baseline_stats (str)
• extra_sections (list[Section])

main_stats pydantic-field

main_stats: list[DiscMainStatSection]

List of main stats for each disc position (4, 5, 6).

sub_stats pydantic-field

sub_stats: str

Priority of sub stats for the character, e.g. 'ATK > CRIT DMG > CRIT RATE > SPD'.

baseline_stats pydantic-field

baseline_stats: str

Baseline stats for the character, e.g. 'ATK: 1000, DEF: 500, HP: 2000'.

extra_sections pydantic-field

extra_sections: list[Section]

Additional sections that can be added to the stat section.

MindscapeSection pydantic-model

A mindscape cinema section for a character.

Fields:

• num (Literal[1, 2, 3, 4, 5, 6])
• description (str)

num pydantic-field

num: Literal[1, 2, 3, 4, 5, 6]

Number of the mindscape, from 1 to 6.

description pydantic-field

description: str

Description of the mindscape, explaining its effects and importance.

SkillType

Types of skills in ZZZ.

Attributes:

• CORE –
• BASIC –
• DODGE –
• SPECIAL –
• CHAIN –
• ASSIST –

CORE class-attribute instance-attribute

CORE = 'core'

BASIC class-attribute instance-attribute

BASIC = 'basic'

DODGE class-attribute instance-attribute

DODGE = 'dodge'

SPECIAL class-attribute instance-attribute

SPECIAL = 'special'

CHAIN class-attribute instance-attribute

CHAIN = 'chain'

ASSIST class-attribute instance-attribute

ASSIST = 'assist'

SkillPrioritySection pydantic-model

Skill priority section for a character.

Fields:

• priorities (list[list[SkillType]])
• description (str | None)

priorities pydantic-field

priorities: list[list[SkillType]]

List of skill priorities, where each sublist represents a priority level. For example, [[core, basic], [special, dodge]] means the first priority is core and basic skills, and the second priority is special and dodge skills.

description pydantic-field

description: str | None = None

Description of the skill priority section

TeamMember pydantic-model

A team member in a team.

Fields:

• name (str)

name pydantic-field

name: str

Name of the team member

Team pydantic-model

A team that a character can be part of.

Fields:

• name (str)
• characters (list[TeamMember])
• description (str | None)

name pydantic-field

name: str

Name of the team

characters pydantic-field

characters: list[TeamMember]

List of characters in the team

description pydantic-field

description: str | None = None

Description of the team

TeamSection pydantic-model

Team section for a character.

Fields:

• teams (list[Team])
• extra_sections (list[Section])

teams pydantic-field

teams: list[Team]

List of teams that the character can be part of.

extra_sections pydantic-field

extra_sections: list[Section]

Additional sections for the team section.

Skill pydantic-model

A skill of a character.

Fields:

• title (str)
• description (str)
• explanation (str)
• demo (str | None)

title pydantic-field

title: str

Title of the skill

description pydantic-field

description: str

Description of the skill

explanation pydantic-field

explanation: str

Explanation of the skill mechanics

demo pydantic-field

demo: str | None = None

Demo GIF of the skill

OriginalGuide pydantic-model

The standardized ZZZ guide format (SZGF) schema.

Fields:

• author (str)
• last_updated (date)
• character (Character)
• description (str)
• weapons (list[WeaponSection])
• discs (DiscSection | None)
• stat (StatSection | None)
• skill_priority (SkillPrioritySection | None)
• skills (list[Skill])
• mindscapes (list[MindscapeSection])
• team (TeamSection | None)
• rotation (Section | None)

author pydantic-field

author: str

Author of the guide

last_updated pydantic-field

last_updated: date

Last updated date of the guide

character pydantic-field

character: Character

Character information

description pydantic-field

description: str

Description of the guide, explaining its purpose and content.

weapons pydantic-field

weapons: list[WeaponSection]

List of weapon sections for the character.

discs pydantic-field

discs: DiscSection | None = None

Disc section for the character.

stat pydantic-field

stat: StatSection | None = None

Stat section for the character.

skill_priority pydantic-field

skill_priority: SkillPrioritySection | None = None

Skill priority section for the character.

skills pydantic-field

skills: list[Skill]

List of skills for the character.

mindscapes pydantic-field

mindscapes: list[MindscapeSection]

List of mindscapes for the character.

team pydantic-field

team: TeamSection | None = None

Team section for the character.

rotation pydantic-field

rotation: Section | None = None

Rotation section for the character, explaining how to use skills effectively.