webstation-broker
DeveloperPython referenceapi

api.RomIn

The rom RomM resolved for the launch.

The rom RomM resolved for the launch.

Attributes

attributeidOptional[int]
= None

RomM's id for the rom, if known.

attributenameOptional[str]
= None

The rom's display name, if known.

attributeplatformOptional[str]
= None

The platform slug, which general-purpose emulators use to pick a core.

attributelanguageOptional[str]
= None

The rom's language, for emulators whose games ship several in one folder.

attributetitle_idOptional[str]
= None

RomM's game id for the rom (a serial, title id or game code), if it has one.

attributesave_targetOptional[str]
= None

RomM's name for where this game keeps its saves, if it has one.

attributesave_target_layoutOptional[str]
= None

How save_target names that place; see KNOWN_SAVE_TARGET_LAYOUTS.

attributepathstr

Absolute container path to the rom, validated against ROM_ROOT on activate.

attributecoreOptional[str]
= None

The libretro core to boot instead of the platform's default (RetroArch only).

attributeexperimental_coresbool
= False

RomM's opt-in to a core the broker lists as known broken.

Functions

func_log_unknown_layout(cls, value) -> Optional[str]

Log a layout this broker does not know, and keep it.

paramcls
paramvalueOptional[str]

The layout RomM sent.

Returns

typing.Optional

The value, unchanged.

func_check_core(cls, value) -> Optional[str]

Refuse a core name the buildbot could not have.

Raises

  • ValueError: When it does not match ^[a-z0-9_]+$.
paramcls
paramvalueOptional[str]

The core RomM sent.

Returns

typing.Optional

The value, unchanged.

On this page