Skip to content

Commit 4a98123

Browse files
committed
Add Missing Fields for Character Data
1 parent cc84b23 commit 4a98123

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

src/03-custom-characters/03-02-creating-a-character.md

+28
Original file line numberDiff line numberDiff line change
@@ -98,12 +98,40 @@ The available fields are:
9898
- For the `packer` asset type, this must point to the path where the `txt` and `png` are located, without the file extension.
9999
- For the `animateatlas` asset type, this must point to the folder where the `Animation.json` and any spritemaps are located.
100100
- For the `multisparrow` asset type, point to the path where your main Sparrow spritesheet is located. On each animations which uses a different Sparrow spritesheet from the main one, add the `assetPath` key to that specific animation.
101+
- `scale`: Specify the size of the character relative to the original size. For example, `2.0` makes the sprite twice as big. Optional, defaults to `1.0`.
102+
- `healthIcon`: Data for the health icon to display in-game. For example, Boyfriend will obviously use Boyfriend's health icon.
103+
- `death`: Data for the death screen to use, when the character reaches `0` health.
104+
- `offsets`: The global offset to the character's position, in pixels.
105+
- Use an array of two decimal values, the first for horizontal position and the second for vertical position.
106+
- `cameraOffsets`: The amount to offset the camera by while focusing on this character.
107+
- Default value focuses on the character directly.
108+
- Use an array of two decimal values, the first for horizontal position and the second for vertical position.
109+
- `isPixel`: Specify whether to display the character as pixel (disabling texture smoothing). Optional, defaults to `false`.
110+
- `danceEvery`: The frequency at which the character will play its idle animation, in beats. Optional, defaults to `1`.
111+
- Increasing this number will make the character dance less often.
112+
- `flipX`: Whether to flip the whole sprite horizontally in-game. Useful for characters that could also be played (Pico).
101113
- `startingAnimation`: The animation for the character to play when they are first loaded in.
102114
- `singTime`: The amount of time, in steps, for a character to keep singing after they let go of a note.
103115
- Decrease this if the character seems to hold their poses for too long after their section is done.
104116
- Increase this if the character resets to the idle animation in the middle of their singing animations.
105117
- `animations`: A list of animation data objects for the character.
106118

119+
Health Icon data is structured like so:
120+
- `id`: The ID to use for the health icon, defaults to character's ID.
121+
- `scale`: Specify the size of the health icon relative to the original size. For example, `2.0` makes the sprite twice as big. Optional, defaults to `1.0`.
122+
- `flipX`: Whether to flip the whole sprite horizontally in-game.
123+
- `isPixel`: Specify whether to display the health icon as pixel (disabling texture smoothing). Optional, defaults to `false`.
124+
- `offsets`:
125+
- Use an array of two decimal values, the first for horizontal position and the second for vertical position.
126+
127+
Death data is structured like so:
128+
- `cameraOffsets`: The amount to offset the camera by while focusing on this character as they die.
129+
- Default value focuses on the character's graphic midpoint.
130+
- Use an array of two decimal values, the first for horizontal position and the second for vertical position.
131+
- `cameraZoom`: The amount to zoom the camera by while focusing on this character as they die.
132+
- `preTransitionDelay`: The delay between when the character reaches `0` health and when the death animation plays.
133+
134+
107135
Animation data is structured like so:
108136
- `name`: The internal animation name for the game to use.
109137
- `prefix`: The animation name as specified by your spritesheet.

0 commit comments

Comments
 (0)