`DMI` — Icon Parsing¶

class DMI¶

The DMI class provides the ability to parse and manipulate .dmi files.

DMI instances are created with the following methods:

static from_file(filename: str | os.PathLike[str]) → DMI¶: Read the BYOND Icon file from the filename referring to a “.dmi” file.

Once instantiated, the following methods and properties are available:

property filepath: pathlib.Path¶: The original path of the DMI file.

property icon_width: int¶: The width of icons in the file.

property icon_height: int¶: The height of icons in the file.

property icon_dims: tuple[int, int]¶: The width and height of icons in the file.

state_names() → list[str]¶: Return a list of all state names in the icon file.

state(name: str) → IconState¶: Returns the IconState with the given name.

Individual icon states are represented by IconState.

class IconState¶

property name: str¶: The name of the icon state. May not be unique within a file.

property frames: int¶: The number of frames in the state.

property delays: list[int]¶: A list of delays per frame, in ticks.

property dirs: list[Dir]¶: A list of directions available in the icon state.

property movement: bool¶: Whether the icon state is a movement state.

property rewind: bool¶: Whether the icon state rewinds on animation.

data_rgba8(frame: int, dir: Dir) → bytes¶

Returns the image data for the given 1-indexed frame in RGBA8 bytes.

Using Pillow, the image data for a given icon can quickly be turned into a PIL.Image object and easily manipulated.

from avulto import DMI, Dir
from PIL import Image
dmi = DMI.from_file("/SS13/icons/objects/weapons.dmi")
pistol = dmi.state("pistol")
data = pistol.data_rgba8(frame=1, dir=Dir.SOUTH)
image = Image.frombytes("RGBA", size=dmi.icon_dims, data=data)