How to use GfxCrunch (Animated Object Sprites) - Revision history

Deltaflare: /* */ simplified formatting, added decimal formats for clarification

2025-04-19T17:56:36Z

<Frame>: simplified formatting, added decimal formats for clarification

← Older revision		Revision as of 17:56, 19 April 2025
Line 17:		Line 17:
	== frames.xml ==		== frames.xml ==
	Contains data for image frames.		Contains data for image frames.

			A <code><FrameGroup></code> is made up of x amount of <code><Frame></code> images, ''if'' it needs to form a bigger sprite. If a sprite is going to be just one image (eg: one PNG from the <code>imgs</code> folder), each PNG that will be used for animations ''needs to be in its own <code><FrameGroup></code>. If not, this will cause memory issues and/or crashes when displaying the object in cutscenes.''

			See the definitions of the XML tags below.

	=== <FrameGroup> ===		=== <FrameGroup> ===
Line 23:		Line 27:
	=== <Frame> ===		=== <Frame> ===
	Indicates a single image sprite.		Indicates a single image sprite.

	A <code><FrameGroup></code> is made up of x amount of <code><Frame></code> images, ''if'' it needs to form a bigger sprite. If a sprite is going to be just one image (eg: one PNG from the <code>imgs</code> folder), each PNG that will be used for animations ''needs to be in its own <code><FrameGroup></code>. If not, this will cause memory issues and/or crashes when displaying the object in cutscenes.''

	==== <ImageIndex> ====		==== <ImageIndex> ====
	The image index of the frame. This correlates with the image number in the imgs folder.		The image index of the frame. This correlates with the image number in the <code>imgs</code> folder.

	==== <Unk0> ====		==== <Unk0> ====
Line 39:		Line 41:

	==== <Unk15> ====		==== <Unk15> ====
	Correlates to ''each ~~<code><~~Frame~~></code>~~'' in '''~~one~~''' ~~<code><~~FrameGroup~~></code>~~, used for memory allocation and layering. If there are multiple ~~<code><~~Frames~~></code>~~ in a ~~<<code>~~FrameGroup~~></code>~~ , increment this value.		Correlates to ''each '''Frame''''' in ''one'' '''FrameGroup''', used for memory allocation and layering. If there are '''multiple''' '''Frames''' in a '''FrameGroup''', '''increment''' this value in each entry.

	Value needed to start with/increment depends on the size of the sprite. Ideally:		Value needed to start with and/or increment depends on the resolution size of the sprite. Ideally:

	* 8x8 frame (smallest size) requires <code>0x1</code>		* 8x8 frame (smallest size) requires <code>0x1</code> (1 in decimal)
	* 16x32 frame requires <code>0x2</code>		* 16x32 frame requires <code>0x2</code> (2 in decimal)
	* 32x64 frame requires <code>0x8</code>		* 32x64 frame requires <code>0x8</code> (8 in decimal)
	* 32x32 frame requires <code>0x4</code>		* 32x32 frame requires <code>0x4</code> (4 in decimal)
	* 64x64 frame (largest size) requires <code>0x10</code>		* 64x64 frame (largest size) requires <code>0x10</code> (16 in decimal)

	The number is represented in hexadecimal, so 0x0 is 0... 0xc is 12, 0x10 is 16, etc.		The number is represented in hexadecimal, so 0x0 is 0... 0xc is 12, 0x10 is 16, etc.

Deltaflare: /* Imgs Folder */ formatting

2025-04-19T17:48:10Z

Imgs Folder: formatting

← Older revision		Revision as of 17:48, 19 April 2025
Line 9:		Line 9:
	GfxCrunch uses the following folders and files to generate object sprites.		GfxCrunch uses the following folders and files to generate object sprites.

	== ~~Imgs~~ Folder ==		== imgs Folder ==
	This is a folder of all image sprites used in the animations. Images are labeled from <code>0000.png</code>, <code>0001.png</code>, <code>0002.png</code>, etc. These images have to be i''~~ndexed~~ images'' and fit within GfxCrunch’s sizes (16 x 16 or multiples of that are safe starting points).		This is a folder of all image sprites used in the animations. Images are labeled from <code>0000.png</code>, <code>0001.png</code>, <code>0002.png</code>, etc. These images have to be ''indexed images'' and fit within GfxCrunch’s sizes (16 x 16 or multiples of that are safe starting points).

	== palette.pal ==		== palette.pal ==

Deltaflare: simplified headers, added memory explanation

2025-04-19T17:47:09Z

simplified headers, added memory explanation

Show changes

Deltaflare: Created page with "{{Stub}} '''XML''' is a markup language for data. '''GfxCrunch''' uses this data to create object sprites for EoS (not confirmed). Recommend export to a static sprite from SkyTemple and then editing the exported files to your liking. XML uses tags to list this data in the format of: `content here` GfxCrunch uses the following folders and files to generate object sprites. == Imgs Folder == This is a folder of all image sprites used in..."

2025-04-19T16:46:14Z

Created page with "{{Stub}} '''XML''' is a markup language for data. '''GfxCrunch''' uses this data to create object sprites for EoS (not confirmed). Recommend export to a static sprite from SkyTemple and then editing the exported files to your liking. XML uses tags to list this data in the format of: <code><TagName> content here </TagName></code> GfxCrunch uses the following folders and files to generate object sprites. == Imgs Folder == This is a folder of all image sprites used in..."

New page

{{Stub}}

'''XML''' is a markup language for data. '''GfxCrunch''' uses this data to create object sprites for EoS (not confirmed).

Recommend export to a static sprite from SkyTemple and then editing the exported files to your liking.

XML uses tags to list this data in the format of:

<code><TagName> content here </TagName></code>

GfxCrunch uses the following folders and files to generate object sprites.

== Imgs Folder ==
This is a folder of all image sprites used in the animations. Images are labeled from <code>0000.png</code>, <code>0001.png</code>, <code>0002.png</code>, etc. These images have to be i''ndexed images'' and fit within GfxCrunch’s sizes (16 x 16 or multiples of that are safe starting points).

== palette.pal ==
Contains the image palette. The indexes correspond with the color indexes of the sprites in the <code>imgs</code> folder. Must contain 16 colors at most, including a transparent color. To obtain this, it's recommend to import one of your images into SkyTemple as a ''static sprite'', then export from SkyTemple.

== frames.xml ==
Contains data for image frames.

=== XML Tags ===

==== <FrameGroup> ====
Indicates a group of frames. Multiple frames can be layered on top of each other or be aligned side-to-side to create a "bigger sprite."

==== <Frame> ====
Indicates a single image sprite.

A <code><FrameGroup></code> is made up of x amount of <code><Frame></code> images, ''if'' it needs to form a bigger sprite. If a sprite is going to be just one image (eg: one PNG from the <code>imgs</code> folder), each PNG that will be used for animations ''needs to be in its own <code><FrameGroup></code>. If not, this will cause memory issues and/or crashes when displaying the object in cutscenes.''

===== <ImageIndex> =====
The image index of the frame. This correlates with the image number in the imgs folder.

== imgsinfo.xml ==

== spriteinfo.xml ==
- todo: explanation of memory allowance in spriteinfo.xml

== offsets.xml ==
[[File:GFXC tutorial offsets.xml example.png|center|thumb]]

== How to Use with SetAnimation() ==
This is the [[ExplorerScript]] function that lets you change the animation of an object, with an integer taken in as an argument. When using the function, it should be called as <code>SetAnimation<entity ENTITY>(x)</code>.

Depending on how many AnimationSequenceIndexes you have defined, the argument will differ as follows:

* '''1 - 8''' will cause a specific animation to ''loop'', with '''1''' denoting ''Animation 0'' and '''8''' denoting ''Animation 7''.
* '''9 - 16''' will play ''Animation 0'' and then play the first frame of the signified animation, with '''9''' denoting ''Animation 0'' and '''16''' denoting ''Animation 7''.
* '''17 - 24''' will play a specific animation ''without'' ''looping'', with '''17''' denoting ''Animation 0'' and '''24''' denoting ''Animation 7''.

== Example ==
For reference, here is a link to a sample folder: [https://drive.google.com/drive/u/2/folders/1ENtmeUDNhBbnaetIaDcaEUOS648NoowJ External Link to Google Drive]

When finished, add to Tutorials