frbΒΆ

Definition and boilerplate functions for Fortune Avenue-compatible .frb files.

Functions

read_frb

Reads an .frb file in and returns a BoardFile object representing it.

write_frb

Writes a Fortune Avenue-compatible .frb file from a user-provided BoardFile object.

Classes

BoardData

A dataclass representing Board Data, which is attached to a Square object.

BoardFile

A dataclass representing Board Info, which is attached to a Square object.

BoardInfo

A dataclass representing Board Info, which is attached to a Square object.

Header

A dataclass representing Header information.

LoopingMode

The LoopingMode enum works the same way, allowing us to refer to the bytecodes that represent None, Vertical, and Both (Horizontal and Vertical) values of LoopingMode.

MagicNumber

In this case, the Magic Number represents specific types of data, each of which is a separate subset of the .frb file.

Square

A dataclass representing a Square.

SquareType

The SquareType enum represents the various types of Squares that can exist in a Fortune Avenue-compatible .frb file.

WaypointData

A dataclass representing Waypoint information.