utils

utils contains a few functions for helping you that doesn’t fit in any other category

get_minecraft_directory() → str

Returns the default path to the .minecraft directory

Returns the latest version of Minecraft

get_version_list() → List[MinecraftVersionInfo]

Returns all versions that Mojang offers to download

get_installed_versions(minecraft_directory: Union[str, PathLike]) → List[MinecraftVersionInfo]

Returns all installed versions

Parameters: minecraft_directory (Union[str, PathLike]) – The path to your Minecraft directory
Return type: List[MinecraftVersionInfo]

get_available_versions(minecraft_directory: Union[str, PathLike]) → List[MinecraftVersionInfo]

Returns all installed versions and all versions that Mojang offers to download

Parameters: minecraft_directory (Union[str, PathLike]) – The path to your Minecraft directory
Return type: List[MinecraftVersionInfo]

get_java_executable() → str

Tries the find out the path to the default java executable

get_library_version() → str

Returns the version of minecraft-launcher-lib

generate_test_options() → MinecraftOptions

Generates options to launch minecraft. Useful for testing. Do not use in production.

is_version_valid(version: str, minecraft_directory: Union[str, PathLike]) → bool

Checks if the given version exists

Parameters

version (str) – A Minecraft version
minecraft_directory (Union[str, PathLike]) – The path to your Minecraft directory

Return type

bool

get_minecraft_news(page_size: int = 20) → Articles

Get the news from minecraft.net

is_vanilla_version(version: str) → bool

Checks if the given version is a vanilla version

is_platform_supported() → bool

Checks if the current platform is supported

is_minecraft_installed(minecraft_directory: Union[str, PathLike]) → bool

Checks, if there is already a existing Minecraft Installation in the given Directory

Parameters: minecraft_directory (Union[str, PathLike]) – The path to your Minecraft directory
Returns: Is a Installation is found
Return type: bool