mrpack

mrpack allows you to install Modpacks from the Mrpack Format

get_mrpack_information(path: Union[str, PathLike]) → MrpackInformation

Gets some Information from a .mrpack file

Parameters: path (Union[str, os.PathLike]) – The Path the the .mrpack file
Returns: The Information about the given Mrpack
Return type: MrpackInformation

install_mrpack(path: Union[str, PathLike], minecraft_directory: Union[str, PathLike], modpack_directory: Optional[Union[str, PathLike]] = None, callback: Optional[CallbackDict] = None, mrpack_install_options: Optional[MrpackInstallOptions] = None) → None

Installs a .mrpack file

Parameters

path (Union[str, PathLike]) – The Path the the .mrpack file
minecraft_directory (Union[str, PathLike]) – he path to your Minecraft directory
modpack_directory (Optional[Union[str, PathLike]]) – If you want to install the Pack in another Directory than your Minecraft directory, set it here.
callback (Optional[CallbackDict]) – The same dict as for install_minecraft_version()
mrpack_install_options (Optional[MrpackInstallOptions]) – Some Options to install the Pack (see below)

Raises

FileOutsideMinecraftDirectory – A File should be placed outside the given Minecraft directory

Return type

None

mrpack_install_options is a dict. All Options are Optional.

mrpack_install_options = {
    "optionalFiles": [], # List with all Optional files
    "skipDependenciesInstall": False # If you want to skip the Dependencie install. Only used for testing purposes.
}

get_mrpack_launch_version(path: Union[str, PathLike]) → str

Returns that Version that needs to be used with get_minecraft_command().

Parameters: path (Union[str, PathLike]) – The Path the the .mrpack file
Returns: The version
Return type: str

View the source code of this module