toktokkie.metadata.game package¶

Submodules¶

toktokkie.metadata.game.Game module¶

class toktokkie.metadata.game.Game.Game(directory_path: str, json_data: Optional[Dict[str, Any]] = None, no_validation: bool = False)¶

Bases: toktokkie.metadata.base.Metadata.Metadata, toktokkie.metadata.game.GameRenamer.GameRenamer, toktokkie.metadata.game.GamePrompter.GamePrompter, toktokkie.metadata.game.GameValidator.GameValidator

Metadata class that handles games

directory_path: str¶: The path to the directory this metadata describes

json: Dict[str, Any]¶

classmethod media_type() → toktokkie.enums.MediaType ¶

Returns: The Game media type

classmethod valid_id_types() → List[toktokkie.enums.IdType]¶

Returns: A list of valid ID types

toktokkie.metadata.game.GameExtras module¶

class toktokkie.metadata.game.GameExtras.GameExtras¶

Bases: toktokkie.metadata.base.MetadataBase.MetadataBase, abc.ABC

Additional methods and attributes for game metadata objects

property cg_dir¶

Returns: Path to the CG directory

property cgs¶: Generates a dictionary of paths to CG images :return: A dictionary mapping the various CG images to their

respective directory identifiers

directory_path: str¶: The path to the directory this metadata describes

property eds¶

Returns: a list of ending theme videos

property has_cgs¶

Returns: Whether or not the Visual Novel has a CG gallery

property has_ed¶

Returns: Whether or not the Visual Novel has an ending theme

property has_op¶

Returns: Whether or not the Visual Novel has an opening theme

property has_ost¶

Returns: Whether or not the Visual Novel has an OST

json: Dict[str, Any]¶

property ops¶

Returns: a list of opening theme videos

property ost¶

Returns: a list of files for the OST of a visual novel

property ost_dir¶

Returns: Path to the OST directory

property video_dir¶

Returns: Path to the video directory

toktokkie.metadata.game.GamePrompter module¶

class toktokkie.metadata.game.GamePrompter.GamePrompter¶

Bases: toktokkie.metadata.base.Prompter.Prompter, toktokkie.metadata.game.GameExtras.GameExtras, abc.ABC

Implements the Prompter functionality for game metadata

directory_path: str¶: The path to the directory this metadata describes

json: Dict[str, Any]¶

toktokkie.metadata.game.GameRenamer module¶

class toktokkie.metadata.game.GameRenamer.GameRenamer¶

Bases: toktokkie.metadata.base.Renamer.Renamer, toktokkie.metadata.game.GameExtras.GameExtras, abc.ABC

Implements the Renamer functionality for game metadata

directory_path: str¶: The path to the directory this metadata describes

json: Dict[str, Any]¶

toktokkie.metadata.game.GameValidator module¶

class toktokkie.metadata.game.GameValidator.GameValidator¶

Bases: toktokkie.metadata.base.Validator.Validator, toktokkie.metadata.game.GameExtras.GameExtras, abc.ABC

Implements the Validator functionality for game metadata

classmethod build_schema() → Dict[str, Any]¶: Generates the JSON schema :return: The JSON schema

directory_path: str¶: The path to the directory this metadata describes

json: Dict[str, Any]¶