Skip to content

Graphics

Jump to bottom
TheLX5 edited this page Jul 8, 2023 · 5 revisions

This page should cover everything about player graphics that requires no ASM involvement.

Graphic sets

The patch uses a system for the player graphics called Graphic sets where one could create player graphics sets with no ASM involvement at all. The idea is that anyone can create and share those to any user or between projects.

The graphic set can include the following files in a folder inside the player_graphics folder for it to be a valid set:

  • A xxxx.bin file containing player graphics in the 32x32 Player Tilemap patch format.
  • A xxxx.mw3 file that has the player palette in the specified range in defs.asm (A .palmask file may be included, but it's not mandatory)
  • A xxxx_defs.asm file that may or not contain defines related to the graphics.
  • A xxxx_extra.bin file containing extra player graphics to be used with the cape or a custom tile. The maximum size possible is 8KiB.
  • A xxxx_tilemap.bin file with the tables, code and data necessary for the system to work.
  • A xxxx_animations.asm file containing the animation overrides for poses in the Smooth Animations format.

xxxx should be replaced with you graphic set name, the folder should have the same name (xxxx).

The following examples are valid graphic sets:

Player GFX

WIP

Player tilemap

WIP

Player palette

WIP

Player extra tile

WIP

Player animations

Also called "Smooth Animation". WIP.

Global palette animations

WIP

Installation of graphic sets

Ideally you should only unzip them in the root folder of the patch, but be sure to put the graphic set inside the player_graphics folder.

To have the patch recognize the newly added set you have to add the graphic set name into the graphic_list.asm file on the root folder. The format is the following:

    <number> <single space> <set name>

Example:

    0F beta_mario

This will add the graphic set named beta_mario in the slot 0F and will search for any folder with that name inside of the player_graphics folder.

Do note that the set names should NOT contain any spaces in them, you're only allowed to use underscores (_)as special characters in your graphic sets.

Distribution of graphic sets

Ideally you should only distribute the desired folder in player_graphics, but you could also add auxiliary files with mandatory changes, like the palette usage, custom animations, etc.

Clone this wiki locally