Contribution Guidelines
Getting Started
You can check existing guides by using the /build zzz command in Hoyo Buddy.
Use the SZGF generator to write your guide using a user-friendly interface. The generator will help you create a valid guide file.
Formatting
Markdown
The description and explanation fields accept Markdown formatting. See Discord's Markdown guide for details.
UI Buttons
In the skill section, you might need to reference UI buttons. Use the following format:
| Image | UI Button Name | Tag |
|---|---|---|
 |
Basic Attack | <basic> |
 |
Dodge | <dodge> |
 |
Chain | <chain> |
 |
Special | <special> |
 |
Assist | <assist> |
 |
Core Skill | <core> |
Example:
skill:
- name: "Assist Follow-Up: Hammer Bell"
description: >-
Press <basic> after a Defensive Assist to activate. Koleda charges and strikes enemies in front, dealing Fire DMG and obtaining Furnace Fire effect.
explanation: >-
Use this skill after a Defensive Assist to deal damage and gain Furnace Fire, which increases your damage output.
Terminology
For consistency, the following terms are used throughout the repository:
- Character: ZZZ agent.
- Weapon: W-engine.
- Rarity: ZZZ agent or weapon rank (S-rank: 5, A-rank: 4, B-rank: 3)
Multi-line Text
For multi-line text in fields like description or explanation, use the >- YAML syntax to preserve new lines. Example:
description: >-
This is a long sentence that
spans multiple lines in the YAML file,
but will be rendered as a single paragraph.
An empty line indicates a new paragraph.
Renders as: