Como Crear Tu Launcher de Minecraft en Ingles

minecraft-launcher-lib
Release 6.4
JakobDev
Jan 01, 2024

CONTENTS
1 Introduction 3
1.1 What’s this? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2 Goals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.3 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2 Installation 5
3 Tutorial 7
3.1 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.2 Microsoft Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.3 Get Installation Progress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.4 More Launch Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.5 Install Forge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.6 Install Fabric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.7 Custom Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.8 Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4 Modules 15
4.1 command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
4.2 install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
4.3 natives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
4.4 microsoft_account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
4.5 utils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
4.6 java_utils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.7 forge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
4.8 fabric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.9 quilt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
4.10 runtime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
4.11 vanilla_launcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
4.12 mrpack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
4.13 exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
4.14 types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
4.15 microsoft_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
5 FAQ 43
6 Examples 45
6.1 PyQtLauncherWithOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.2 TkinterLauncher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
6.3 ForgeInstall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6.4 PyQtInstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
i
6.5 FabricInstall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
6.6 SimpleLaunch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
6.7 PyQtLoginWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
6.8 Mrpack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
6.9 InstallationProgress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
7 Troubleshooting 61
8 Contribute 63
9 Develop 65
9.1 Testing changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
9.2 Codestyle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
9.3 Automatic tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
9.4 Static typing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
9.5 Build and edit documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
9.6 Making a Pull Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
10 Showcase 69
11 Changelog 71
11.1 6.4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
11.2 6.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
11.3 6.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
11.4 6.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
11.5 6.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
11.6 5.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
11.7 5.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
11.8 5.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
11.9 5.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
11.10 4.6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
11.11 4.5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
11.12 4.4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
11.13 4.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
11.14 4.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
11.15 4.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
11.16 4.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
11.17 3.6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
11.18 3.5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
11.19 3.4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
11.20 3.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
11.21 3.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
11.22 3.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
11.23 3.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
11.24 2.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
11.25 2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
11.26 1.4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
11.27 1.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
11.28 1.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
11.29 1.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
11.30 1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
11.31 0.5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
11.32 0.4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
11.33 0.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
11.34 0.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
ii
11.35 0.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
12 History 79
Python Module Index 81
Index 83
iii
iv
minecraft-launcher-lib, Release 6.4
minecraft-launcher-lib is a easy to use Python library for creating your own Minecraft Launcher.
CONTENTS 1
2 CONTENTS
CHAPTER
ONE
INTRODUCTION
1.1 What’s this?
minecraft-launcher-lib is (as the Name might suggest) a Python library for creating a custom Minecraft launcher. It
allows you to easily install and launch Minecraft without needing to know technical details. It also included functions for
some optional things you may want to have e.g. Installing modloaders like Forge/Fabric/Quilt or installing Modpacks.
Many different things are included, so you can write a Launcher that fit’s exactly your needs.
• You want a simple script that just launches the latest Minecraft version? No problem!
• You want to play a Modpack with your friends, but they have problems installing it? Just create a custom launcher
using minecraft-launcher-lib that installs Minecraft together with the Modpack and automatically connects to
your server.
• You want to create a branded Launcher for your Modpack, to make sure it everyone can install it? With minecraft-
launcher-lib you can do this easily!
1.2 Goals
These are the main goals of minecraft-launcher-lib:

• minecraft-launcher-lib can launch any version out there. If the official Launcher can launch it, minecraft-launcher-
lib can launch it too!
• minecraft-launcher-lib installs and launches the Game, but never patches it.
• minecraft-launcher-lib works on every Operating System and architecture that is supported by Minecraft.
• minecraft-launcher-lib is written in pure. It only depends on requests for the Network. No big dependency tree
is used.
• minecraft-launcher-lib should stay backwards compatible. This is not always possible because of changes on the
side of Mojang/Microsoft e.g. the switch from Mojang to Microsoft accounts, but if minecraft-launcher-lib is not
forced, it should never break backwards compatibility. A program that is written using an older version should
also work on the latest version without changes. To ensure this, minecraft-launcher-lib has a test coverage of over
95%.
• minecraft-laucnher-lib is fully static typed. It helps you develop with an IDE and you can use type checkers like
mypy.
3
1.3 Getting Started
This documentation contains a tutorial. You should start with the Getting Started tutorial. You can also take a look
at the Modules documentation which contains the full public API. There are also Examples which shows how to use
minecraft-launcher-lib in real code. If you want to see full programs which are using minecraft-launcher-lib, you can
visit the Showcase.
4 Chapter 1. Introduction
CHAPTER
TWO
INSTALLATION
Here are different methods to install minecraft-launcher-lib.

• pip
Like almost every other Python library, minecraft-launcher-lib can be installed directly from PyPI. That is
the preferred way to install it for the most people.
pip install -U minecraft-launcher-lib
• AUR
If you use Arch Linux or a Arch based Distro like Manjaro, you may want to install it from the Arch User
Repository.
• From Source
You can also install minecraft-launcher-lib directly from source. That will give you the latest changes that
are not in a release yet. Please do this only if you have a good reason.
pip install -U git+https://codeberg.org/JakobDev/minecraft-launcher-lib.git
5
6 Chapter 2. Installation
CHAPTER
THREE
TUTORIAL
3.1 Getting Started
This first chapter of the documentation shows how to install and run Minecraft. The login with Microsoft is skipped
here.
3.1.1 Minecraft Directory
To get started with minecraft-launcher-lib, you need a Minecraft Directory first. You can use a new directory or the
default Directory of Minecraft. You can get the default Directory with get_minecraft_directory().
# Get the Minecraft Directory of your System

minecraft_directory = minecraft_launcher_lib.utils.get_minecraft_directory()
# Or use your own
minecraft_directory = "path/to/your/minecraft/directory"
3.1.2 Install Minecraft
Before you can launch launch Minecraft, you need to install it. This can be done by using install_minecraft_version.
Let’s say we want to install Version 1.17 in our Minecraft Directory.
minecraft_launcher_lib.install.install_minecraft_version("1.17", minecraft_directory)
To get the information how to install Minecraft, minecraft-launcher-lib looks first for a JSON file in your Minecraft Di-
rectory. In the case of 1.17 it’s minecraft_directory/versions/1.17/1.17.json. This allows installing moded
versions that are not official from Mojang. If the JSON file not does exists minecraft-launcher-lib tries to download it
from the Mojang Servers. install_minecraft_version ensures that the Minecraft installation is correct, so you need to
call it every time before you launch Minecraft, even if you had the version already installed.
7
3.1.3 Get Minecraft Versions
If you don’t want to start a single version like 1.17 every time you need a list of all Minecraft version. To get that list
use minecraft_launcher_lib.utils.get_available_versions(minecraft_directory). It returns this list:
[
{
"id": "some_id",
"type": "release"
},
{
"id": "some_other_id",
"type": "snapshot"
}
]
The id is the Minecraft version that can be used as argument for install_minecraft_version and other versions. The type
says what type the version is. Possible values are currently: release, snapshot, beta, alpha. Moded Versions can
also use a custom value, so don’t rely on this list.
To get the latest version, use get_latest_version().
latest_release = minecraft_launcher_lib.utils.get_latest_version()["release"]
latest_snapshot = minecraft_launcher_lib.utils.get_latest_version()["snapshot"]
3.1.4 Launch Minecraft
Since you know how to install Minecraft, it’s now time to start it. First we need a dict with all options. The minimal
options dict is this:
{
"username": "The Username",
"uuid": "The UUID",
"token": "The acces token"
}
The Username and UUID belongs to a Account. Since Name and UUID are public, the Token is used to log in. The
token is generated every time when a User logs in with his Microsoft Account. Minecraft can be launched with a not
existing user and a wrong token. This can be used for test cases. minecraft-launcher-lib allows creating a dict with a
test user.
options = minecraft_launcher_lib.utils.generate_test_options()
We use the test options here to keep it simple. The login with Microsoft comes latter. Keep in mind that publish-
ing a Launcher which allows User who haven’t bought Minecraft to play is illegal, so use this only for test cases in
development. You can add more options to the dict like the resolution, but this is not needed to launch.
Now we have the options, we need to get the Minecraft command. In this case for Version 1.17.
minecraft_command = minecraft_launcher_lib.command.get_minecraft_command("1.17",␣
˓→minecraft_directory, options)
The command that your get is a list of strings that can be used to run Minecraft e.g. with the subprocess module.
8 Chapter 3. Tutorial
3.2 Microsoft Login
Login with a Microsoft Account requires a Web browser and a Azure Application.
3.2.1 Create Azure Application
To login with Microsoft you need to create a Azure Application first. Follow this tutorial to create one. You need the
Clinet ID, the Secret and the redirect URL of your new Application.
3.2.2 Apply for Permission
As stated here, new created Azure Apps need to apply for Permission using this Form before they can use the Minecraft
API. Apps that have been created before this change keeps working without a chance. complete_login() will raise
a AzureAppNotPermitted Exception if your App don’t have the Permission to use the Minecraft API. If you get any
other Exception, that probably means something else with your Azure App is not right.
3.2.3 Let the User log in
The login happens in a Web browser. This can be the normal Browser of the System or a Browser Widget embed in your
Program. To get the url that is used for the login use minecraft_launcher_lib.microsoft_account.get_login_url(client_id:
str, redirect_uri: str). Open the URL and test if you can login. After you’ve logged in you will be redi-
rected to https://<your redirect URL>?code=codegoeshere&state=<optional. codegoeshere is the code
that you need. You can use minecraft_launcher_lib.microsoft_account.get_auth_code_from_url(url:
str) to get the code from the url. You can also use minecraft_launcher_lib.microsoft_account.
url_contains_auth_code(url: str) to check if the given URL has a code.
3.2.4 Secure option
The minecraft_launcher_lib.microsoft_account.get_secure_login_data(client_id: str,

redirect_uri: str, state: str = _generate_state()) generates the login data for a secure login
with pkce and state to prevent Cross-Site Request Forgery attacks and authorization code injection attacks. This is
the recommended way to login. You can parse the auth code and verify the state with minecraft_launcher_lib.
microsoft_account.parse_auth_code_url(url: str, state: str)
3.2.5 Do the Login
Use minecraft_launcher_lib.microsoft_account.complete_login(client_id: str, redirect_uri:

str, auth_code: str, code_verifier: Optional[str]) to login to Minecraft. The auth code is the code
from URL you’ve got in the previous step. The code verifier is the code verifier you’ve got if you used the secure login
method. You get this result:
{
"id" : "The uuid",
"name" : "The username",
"access_token": "The acces token",
"refresh_token": "The refresh token",
"skins" : [{
"id" : "6a6e65e5-76dd-4c3c-a625-162924514568",
(continues on next page)
3.2. Microsoft Login 9

(continued from previous page)

"state" : "ACTIVE",
"url" : "http://textures.minecraft.net/texture/
˓→1a4af718455d4aab528e7a61f86fa25e6a369d1768dcb13f7df319a713eb810b",
"variant" : "CLASSIC",
"alias" : "STEVE"
} ],
"capes" : []
}
As you can see it contains everything you need for the options dict of get_minecraft_command().
3.2.6 Refresh
To refresh just use minecraft_launcher_lib.microsoft_account.complete_refresh(client_id: str,

refresh_token: str). The refresh token is from the function above. If the refresh fails, it will throw a In-
validRefreshToken exception. In this case you need the user to login again.
3.3 Get Installation Progress
Installing a new Minecraft version can, depending on the internet connection, take some time. It would be nice to show
the user the progress e.g. in a Progressbar.
To tell your program the current progress, minecraft-launcher-lib uses callbacks. Callbacks are just normal functions
that you write and that are called by minecraft-launcher-lib. Here is a example:
import minecraft_launcher_lib
current_max = 0
def set_status(status: str):

print(status)
def set_progress(progress: int):

if current_max != 0:
print(f"{progress}/{current_max}")
def set_max(new_max: int):

global current_max
current_max = new_max
callback = {
"setStatus": set_status,
"setProgress": set_progress,

"setMax": set_max
}
minecraft_launcher_lib.install.install_minecraft_version("1.17", minecraft_directory,␣
˓→callback=callback)
As you can see callback is a dict with functions. The functions are defined by you. You can write in these functions
whatever you want. In the example above it prints the current status to the commandline.
3.4 More Launch Options
minecraft-launcher-lib offers various options for launching Minecraft. This page shows the most important ones. For
a full list check out the documentation of the command module.
3.4.1 JVM Arguemnts
JVM Arguments are a list of strings. Each argument is a entry in the list. Here is a example:
# Right
options["jvmArguments"] = ["-Xmx2G", "-Xms2G"]
# Wrong
options["jvmArguments"] = ["-Xmx2G -Xms2G"]
# Wrong
options["jvmArguments"] = "-Xmx2G -Xms2G"
Make sure every argument starts with a -, otherwise Minecraft will not start with a Could not find or load main
class error.
3.4.2 Java Executable
The Java Executable is the path the Java which is used to run Minecraft. If the version.json contains a Java Runtime, it
minecraft-launcher-lib will download and use these version. Otherwise it will just use the java command. minecraft-
launcher-lib allows to overwrite this. This can be useful, if you want to start a older version which needs a older Java
and does not contain a runtime in the version.json.
There are 2 options to overwrite the Java Executable: executablePath and defaultExecutablePath. The dif-
ference is, that executablePath is always used. defaultExecutablePath is only used, when the version.json
has set no Java Runtime. If the version.json contains a Runtime, the Runtime will be prefered over the defaultExe-
cutablePath.
options["executablePath"] = "path/to/java"
options["defaultExecutablePath"] = "path/to/java"
3.4. More Launch Options 11

3.4.3 Custom Resolution
minecraft-launcher-lib allows starting Minecraft with a custom resolution. The first thing you have to do is enable the
custom resolution. After that you can set it:
# Enable custom resolution

options["customResolution"] = True
# Set custom resolution
options["resolutionWidth"] = "600"
options["resolutionHeight"] = "500"
Make sure you use strings and not int for the resolution.
3.4.4 Game Directory
The Game Directory is the directory where Minecraft saves all his stuff like Worlds, Resourcepacks, Options etc. By
default your Minecraft Directory is used as Game Directory.
options["gameDirectory"] = "path/to/your/game/directory"
If the directory does not exists, Minecraft will create it.
3.4.5 Use Demo Mode
Minecraft has a build-in Demo mode, which is used, if somebody who does not bought Minecraft launches the Game
through the official launcher. minecraft-launcher-lib allows you to enable the Demo mode. You need at least Minecraft
version 1.3.1 to use the Demo mode.
options["demo"] = True
3.5 Install Forge
This tutorial shows how to install forge using minecraft-launcher-lib. Please note that the Forge Devs do not want
automatic installations unless you donated to them.
3.5.1 Get Forge Version
Before you install Forge, you need to know what Forge version you need. Use find_forge_version():
forge_version = minecraft_launcher_lib.forge.find_forge_version("1.17.1")
if forge_version is None:
print("This Minecraft Version is not supported by Forge")
return
In this case we get the latest Forge version for 1.17.1.
3.5.2 Install Forge Version
Now we have the Forge version, so we can install it. Use install_forge_version().
minecraft_launcher_lib.forge.install_forge_version(forge_version, minecraft_
˓→directory)
install_forge_version() supports the same callbacks as install_minecraft_version().

install_forge_version() does not support very old versions. Use supports_automatic_install() to
check if your Forge version is supported by this function.
3.5.3 Launch Forge Version
Unfortunately, the version we got with find_forge_version() can’t be used for get_minecraft_command(), be-
cause forge installs it under a little different name. Use find_forge_version() to get the right version id for the
launch.
3.6 Install Fabric
This tutorial shows how to install forge using minecraft-launcher-lib.
3.6.1 Install Fabric
Installing Fabric is very easy. Let’s say you want to install Fabric for 1.17:
minecraft_launcher_lib.fabric.install_fabric("1.17", minecraft_directoy)
install_fabric() supports the same callbacks as install_minecraft_version().
3.6.2 Launch Fabric
Use get_installed_versions() to get a list of all installed versions. Your new installed fabric version should be
in the list. You can launch it like any other Minecraft version.
3.7 Custom Types
You will see types like e.g MinecraftOptions or MinecraftVersionInfo. They are defined in types and microsoft_types.
They are all normal Dicts. Let’s take a look at MinecraftVersionInfo:
class MinecraftVersionInfo(TypedDict):
id: str
type: str
releaseTime: datetime.datetime
It means the following: This function returns a Dict with these keys:
• id: A string
• type: A string
3.6. Install Fabric 13

• releaseTime: A datetime.datetime
This type definition is just there to help your IDE. The function itself returns just a normal Dict.
version_list = minecraft_launcher_lib.utils.get_version_list()
print(version_list[0]["id"])
print(type(version_list[0]))
# <class 'dict'>
As said above, it is there to help your IDE. When the function definition just say, that it returns a Dict, your IDE will
not know what the Dict contains. But when using a TypedDict, your IDE, will exactly know what the Dict contains and
can offer your better autocompletion and a better type checking.
You can even use it when you are calling a function:
options: minecraft_launcher_lib.types.MinecraftOptions = {}
options["username"] = "Test123"
When using a IDE, you will see that it will start autocompleting the keys of the Dict while writing.
For more information about TypedDict see PEP 589.
3.8 Getting Help
Here are some sources if you need more information.

• This documentation contains under modules a list of modules with every function you can use. You should check
it out. You can test the functions in a interactive Python Shell.
• Check out the Examples on Codeberg.
• You can check out the source of the programs in the Showcase.
• If none of them above help, feel free to open a Issue.
CHAPTER
FOUR
MODULES
4.1 command
command contains the function for creating the minecraft command

get_minecraft_command(version: str, minecraft_directory: str | PathLike, options: MinecraftOptions) → List[str]
Returns the command for running minecraft as list. The given command can be executed with subprocess. Use
get_minecraft_directory() to get the default Minecraft directory.
Parameters
• version (str) – The Minecraft version
• minecraft_directory (str | PathLike) – The path to your Minecraft directory
• options (MinecraftOptions) – Some Options (see below)
Return type
List[str]
options is a dict:
options = {
# This is needed
"username": The Username,
"uuid": uuid of the user,
"token": the accessToken,
# This is optional
"executablePath": "java", # The path to the java executable
"defaultExecutablePath": "java", # The path to the java executable if the␣
˓→version.json has none
"jvmArguments": [], #The jvmArguments

"launcherName": "minecraft-launcher-lib", # The name of your launcher
"launcherVersion": "1.0", # The version of your launcher
"gameDirectory": "/home/user/.minecraft", # The gameDirectory (default is the␣
˓→path given in arguments)
"demo": False, # Run Minecraft in demo mode

"customResolution": False, # Enable custom resolution
"resolutionWidth": "854", # The resolution width
"resolutionHeight": "480", # The resolution heigth
"server": "example.com", # The IP of a server where Minecraft connect to after␣
˓→start
"port": "123", # The port of a server where Minecraft connect to after start
"nativesDirectory": "minecraft_directory/versions/version/natives", # The␣
15

˓→ natives directory
"enableLoggingConfig": False, # Enable use of the log4j configuration file
"disableMultiplayer": False, # Disables the multiplayer
"disableChat": False, # Disables the chat
"quickPlayPath": None, # The Quick Play Path
"quickPlaySingleplayer": None, # The Quick Play Singleplayer
"quickPlayMultiplayer": None, # The Quick Play Multiplayer
"quickPlayRealms": None, # The Quick Play Realms
}
You can use the microsoft_account module to get the needed information. For more information about the options
take a look at the More Launch Options tutorial.
View the source code of this module
4.2 install
install allows you to install minecraft.

install_minecraft_version(versionid: str, minecraft_directory: str | PathLike, callback: CallbackDict | None
= None) → None
Installs a minecraft version into the given path. e.g. install_version("1.14", "/tmp/minecraft"). Use
get_minecraft_directory() to get the default Minecraft directory.
Parameters
• versionid (str) – The Minecraft version
• callback (CallbackDict | None) – Some functions that are called to monitor the
progress (see below)
Raises
• VersionNotFound – The Minecraft version was not found
• FileOutsideMinecraftDirectory – A File should be placed outside the given Minecraft
directory
Return type
None
callback is a dict with functions that are called with arguments to get the progress. You can use it to show the
progress to the user.
callback = {
"setStatus": some_function, # This function is called to set a text
"setProgress" some_function, # This function is called to set the progress.
"setMax": some_function, # This function is called to set to max progress.
}
Files that are already exists will not be replaced.

16 Chapter 4. Modules
4.3 natives
natives contains a function for extracting natives libraries to a specific folder

extract_natives(versionid: str, path: str | PathLike, extract_path: str) → None
Extract all native libraries from a version into the given directory. The directory will be created, if it does not
exist.
Parameters
• version – The Minecraft version
• minecraft_directory – The path to your Minecraft directory
• callback – The same dict as for install_minecraft_version()
• versionid (str) –
• path (str | PathLike) –
• extract_path (str) –
Raises
• VersionNotFound – The Minecraft version was not found
directory
Return type
None
The natives are all extracted while installing. So you don’t need to use this function in most cases.
4.4 microsoft_account
microsoft_account contains functions for login with a Microsoft Account. Before using this module you need to create
a Azure application. Many thanks to wiki.vg for it’s documentation of the login process. You may want to read the
Microsoft Login tutorial before using this module. For a list of all types see microsoft_types.
get_login_url(client_id: str, redirect_uri: str) → str
Generate a login url.For a more secure alternative, use get_secure_login_data()
Parameters
• client_id (str) – The Client ID of your Azure App
• redirect_uri (str) – The Redirect URI of your Azure App
Returns
The url to the website on which the user logs in
Return type
str
generate_state() → str
Generates a random state
Return type
str
4.3. natives 17
get_secure_login_data(client_id: str, redirect_uri: str, state: str | None = None) → Tuple[str, str, str]
Generates the login data for a secure login with pkce and state.Prevents Cross-Site Request Forgery attacks and
authorization code injection attacks.
Parameters
• state (str | None) – You can use a existing state. If not set, a state will be generated
using generate_state().
Return type
Tuple[str, str, str]
url_contains_auth_code(url: str) → bool
Checks if the given url contains a authorization code
Parameters
url (str) – The URL to check
Return type
bool
get_auth_code_from_url(url: str) → str | None
Get the authorization code from the url.If you want to check the state, use parse_auth_code_url(), which
throws errors instead of returning an optional value.
Parameters
url (str) – The URL to parse
Returns
The auth code or None if the the code is nonexistent
Return type
str | None
parse_auth_code_url(url: str, state: str | None) → str
Parse the authorization code url and checks the state.
Parameters
• url (str) – The URL to parse
• state (str | None) – If set, the function raises a AssertionError, if the state do no match
the state in the URL
Returns
The auth code
Return type
str
get_authorization_token(client_id: str, client_secret: str | None, redirect_uri: str, auth_code: str,
code_verifier: str | None = None) → AuthorizationTokenResponse
Get the authorization token. This function is called during complete_login(), so you need to use this function
ony if complete_login() doesnt’t work for you.
Parameters
• client_secret (str | None) – The Client Secret of your Azure App. This is deprecated
and should not been used anymore.
• auth_code (str) – The Code you get from parse_auth_code_url()
• code_verifier (str | None) – The 3rd entry in the Tuple you get from
get_secure_login_data()
Return type
AuthorizationTokenResponse
refresh_authorization_token(client_id: str, client_secret: str | None, redirect_uri: str | None, refresh_token:
str) → AuthorizationTokenResponse
Refresh the authorization token. This function is called during complete_refresh(), so you need to use this
function ony if complete_refresh() doesnt’t work for you.
Parameters
• redirect_uri (str | None) – The Redirect URI of Azure App. This Parameter only
exists for backwards compatibility and is not used anymore.
• refresh_token (str) – Your refresh token
Return type
AuthorizationTokenResponse
authenticate_with_xbl(access_token: str) → XBLResponse
Authenticate with Xbox Live. This function is called during complete_login(), so you need to use this func-
tion ony if complete_login() doesnt’t work for you.
Parameters
access_token (str) – The Token you get from get_authorization_token()
Return type
XBLResponse
authenticate_with_xsts(xbl_token: str) → XSTSResponse
Authenticate with XSTS. This function is called during complete_login(), so you need to use this function
Parameters
xbl_token (str) – The Token you get from authenticate_with_xbl()
Return type
XSTSResponse
authenticate_with_minecraft(userhash: str, xsts_token: str) → MinecraftAuthenticateResponse
Authenticate with Minecraft. This function is called during complete_login(), so you need to use this function
Parameters
• userhash (str) – The Hash you get from authenticate_with_xbl()
• xsts_token (str) – The Token you get from authenticate_with_xsts()
4.4. microsoft_account 19
Return type
MinecraftAuthenticateResponse
get_store_information(access_token: str) → MinecraftStoreResponse
Get the store information.
Parameters
access_token (str) – The Token you get from authenticate_with_minecraft()
Return type
MinecraftStoreResponse
get_profile(access_token: str) → MinecraftProfileResponse
Get the profile. This function is called during complete_login(), so you need to use this function ony if
complete_login() doesnt’t work for you.
Parameters
access_token (str) – The Token you get from authenticate_with_minecraft()
Return type
MinecraftProfileResponse
complete_login(client_id: str, client_secret: str | None, redirect_uri: str, auth_code: str, code_verifier: str | None
= None) → CompleteLoginResponse
Do the complete login process.
Parameters
• auth_code (str) – The Code you get from parse_auth_code_url()
• code_verifier (str | None) – The 3rd entry in the Tuple you get from
get_secure_login_data()
Raises
• AzureAppNotPermitted – Your Azure App don’t have the Permission to use the Minecraft
API
• AccountNotOwnMinecraft – The Account does not own Minecraft
Return type
CompleteLoginResponse
It returns the following:
{
"id" : "The uuid",
"name" : "The username",
"access_token": "The acces token",
"refresh_token": "The refresh token",
"skins" : [{
"id" : "6a6e65e5-76dd-4c3c-a625-162924514568",
"state" : "ACTIVE",
"url" : "http://textures.minecraft.net/texture/
˓→1a4af718455d4aab528e7a61f86fa25e6a369d1768dcb13f7df319a713eb810b",

"variant" : "CLASSIC",
"alias" : "STEVE"
} ],
"capes" : []
}
complete_refresh(client_id: str, client_secret: str | None, redirect_uri: str | None, refresh_token: str) →
Do the complete login process with a refresh token. It returns the same as complete_login().
Parameters
• redirect_uri (str | None) – The Redirect URI of Azure App. This Parameter only
exists for backwards compatibility and is not used anymore.
• refresh_token (str) – Your refresh token
Raises
• InvalidRefreshToken – Your refresh token is not valid
• AccountNotOwnMinecraft – The Account does not own Minecraft
Return type
4.5 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
Return type
str
get_latest_version() → LatestMinecraftVersions
Returns the latest version of Minecraft
Return type
LatestMinecraftVersions
get_version_list() → List[MinecraftVersionInfo]
Returns all versions that Mojang offers to download
Return type
List[MinecraftVersionInfo]
get_installed_versions(minecraft_directory: str | PathLike) → List[MinecraftVersionInfo]
Returns all installed versions
4.5. utils 21
Parameters
minecraft_directory (str | PathLike) – The path to your Minecraft directory
Return type
get_available_versions(minecraft_directory: str | PathLike) → List[MinecraftVersionInfo]
Returns all installed versions and all versions that Mojang offers to download
Parameters
Return type
get_java_executable() → str
Tries the find out the path to the default java executable
Return type
str
get_library_version() → str
Returns the version of minecraft-launcher-lib
Return type
str
generate_test_options() → MinecraftOptions
Generates options to launch minecraft. Useful for testing. Do not use in production.
Return type
MinecraftOptions
is_version_valid(version: str, minecraft_directory: str | PathLike) → bool
Checks if the given version exists
Parameters
• version (str) – A Minecraft version
Return type
bool
get_minecraft_news(page_size: int = 20) → Articles
Get the news from minecraft.net
Parameters
page_size (int) – The Page Size (default 20)
Return type
Articles
is_vanilla_version(version: str) → bool
Checks if the given version is a vanilla version
Parameters
version (str) – A Minecraft version
Return type
bool
is_platform_supported() → bool
Checks if the current platform is supported
Return type
bool
is_minecraft_installed(minecraft_directory: str | PathLike) → bool
Checks, if there is already a existing Minecraft Installation in the given Directory
Parameters
Returns
Is a Installation is found
Return type
bool
4.6 java_utils
java_utils contains some functions to help with Java

get_java_information(path: str | PathLike) → JavaInformation
Returns Some Information about the given Java Installation
Parameters
path (str | PathLike) – The Path to the Installation. It must be the Directory. If your
Java executbale is e.g. /usr/lib/jvm/java-19-openjdk-amd64/bin/java this Parameter must be
/usr/lib/jvm/java-19-openjdk-amd64.
Returns
A dict with Information about the given java installation
Return type
JavaInformation
Raises a ValueError on the worng Path
Note: This Function executes the Java executable to detemine details such as the version. This might be a
security risk.
find_system_java_versions(additional_directories: List[str | PathLike] | None = None) → List[str]

Try to find all Java Versions installed on the System. You can use this to e.g. let the User choose between different
Java Versions in a Dropdown.
Parameters
additional_directories (List[str | PathLike] | None) – A List of additional Direc-
tories to search for Java in custom locations
Returns
A List with all Directories of Java Installations
Return type
List[str]
macOS is not supported yet
4.6. java_utils 23
find_system_java_versions_information(additional_directories: List[str | PathLike] | None = None) →

List[JavaInformation]
Same as find_system_java_version(), but uses get_java_information() to get some Information about
the Installation instead of just proving a Path.
Parameters
additional_directories (List[str | PathLike] | None) – A List of additional Direc-
tories to search for Java in custom locations
Returns
A List with Information of Java Installations
Return type
List[JavaInformation]
macOS is not supported yet
Note: This Function executes the Java executable to detemine details such as the version. This might be a
security risk.
4.7 forge
Note: Before using this module, please read this comment from the forge developers:
Please do not automate the download and installation of Forge.

Our efforts are supported by ads from the download page.
If you MUST automate this, please consider supporting the project through https://www.
˓→patreon.com/LexManos/
It’s your choice, if you want to respect that and support forge.
forge contains functions for dealing with the Forge modloader

install_forge_version(versionid: str, path: str | PathLike, callback: CallbackDict | None = None, java: str |
PathLike | None = None) → None
Installs the given Forge version
Parameters
• versionid (str) – A Forge Version. You can get a List of Forge versions using
list_forge_versions()
• path (str | PathLike) – The path to your Minecraft directory
• callback (CallbackDict | None) – The same dict as for
install_minecraft_version()
• java (str | PathLike | None) – A Path to a custom Java executable
Return type
None
Raises a VersionNotFound exception when the given forge version is not found
run_forge_installer(version: str, java: str | PathLike | None = None) → None

Run the forge installer of the given forge version
Parameters
• version (str) – A Forge Version. You can get a List of Forge versions using
list_forge_versions()
Return type
None
list_forge_versions() → List[str]
Returns a list of all forge versions
Return type
List[str]
find_forge_version(vanilla_version: str) → str | None
Find the latest forge version that is compatible to the given vanilla version
Parameters
vanilla_version (str) – A vanilla Minecraft version
Return type
str | None
is_forge_version_valid(forge_version: str) → bool
Checks if a forge version is valid
Parameters
forge_version (str) – A Forge Version
Return type
bool
supports_automatic_install(forge_version: str) → bool
Checks if install_forge_version() supports the given forge version
Parameters
Return type
bool
forge_to_installed_version(forge_version: str) → str
Returns the Version under which Forge will be installed from the given Forge version.
Parameters
Return type
str
Raises a ValueError if the Version is invalid.
4.7. forge 25
4.8 fabric
fabric contains functions for dealing with the Fabric modloader

get_all_minecraft_versions() → List[FabricMinecraftVersion]
Returns all available Minecraft Versions for Fabric
Return type
List[FabricMinecraftVersion]
get_stable_minecraft_versions() → List[str]
Returns a list which only contains the stable Minecraft versions that supports Fabric
Return type
List[str]
get_latest_minecraft_version() → str
Returns the latest unstable Minecraft versions that supports Fabric. This could be a snapshot.
Return type
str
get_latest_stable_minecraft_version() → str
Returns the latest stable Minecraft version that supports Fabric
Return type
str
is_minecraft_version_supported(version: str) → bool
Checks if a Minecraft version supported by Fabric
Parameters
version (str) – A vanilla version
Return type
bool
get_all_loader_versions() → List[FabricLoader]
Returns all loader versions
Return type
List[FabricLoader]
get_latest_loader_version() → str
Get the latest loader version
Return type
str
get_latest_installer_version() → str
Returns the latest installer version
Return type
str
install_fabric(minecraft_version: str, minecraft_directory: str | PathLike, loader_version: str | None = None,
callback: CallbackDict | None = None, java: str | PathLike | None = None) → None
Installs the Fabric modloader.
Parameters
• minecraft_version (str) – A vanilla version that is supported by Fabric

• loader_version (str | None) – The fabric loader version. If not given it will use the
latest
Return type
None
Raises a UnsupportedVersion exception when the given minecraft version is not supported by Fabric.
4.9 quilt
quilt contains functions for dealing with the Quilt modloader.

You may have noticed, that the Functions are the same as in the fabric module. That’s because Quilt is a Fork of Fabric.
This module behaves exactly the same as the fabric module.
get_all_minecraft_versions() → List[QuiltMinecraftVersion]
Returns all available Minecraft Versions for Quilt
Return type
List[QuiltMinecraftVersion]
get_stable_minecraft_versions() → List[str]
Returns a list which only contains the stable Minecraft versions that supports Quilt
Return type
List[str]
get_latest_minecraft_version() → str
Returns the latest unstable Minecraft versions that supports Quilt. This could be a snapshot.
Return type
str
get_latest_stable_minecraft_version() → str
Returns the latest stable Minecraft version that supports Quilt
Return type
str
is_minecraft_version_supported(version: str) → bool
Checks if a Minecraft version supported by Quilt
Parameters
version (str) – A vanilla version
Return type
bool
4.9. quilt 27
get_all_loader_versions() → List[QuiltLoader]
Returns all loader versions
Return type
List[QuiltLoader]
get_latest_loader_version() → str
Get the latest loader version
Return type
str
get_latest_installer_version() → str
Returns the latest installer version
Return type
str
install_quilt(minecraft_version: str, minecraft_directory: str | PathLike, loader_version: str | None = None,
callback: CallbackDict | None = None, java: str | PathLike | None = None) → None
Installs the Quilt modloader.
Parameters
• minecraft_version (str) – A vanilla version that is supported by Quilt
• loader_version (str | None) – The Quilt loader version. If not given it will use the
latest
Raises
UnsupportedVersion – The given Minecraft version is not supported by Quilt
Return type
None
4.10 runtime
runtime allows to install the java runtime. This module is used by install_minecraft_version(), so you don’t
need to use it in your code most of the time.
get_jvm_runtimes() → List[str]
Returns a list of all jvm runtimes
Return type
List[str]
get_installed_jvm_runtimes(minecraft_directory: str | PathLike) → List[str]
Returns a list of all installed jvm runtimes
Parameters
Return type
List[str]
install_jvm_runtime(jvm_version: str, minecraft_directory: str | PathLike, callback: CallbackDict | None =
None) → None
Installs the given jvm runtime. callback is the same dict as in the install module.
Parameters
• jvm_version (str) – The Name of the JVM version
• callback (CallbackDict | None) – the same dict as for
Raises
• VersionNotFound – The given JVM Version was not found
directory
Return type
None
get_executable_path(jvm_version: str, minecraft_directory: str | PathLike) → str | None
Returns the path to the executable. Returns None if none is found.
Parameters
• jvm_version (str) – The Name of the JVM version
Return type
str | None
get_jvm_runtime_information(jvm_version: str) → JvmRuntimeInformation
Returns some Information about a JVM Version
Parameters
jvm_version (str) – A JVM Version
Raises
• VersionNotFound – The given JVM Version was not found
• VersionNotFound – The given JVM Version is not available on this Platform
Returns
A Dict with Information
Return type
JvmRuntimeInformation
get_version_runtime_information(version: str, minecraft_directory: str | PathLike) →
VersionRuntimeInformation | None
Returns inforation about the runtime used by a version
Parameters
• jvm_version – The Minecraft version
4.10. runtime 29
• version (str) –
Raises
VersionNotFound – The Minecraft version was not found
Returns
A Dict with Information. None if the vserion has no runtime information.
Return type
VersionRuntimeInformation | None
4.11 vanilla_launcher
vanilla_launcher contains some functions for interacting with the Vanilla Minecraft Launcher
load_vanilla_launcher_profiles(minecraft_directory: str | PathLike) → List[VanillaLauncherProfile]
Loads the profiles of the Vanilla Launcher from the given Minecraft directory
Parameters
minecraft_directory (str | PathLike) – The Minecraft directory
Returns
A List with the Profiles
Return type
List[VanillaLauncherProfile]
vanilla_launcher_profile_to_minecraft_options(vanilla_profile: VanillaLauncherProfile) →
MinecraftOptions
Converts a VanillaLauncherProfile into a Options dict, that can be used by install_minecraft_version().
You still need to add the Login Data to the Options before you can use it.
Parameters
vanilla_profile (VanillaLauncherProfile) – The profile as returned by
load_vanilla_launcher_profiles()
Raises
InvalidVanillaLauncherProfile – The given Profile is invalid
Returns
The Options Dict
Return type
MinecraftOptions
get_vanilla_launcher_profile_version(vanilla_profile: VanillaLauncherProfile) → str
Returns the Minecraft version of the VanillaProfile. Handles latest-release and latest-snapshot.
Parameters
vanilla_profile (VanillaLauncherProfile) – The Profile
Raises
Returns
The Minecraft version
Return type
str
add_vanilla_launcher_profile(minecraft_directory: str | PathLike, vanilla_profile: VanillaLauncherProfile)

→ None
Adds a new Profile to the Vanilla Launcher
Parameters
• minecraft_directory (str | PathLike) – The Minecraft directory
• vanilla_profile (VanillaLauncherProfile) – The new Profile
Raises
Return type
None
do_vanilla_launcher_profiles_exists(minecraft_directory: str | PathLike) → bool
Checks if profiles from the vanilla launcher can be found
Parameters
minecraft_directory (str | PathLike) – The Minecraft directory
Returns
If profiles exists
Return type
bool
4.12 mrpack
mrpack allows you to install Modpacks from the Mrpack Format

get_mrpack_information(path: 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: str | PathLike, minecraft_directory: str | PathLike, modpack_directory: str | PathLike |
None = None, callback: CallbackDict | None = None, mrpack_install_options:
MrpackInstallOptions | None = None) → None
Installs a .mrpack file
Parameters
• path (str | PathLike) – The Path the the .mrpack file
• minecraft_directory (str | PathLike) – he path to your Minecraft directory
• modpack_directory (str | PathLike | None) – If you want to install the Pack in an-
other Directory than your Minecraft directory, set it here.
4.12. mrpack 31

• mrpack_install_options (MrpackInstallOptions | None) – Some Options to in-
stall 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: str | PathLike) → str

Returns that Version that needs to be used with get_minecraft_command().
Parameters
path (str | PathLike) – The Path the the .mrpack file
Returns
The version
Return type
str
4.13 exceptions
exceptions contains all custom exceptions that can be raised by minecraft_launcher_lib

exception VersionNotFound(version: str)
Bases: ValueError
The given version does not exists
Parameters
version (str) –
Return type
None
version: str
The version that caused the exception
msg: str
A message to display
exception UnsupportedVersion(version: str)

Bases: ValueError
This Exception is raised when you try to run install_fabric() or install_quilt() with a unsupported
version
Parameters
version (str) –
Return type
None
version: str
The version that caused the exception
msg: str
A message to display
exception ExternalProgramError(command: List[str], stdout: bytes, stderr: bytes)
Bases: Exception
This Exception is raised when a external program failed
Parameters
• command (List[str]) –
• stdout (bytes) –
• stderr (bytes) –
Return type
None
command: List[str]
The command that caused the error
stdout: bytes
The stdout of the command
stderr: bytes
The stderr of the command
exception InvalidRefreshToken
Bases: ValueError
Raised when complete_refresh() is called with a invalid refresh token
exception InvalidVanillaLauncherProfile(profile: VanillaLauncherProfile)
Bases: ValueError
Raised when a function from the vanilla_launcher module is called with a invalid vanilla profile
Parameters
profile (VanillaLauncherProfile) –
Return type
None
profile: VanillaLauncherProfile
The invalid profile
4.13. exceptions 33
exception SecurityError(code: str, message: str)

Bases: Exception
Raised when something security related happens
Parameters
• code (str) –
• message (str) –
Return type
None
code: str
A Code to specify the Error
message: str
A Message to display
exception FileOutsideMinecraftDirectory(path: str, minecraft_directory: str)
Bases: SecurityError
Raised when a File should be placed outside the given Minecraft directory
Parameters
• path (str) –
• minecraft_directory (str) –
Return type
None
path: str
The Path of the File
minecraft_directory: str
The Minecraft directory of the File
exception InvalidChecksum(url: str, path: str, expected_checksum: str, actual_checksum: str)
Bases: SecurityError
Raised when a File did not match the Checksum
Parameters
• url (str) –
• path (str) –
• expected_checksum (str) –
• actual_checksum (str) –
Return type
None
url: str
The URL to the File with the wrong Checksum
path: str
The Path to the File with the wrong Checksum
expected_checksum: str
The expected Checksum
actual_checksum: str
The actual Checksum
exception AzureAppNotPermitted
Bases: Exception
Raised when you try to use a Azure App, that don’t have the Permission to use the Minecraft API. Take a look
at the For more information about the options take a look at the Microsoft Login tutorial to learn how to fix this.
Return type
None
exception PlatformNotSupported
Bases: Exception
Raised, when the current Platform is not supported by a feature
Return type
None
exception AccountNotOwnMinecraft
Bases: Exception
Raised by complete_login() and complete_login() when the Account does not own Minecraft
Return type
None
4.14 types
This module contains all Types for minecraft-launcher-lib. It may help your IDE. You don’t need to use this module
directly in your code. If you are not interested in static typing just ignore it. For more information about TypeDict see
PEP 589.
class MinecraftOptions
Bases: TypedDict
username: str
uuid: str
token: str
executablePath: str
defaultExecutablePath: str
jvmArguments: List[str]
launcherName: str
launcherVersion: str
gameDirectory: str
4.14. types 35
demo: bool
customResolution: bool
resolutionWidth: str
resolutionHeight: str
server: str
port: str
nativesDirectory: str
enableLoggingConfig: bool
disableMultiplayer: bool
disableChat: bool
quickPlayPath: str | None
quickPlaySingleplayer: str | None
quickPlayMultiplayer: str | None
quickPlayRealms: str | None
class CallbackDict
Bases: TypedDict
setStatus: Callable[[str], None]
setProgress: Callable[[int], None]
setMax: Callable[[int], None]
class LatestMinecraftVersions
Bases: TypedDict
release: str
snapshot: str
class MinecraftVersionInfo
Bases: TypedDict
id: str
type: str
releaseTime: datetime
complianceLevel: int
class FabricMinecraftVersion
Bases: TypedDict
version: str
stable: bool
class FabricLoader
Bases: TypedDict
separator: str
build: int
maven: str
version: str
stable: bool
class QuiltMinecraftVersion
Bases: TypedDict
version: str
stable: bool
class QuiltLoader
Bases: TypedDict
separator: str
build: int
maven: str
version: str
class Image
Bases: dict
alt: str
videoURL: str
videoType: str
videoProvider: str
videoId: str
linkurl: str
background_color: Literal['bg-blue', 'bg-green', 'bg-red']
content_type: Literal['image', 'outgoing-link', 'video']
imageURL: str
class Tile
Bases: TypedDict
sub_header: str
image: Image
4.14. types 37
tile_size: Literal['1x1', '1x2', '2x1', '2x2', '4x2']
title: str
class Article
Bases: dict
preferred_tile: Tile
default_tile: Tile
articleLang: Literal['en-us']
primary_category: str
categories: List[str]
article_url: str
publish_date: str
tags: List[str]
class Articles
Bases: TypedDict
article_grid: List[Article]
article_count: int
class JavaInformation
Bases: TypedDict
path: str
name: str
version: str
java_path: str
javaw_path: str | None
is_64bit: bool
openjdk: bool
class VanillaLauncherProfileResolution
Bases: TypedDict
height: int
width: int
class VanillaLauncherProfile
Bases: TypedDict
name: str
version: str | None
versionType: Literal['latest-release', 'latest-snapshot', 'custom']
gameDirectory: str | None
javaExecutable: str | None
javaArguments: List[str] | None
customResolution: VanillaLauncherProfileResolution | None
class MrpackInformation
Bases: TypedDict
name: str
summary: str
versionId: str
formatVersion: int
minecraftVersion: str
optionalFiles: List[str]
class MrpackInstallOptions
Bases: TypedDict
optionalFiles: List[str]
skipDependenciesInstall: bool
class JvmRuntimeInformation
Bases: TypedDict
name: str
released: datetime
class VersionRuntimeInformation
Bases: TypedDict
name: str
javaMajorVersion: int
4.15 microsoft_types
This module contains all Types for the microsoft_account module. It has it’s own module because of the many types
needed that are not used somewhere else.
class AuthorizationTokenResponse
Bases: TypedDict
access_token: str
4.15. microsoft_types 39
token_type: Literal['Bearer']
expires_in: int
scope: str
refresh_token: str
class XBLResponse
Bases: TypedDict
IssueInstant: str
NotAfter: str
Token: str
DisplayClaims: _DisplayClaims
class XSTSResponse
Bases: TypedDict
IssueInstant: str
NotAfter: str
Token: str
DisplayClaimns: _DisplayClaims
class MinecraftStoreResponse
Bases: TypedDict
signature: str
keyId: str
class MinecraftAuthenticateResponse
Bases: TypedDict
username: str
roles: List[Any]
access_token: str
token_type: str
expires_in: int
class MinecraftProfileResponse
Bases: TypedDict
id: str
name: str
skins: List[_MinecraftProfileSkin]
capes: List[_MinecraftProfileCape]
error: str
errorMessage: str
class CompleteLoginResponse
Bases: dict
access_token: str
refresh_token: str
id: str
name: str
skins: List[_MinecraftProfileSkin]
capes: List[_MinecraftProfileCape]
error: str
errorMessage: str
4.15. microsoft_types 41
CHAPTER
FIVE
FAQ
Q: Which Minecraft versions are supported?

A: minecraft-launcher-lib supports all Minecraft versions that the official Launcher from Mojang supports. It
provides automatic installation for Vanilla, Forge and Fabric. Other versions can be launched after they got
installed in other ways.
Q: Which Python versions are supported?
A: minecraft-launcher-lib supports at the moment Python 3.8 and above. PyPy is also official supported.
Q: Which Operating Systems are supported?
A: minecraft-launcher-lib official supports Windows, macOS and Linux, which are the Operating Systems that
also supported by Mojang. It might work on other OS, but there is no guaranty.
Q: Can I use minecraft-launcher-lib in my project?
A: minecraft-launcher-lib is licensed under BSD 2-Clause what means it is OpenSource and it can be used in
any of your projects. For more information check out the license.
Q: How can I make a cracked launcher?
A: Just buy Minecraft. It’s cheaper than a AAA title and brings years of fun.
Q: Is the API stable?
A: All functions that are documented here are stable.
Q: Minecraft does not start
A: Please visit Troubleshooting.
Q: Minecraft is creating a logs folder inside my project directory
A: Minecraft is using the working directory for it’s logs. You should run Minecraft with a other working directory.
Q: I get a AzureAppNotPermitted Exception
A: Please take a look at the Microsoft Login tutorial
Q: Does minecraft-launcher-lib supports the Bedrock Edition?
A: Only the Java Edition is supported and there are no plans to support Bedrock
43
44 Chapter 5. FAQ
CHAPTER
SIX
EXAMPLES
6.1 PyQtLauncherWithOutput
#!/usr/bin/env python3
# This example shows a simple launcher with PyQt that shows the output of Minecraft in a␣
˓→text filed
from PyQt6.QtWidgets import QApplication, QWidget, QPlainTextEdit, QLabel, QLineEdit,␣

˓→QPushButton, QComboBox, QMessageBox, QHBoxLayout, QVBoxLayout
from PyQt6.QtCore import QProcess

import sys
class GameOutputWidget(QPlainTextEdit):
def __init__(self, launch_button):
super().__init__()
self.setReadOnly(True)
self.launch_button = launch_button
# Disable line wrap
self.setLineWrapMode(QPlainTextEdit.LineWrapMode.NoWrap)
def display_output(self):
# This function displays the output of Minecraft in the text field
cursor = self.textCursor()
cursor.movePosition(cursor.MoveOperation.End)
cursor.insertText(bytes(self.process.readAll()).decode())
cursor.movePosition(cursor.MoveOperation.End)
self.ensureCursorVisible()
def execute_command(self, command):

# QProcess.start takes as first argument the program and as second the list of␣
˓→arguments
# So we need the filter the program from the command

arguments = command[1:]
# Deactivate the launch button
self.launch_button.setEnabled(False)
# Clear the text field
self.setPlainText("")
self.process = QProcess(self)
# Activate the launch button when Minecraft is closed
45

self.process.finished.connect(lambda: self.launch_button.setEnabled(True))
# Connect the function to display the output
self.process.readyRead.connect(self.dataReady)
# Start Minecraft
self.process.start("java", arguments)
class MainWindow(QWidget):
def __init__(self):
super().__init__()
self.username_edit = QLineEdit()
self.password_edit = QLineEdit()
self.version_select = QComboBox()
launch_button = QPushButton("Launch")
self.output_widget = GameOutputWidget(launch_button)
# Set the password field to display *

self.password_edit.setEchoMode(QLineEdit.EchoMode.Password)
launch_button.clicked.connect(self.launch_minecraft)
# Add all versions to the Version ComboBox

self.minecraft_directory = minecraft_launcher_lib.utils.get_minecraft_directory()
for i in minecraft_launcher_lib.utils.get_available_versions(self.minecraft_
˓→directory):
# Only add release versions

if i["type"] == "release":
self.version_select.addItem(i["id"])
# Create the layouts

bottom_layout = QHBoxLayout()
bottom_layout.addWidget(QLabel("Username:"))
bottom_layout.addWidget(self.username_edit)
bottom_layout.addWidget(QLabel("Password:"))
bottom_layout.addWidget(self.password_edit)
bottom_layout.addWidget(QLabel("Version:"))
bottom_layout.addWidget(self.version_select)
bottom_layout.addWidget(launch_button)
main_layout = QVBoxLayout()
main_layout.addWidget(self.output_widget)
main_layout.addLayout(bottom_layout)
self.setLayout(main_layout)
self.setGeometry(0, 0, 800, 600)
self.setWindowTitle("PyQt Launcher with Output")
def launch_minecraft(self):
# Get the selected version
version = self.version_select.currentText()
# Make sure the version is installed

46 Chapter 6. Examples

minecraft_launcher_lib.install.install_minecraft_version(version, self.minecraft_
˓→directory)
# Login
login_data = minecraft_launcher_lib.account.login_user(self.username_edit.text(),
˓→ self.password_edit.text())
# Check if the login is correct

if "errorMessage" in login_data:
message_box = QMessageBox()
message_box.setWindowTitle("Invalid credentials")
message_box.setText("Invalid username or password")
message_box.setStandardButtons(QMessageBox.StandardButtons.Ok)
message_box.exec()
return
options = {
"username": login_data["selectedProfile"]["name"],
"uuid": login_data["selectedProfile"]["id"],
"token": login_data["accessToken"]
}
# Get the command

command = minecraft_launcher_lib.command.get_minecraft_command(version, self.
# Call the function from the

self.output_widget.execute_command(command)
def main():
app = QApplication(sys.argv)
w = MainWindow()
w.show()
sys.exit(app.exec())
if __name__ == "__main__":
main()
View this example on Codeberg
6.1. PyQtLauncherWithOutput 47
6.2 TkinterLauncher
# This example shows how to write a basic launcher with Tkinter.
from tkinter import Tk, Label, Entry, Button, mainloop
from tkinter.ttk import Combobox
import subprocess
import sys
def main():
def launch():
window.withdraw()
minecraft_launcher_lib.install.install_minecraft_version(version_select.get(),␣
˓→minecraft_directory)
login_data = minecraft_launcher_lib.account.login_user(username_input.get(),␣
˓→password_input.get())
options = {
"username": login_data["selectedProfile"]["name"],
"uuid": login_data["selectedProfile"]["id"],
"token": login_data["accessToken"]
}
minecraft_command = minecraft_launcher_lib.command.get_minecraft_command(version_
˓→select.get(), minecraft_directory, options)
subprocess.run(minecraft_command)
sys.exit(0)
window = Tk()
window.title("Minecraft Launcher")
Label(window, text="Username:").grid(row=0, column=0)

username_input = Entry(window)
username_input.grid(row=0, column=1)
Label(window, text="Password:").grid(row=1, column=0)
password_input = Entry(window)
password_input.grid(row=1, column=1)
versions = minecraft_launcher_lib.utils.get_available_versions(minecraft_directory)
version_list = []
for i in versions:
version_list.append(i["id"])
Label(window, text="Version:").grid(row=2, column=0)

version_select = Combobox(window, values=version_list)

version_select.grid(row=2, column=1)
version_select.current(0)
Button(window, text="Launch", command=launch).grid(row=4, column=1)
mainloop()
if __name__ == "__main__":
main()
6.3 ForgeInstall
# This example shows how to install forge using minecraft-launcher-lib
import sys
def ask_yes_no(text: str) -> bool:

while True:
answer = input(text + " [y|n]")
if answer.lower() == "y":
return True
elif answer.lower() == "n":
return False
else:
print("Please enter y or n")
def main():
vanilla_version = input("Select the Minecraft version for which you want to install␣
˓→forge:")
# Find the latest forge version for that Minecraft version

forge_version = minecraft_launcher_lib.forge.find_forge_version(vanilla_version)
# Checks if a forge version exists for that version
if forge_version is None:
print("This Minecraft version is not supported by forge")
sys.exit(0)
# Checks if the version can be installed automatic
if minecraft_launcher_lib.forge.supports_automatic_install(forge_version):
if ask_yes_no(f"Do you want to install forge {forge_version}?"):
callback = {
"setStatus": lambda text: print(text)
}
minecraft_launcher_lib.forge.install_forge_version(forge_version, minecraft_
˓→directory, callback=callback)
6.3. ForgeInstall 49

else:
print(f"Forge {forge_version} can't be installed automatic.")
if ask_yes_no("Do you want to run the installer?"):
minecraft_launcher_lib.forge.run_forge_installer(forge_version)
if __name__ == "__main__":
main()
6.4 PyQtInstallation
# This example shows how to install Minecraft with a ProgressBar in PyQt
from PyQt6.QtWidgets import QApplication, QWidget, QLabel, QComboBox, QLineEdit,␣
˓→QPushButton, QProgressBar, QFileDialog, QFormLayout, QHBoxLayout, QVBoxLayout
from PyQt6.QtCore import QThread, pyqtSignal

import sys
class InstallThread(QThread):
progress_max = pyqtSignal("int")
progress = pyqtSignal("int")
text = pyqtSignal("QString")
def __init__(self) -> None:

QThread.__init__(self)
self._callback_dict = {
"setStatus": lambda text: self.text.emit(text),
"setMax": lambda max_progress: self.progress_max.emit(max_progress),
"setProgress": lambda progress: self.progress.emit(progress),
}
def set_data(self, version: str, directory) -> None:

self._version = version
self._directory = directory
def run(self) -> None:

minecraft_launcher_lib.install.install_minecraft_version(self._version, self._
˓→directory, callback=self._callback_dict)
class Window(QWidget):
def __init__(self) -> None:
super().__init__()
self._install_thread = InstallThread()

self._version_combo_box = QComboBox()
self._path_edit = QLineEdit()
self._path_browse_button = QPushButton("Browse")
self._progress_bar = QProgressBar()
self._install_single_thread_button = QPushButton("Install Single Thread")
self._install_multi_thread_button = QPushButton("Install Multi Thread")
for i in minecraft_launcher_lib.utils.get_version_list():
self._version_combo_box.addItem(i["id"])
self._path_edit.setText(minecraft_launcher_lib.utils.get_minecraft_directory())
self._progress_bar.setTextVisible(True)
self._install_thread.progress_max.connect(lambda maximum: self._progress_bar.

˓→setMaximum(maximum))
self._install_thread.progress.connect(lambda value: self._progress_bar.
˓→setValue(value))
self._install_thread.text.connect(lambda text: self._progress_bar.

˓→setFormat(text))
self._install_thread.finished.connect(self._install_thread_finished)
self._path_browse_button.clicked.connect(self._path_browse_button_clicked)
self._install_single_thread_button.clicked.connect(self._install_minecraft_
˓→single_thread)
self._install_multi_thread_button.clicked.connect(self._install_minecraft_multi_
˓→thread)
path_layout = QHBoxLayout()
path_layout.addWidget(self._path_edit)
path_layout.addWidget(self._path_browse_button)
form_layout = QFormLayout()
form_layout.addRow(QLabel("Version:"), self._version_combo_box)
form_layout.addRow(QLabel("Path:"), path_layout)
button_layout = QHBoxLayout()
button_layout.addWidget(self._install_single_thread_button)
button_layout.addWidget(self._install_multi_thread_button)
main_layout = QVBoxLayout()
main_layout.addLayout(form_layout)
main_layout.addWidget(self._progress_bar)
main_layout.addLayout(button_layout)
self.setLayout(main_layout)
self.setWindowTitle("PyQtInstallation")
def _install_thread_finished(self) -> None:

# This function is called after the Multi Thread Installation has been finished
self._install_single_thread_button.setEnabled(True)
self._install_multi_thread_button.setEnabled(True)
6.4. PyQtInstallation 51
def _path_browse_button_clicked(self) -> None:

path = QFileDialog.getExistingDirectory(self, directory=self._path_edit.text())
if path != "":
self._path_edit.setText(path)
def _install_minecraft_single_thread(self) -> None:

# This function installs Minecraft in the same Thread as the GUI
# This is much simpler than using a other Thread, but the GUI will freeze until␣
˓→the function is completed
callback = {
"setStatus": lambda text: self._progress_bar.setFormat(text),
"setProgress": lambda value: self._progress_bar.setValue(value),
"setMax": lambda maximum: self._progress_bar.setMaximum(maximum)
}
minecraft_launcher_lib.install.install_minecraft_version(self._version_combo_box.
˓→currentText(), self._path_edit.text(), callback=callback)
def _install_minecraft_multi_thread(self) -> None:

# This functions installs Minecraft on a other Thread than the GUI
# This is more complex than using the same Thread, but the GUI will not freeze
self._install_single_thread_button.setEnabled(False)
self._install_multi_thread_button.setEnabled(False)
self._install_thread.set_data(self._version_combo_box.currentText(), self._path_
˓→edit.text())
self._install_thread.start()
def main():
w = Window()
w.show()
if __name__ == "__main__":
main()
6.5 FabricInstall
# This example shows how to install fabric using minecraft-launcher-lib
import sys
def main():
vanilla_version = input("Select the Minecraft version for which you want to install␣
˓→fabric:")
if not minecraft_launcher_lib.fabric.is_minecraft_version_supported(vanilla_version):
print("This version is not supported by fabric")
sys.exit(0)
callback = {
"setStatus": lambda text: print(text)
}
minecraft_launcher_lib.fabric.install_fabric(vanilla_version, minecraft_directory,␣
if __name__ == "__main__":
main()
6.6 SimpleLaunch
# This example shows how to simple install and launch the latest version of Minecraft.
import subprocess
import sys
# Set the data for your Azure Application here. For more information look at the␣
˓→documentation.
CLIENT_ID = "YOUR CLIENT ID"

REDIRECT_URL = "YOUR REDIRECT URL"
# Get latest version

latest_version = minecraft_launcher_lib.utils.get_latest_version()["release"]
# Get Minecraft directory

# Make sure, the latest version of Minecraft is installed

minecraft_launcher_lib.install.install_minecraft_version(latest_version, minecraft_
˓→directory)
# Login
6.5. FabricInstall 53

login_url, state, code_verifier = minecraft_launcher_lib.microsoft_account.get_secure_
˓→login_data(CLIENT_ID, REDIRECT_URL)
print(f"Please open {login_url} in your browser and copy the url you are redirected into␣
˓→the prompt below.")
code_url = input()
# Get the code from the url

try:
auth_code = minecraft_launcher_lib.microsoft_account.parse_auth_code_url(code_url,␣
˓→state)
except AssertionError:
print("States do not match!")
sys.exit(1)
except KeyError:
print("Url not valid")
sys.exit(1)
# Get the login data

login_data = minecraft_launcher_lib.microsoft_account.complete_login(CLIENT_ID, None,␣
˓→REDIRECT_URL, auth_code, code_verifier)
# Get Minecraft command

options = {
"username": login_data["name"],
"uuid": login_data["id"],
"token": login_data["access_token"]
}
minecraft_command = minecraft_launcher_lib.command.get_minecraft_command(latest_version,␣
# Start Minecraft
subprocess.run(minecraft_command)
6.7 PyQtLoginWindow
# This example shows how to use the PyQt WebEngine for the Login
# It needs the PyQt6 and PyQt6-WebEngine packages
from PyQt6.QtWidgets import QApplication, QMessageBox
from PyQt6.QtWebEngineWidgets import QWebEngineView
from PyQt6.QtWebEngineCore import QWebEngineProfile
from PyQt6.QtCore import QUrl, QLocale
import json
import sys
import os
CLIENT_ID = "YOUR CLIENT ID"


REDIRECT_URL = "YOUR REDIRECT URL"
class LoginWindow(QWebEngineView):
def __init__(self):
super().__init__()
self.setWindowTitle("Login Window Example")
# Set the path where the refresh token is saved

self.refresh_token_file = os.path.join(os.path.dirname(os.path.realpath(__file__
˓→)), "refresh_token.json")
# Login with refresh token, if it exists

if os.path.isfile(self.refresh_token_file):
with open(self.refresh_token_file, "r", encoding="utf-8") as f:
refresh_token = json.load(f)
# Do the login with refresh token
try:
account_informaton = minecraft_launcher_lib.microsoft_account.
˓→complete_refresh(CLIENT_ID, None, REDIRECT_URL, refresh_token)
self.show_account_information(account_informaton)
# Show the window if the refresh token is invalid
except minecraft_launcher_lib.exceptions.InvalidRefreshToken:
pass
# Open the login url

login_url, self.state, self.code_verifier = minecraft_launcher_lib.microsoft_
˓→account.get_secure_login_data(CLIENT_ID, REDIRECT_URL)
self.load(QUrl(login_url))
# Connects a function that is called when the url changed

self.urlChanged.connect(self.new_url)
self.show()
def new_url(self, url: QUrl):

try:
# Get the code from the url
auth_code = minecraft_launcher_lib.microsoft_account.parse_auth_code_url(url.
˓→toString(), self.state)
# Do the login
account_information = minecraft_launcher_lib.microsoft_account.complete_
˓→login(CLIENT_ID, None, REDIRECT_URL, auth_code, self.code_verifier)
# Show the login information

self.show_account_information(account_information)
except AssertionError:
print("States do not match!")
except KeyError:
print("Url not valid")
def show_account_information(self, information_dict):

6.7. PyQtLoginWindow 55

information_string = f'Username: {information_dict["name"]}<br>'
information_string += f'UUID: {information_dict["id"]}<br>'
information_string += f'Token: {information_dict["access_token"]}<br>'
# Save the refresh token in a file

with open(self.refresh_token_file, "w", encoding="utf-8") as f:
json.dump(information_dict["refresh_token"], f, ensure_ascii=False, indent=4)
message_box = QMessageBox()
message_box.setWindowTitle("Account information")
message_box.setText(information_string)
message_box.setStandardButtons(QMessageBox.StandardButton.Ok)
message_box.exec()
# Exit the program

sys.exit(0)
if __name__ == "__main__":
# This line sets the language of the webpage to the system language
QWebEngineProfile.defaultProfile().setHttpAcceptLanguage(QLocale.system().name().
˓→split("_")[0])
w = LoginWindow()
6.8 Mrpack
# This example shows how use the mrpack module
import subprocess
import sys
import os
def ask_yes_no(text: str) -> bool:

while True:
answer = input(f"{text} [Y/N]: ").strip().upper()
if answer == "Y":
return True
elif answer == "N":
return False
else:
print("Invalid answer. Use Y or N.")

def main() -> None:
mrpack_path = input("Please enter the Path to your .mrpack File: ")
if not os.path.isfile(mrpack_path):
print(f"{mrpack_path} was not found", file=sys.stderr)
sys.exit(1)
try:
mrpack_information = minecraft_launcher_lib.mrpack.get_mrpack_information(mrpack_
˓→path)
except Exception:
print(f"{mrpack_path} is not a valid .mrpack File")
sys.exit(1)
# Print some Information

print("You have selected the following Pack:")
print("Name: " + mrpack_information["name"])
print("Summary: " + mrpack_information["summary"])
print("Minecraft version: " + mrpack_information["minecraftVersion"])
if not ask_yes_no("Do you want to install this Pack?"):

return
# Ask the User for the Directories

minecraft_directory = input("Please enter the Path to your Minecraft directory␣
˓→(leave empty for default): ")
if minecraft_directory == "":
modpack_directory = input("Please enter the Path to the Directory you want to␣
˓→install the Modpack (leave empty for your Minecraft directory): ")
if modpack_directory == "":
modpack_directory = minecraft_directory
# Adds the Optional Files

mrpack_install_options: minecraft_launcher_lib.types.MrpackInstallOptions = {
˓→"optionalFiles": []}
for i in mrpack_information["optionalFiles"]:
if ask_yes_no(f"The Pack includes the Optional File {i}. Do you want to install␣
˓→it?"):
mrpack_install_options["optionalFiles"].append(i)
# Install
print("Installing")
minecraft_launcher_lib.mrpack.install_mrpack(mrpack_path, minecraft_directory,␣
˓→modpack_directory=modpack_directory, mrpack_install_options=mrpack_install_options,␣
˓→callback={"setStatus": print})
print("Finished")
if not ask_yes_no("Do you want to start Minecraft?"):

6.8. Mrpack 57

return
# We skip the Login in this Example

options = minecraft_launcher_lib.utils.generate_test_options()
options["gameDirectory"] = modpack_directory
command = minecraft_launcher_lib.command.get_minecraft_command(minecraft_launcher_
˓→lib.mrpack.get_mrpack_launch_version(mrpack_path), minecraft_directory, options)
subprocess.run(command)
if __name__ == "__main__":
main()
6.9 InstallationProgress
# This example shows how to show the progress of installation to the user.
# Taken from https://stackoverflow.com/questions/3173320/text-progress-bar-in-the-console

def printProgressBar(iteration, total, prefix='', suffix='', decimals=1, length=100,␣
˓→fill='', printEnd="\r"):
"""
Call in a loop to create terminal progress bar
@params:
iteration - Required : current iteration (Int)
total - Required : total iterations (Int)
prefix - Optional : prefix string (Str)
suffix - Optional : suffix string (Str)
decimals - Optional : positive number of decimals in percent complete (Int)
length - Optional : character length of bar (Int)
fill - Optional : bar fill character (Str)
printEnd - Optional : end character (e.g. "\r", "\r\n") (Str)
"""
percent = ("{0:." + str(decimals) + "f}").format(100 * (iteration / float(total)))
filledLength = int(length * iteration // total)
bar = fill * filledLength + '-' * (length - filledLength)
print('\r%s |%s| %s%% %s' % (prefix, bar, percent, suffix), end=printEnd)
# Print New Line on Complete
if iteration == total:
print()
def maximum(max_value, value):

max_value[0] = value

def main():
# lambda doesn't allow setting vars, so we need this little hack
max_value = [0]
callback = {
"setStatus": lambda text: print(text),
"setProgress": lambda value: printProgressBar(value, max_value[0]),
"setMax": lambda value: maximum(max_value, value)
}
version = minecraft_launcher_lib.utils.get_latest_version()["release"]
directory = minecraft_launcher_lib.utils.get_minecraft_directory()
minecraft_launcher_lib.install.install_minecraft_version(version, directory,␣
if __name__ == "__main__":
main()
6.9. InstallationProgress 59
CHAPTER
SEVEN
TROUBLESHOOTING
Here is a quick checklist for you, if Minecraft doesn’t starts.

• Start the Version in the official Launcher
At first you should try to start the Minecraft version in official Launcher. If it didn’t start there, the
problem is not in minecraft-launcher-lib or your code.
• Call install_minecraft_version()
Before you start Minecraft, you should first call install_minecraft_version(). This function
ensures that everything is right and installs parts if needed. It should even be called, if you installed
a version with a installer e.g. Optifine.
• Use the subprocess module
There are many ways to call a shell command in Python. Maybe your GUI Tooolkit brings it’s own
function e.g. QProcess from Qt. But nor all of them supports a list of strings. To make sure this is not
the problem try to start the command with subproces.run(command). Do not use os.system().
• Check the Java version
While newer versions of Minecraft has a Java runtime version in it’s version.json, older versions don’t
have it. Some older versions requires a older Java version. Make sure to launch this old versions with
the right Java version. Check out the command module documentation to learn how to set the Java
version.
• Check your JVM Arguments
If you use custom JVM Arguments, make sure all of them start with - and not a other char e.g. a
whitespace.
If all of the steps above failed, please fill a Bug Report.
61
62 Chapter 7. Troubleshooting
CHAPTER
EIGHT
CONTRIBUTE
Many thanks for contributing to minecraft-launcher-lib! You can do the following thinks:
• You can test minecraft-launcher-lib with all versions and write a Bug report if something did not work
• You can help developing minecraft-launcher-lib. Check out the Develop section of the documentation.
• You can can improve the documentation. See Build and edit documentation.
• You can also update the Examples and add new one.
63
64 Chapter 8. Contribute
CHAPTER
NINE
DEVELOP
9.1 Testing changes
While there are automatic tests for the utils functions, the main part (installing launching and logging in into Microsoft)
must be tested by yourself.
Open a command line in the root directory of minecraft-launcher-lib and open the Python Interpreter. In the Interpreter
run:
>>> import minecraft_launcher_lib

>>> print(minecraft_launcher_lib.__file___)
It should print the path to your current directory. After you’ve confirmed, that you are using the version you are currently
working on, you can start testing.
Just run the functions you have changed and see, if everything worked correctly. Please test installation and launching
in a clean directory and not your normal .minecraft directory.
9.2 Codestyle
minecraft-launcher-lib uses PEP8 as it’s codestyle with the following additional rules:
• Lines longer than 80 chars are allowed. We are not in the 90s anymore. Any modern screen can display way
more than 80 chars per line without scrolling.
• All functions must have type annotations
• All functions must have docstrings
9.2.1 Check the Codestyle
minecraft-launcher-lib uses flake8 along with the flake8-annotation, the flake8-docstring-checker plugin, and the flake8-
assert-finder plugin to do a automatic style check. To get started, install it:
pip install flake8 flake8-annotation flake8-docstring-checker flake8-assert-finder
To run it, open a command line in the root directory of minecraft-launcher-lib and run:
flake8
If it prints nothing, everything is OK. If it prints something, you should fix it.
65
9.3 Automatic tests
minecraft-launcher-lib uses Pytest to run some automatic tests.
9.3.1 Using Pytest
To get started, install all test dependencies
pip install -r requirements-test.txt
To run the tests, open a command line in the root directory of minecraft-launcher-lib and execute:
pytest
If a test fails, you should fix the bug.
9.3.2 Test Coverage
To see a detailed test coverage report (which lines are executed during the tests), open htmlcov/index.html with
your browser.
9.4 Static typing
minecraft-launcher-lib uses mypy to enforce static typing.
9.4.1 Using mypy
To get started, install mypy together with requests and the types for requests:
pip install requests types-requests mypy
To run mypy open a command line in the root directory of minecraft-launcher-lib and execute:
mypy minecraft_launcher_lib
If mypy shows a error,or, you should fix it.
9.5 Build and edit documentation
minecraft-launcher-lib uses Sphinx for it’s documentation. The documentation is hosted on Read the Docs. You can
find the soucre files for the documentation in doc folder.
66 Chapter 9. Develop
9.5.1 Plugins
minecraft-launcher-lib uses the following Sphinx plugins:

• sphinx-reredirects: The module documentation has been moved in the modules directory. This Plugin creates
redirects, so older links will still work.
• sphinx-notfound-page: Used for setting the custom 404 page.
• sphinx-rtd-dark-mode: Provides the dark theme, that you can turn on by clicking on the button in the bottom
right corner.
• sphinx-copybutton: Provides the copy button on the code blocks
These plugins are all completely optional. You can build the documentation without having these plugins installed.
The features, that the plugins provide are missing in that case.
9.5.2 Building
First you need to install Sphinx and the Read the Docs theme:
pip install sphinx sphinx-rtd-theme
You can also install the plugins, if you want to e.g. test the dark mode.
To build the documentation open a command line in the doc folder and run:
# Unix based Systems

make html
# Windows
.\make.bat html
Now you can view the documentation by opening _build/html/index.html in your favourite browser.
9.5.3 Examples
The examples are stored in the examples folder. They are added to the documentation during build. Please do not edit
anything inside doc/examples. All files in this folder are overwritten during the build.
9.6 Making a Pull Request
minecraft-launcher-lib uses Codeberg as development platform. If you want to contribute some changes, a need to
make a Pull Request (PR) against the Codeberg repo of minecraft-launcher-lib. A merge request is the same as a Pull
Request on GitHub, which I think you should familiar with. It’s works exactly the same way.
Before making a MR, you should follow this checklist:
• minecraft-launcher-lib currently targets version 3.8 of Python and the latest version of PyPy. Make sure, you
don’t use features that were added in a newer Python version.
• Your code should work on Linux, Mac and Windows
• Please make sure, you follow the Codestyle
• If possible, you should not break existing code that uses minecraft-launcher-lib
• If you can write a test, for your changes, you should do it
9.6. Making a Pull Request 67

• You should update the documentation with your changes

• Please don’t add extra dependencies if not absolutely needed
After you’ve created a PR, flake8 and Pytest with all supported versions (including PyPy) will run. If one of those fails,
Codeberg will show it on the Website and you will get a mail.
Read the Docs is configured to build the documentation for each MR. Unfortunately, it will not provide a link or any
hint, if the build was successful. You will have to visit this site and search for your MR.
I’m looking forward to see your contribution and thanks in advance!
68 Chapter 9. Develop
CHAPTER
TEN
SHOWCASE
Here is a List of programs that uses minecraft-launcher-lib. If you want to add yours, feel free to make a PR on
Codeberg.
• jdMinecraftLauncher
• minecraft-launcher-cmd
69
70 Chapter 10. Showcase

CHAPTER
ELEVEN
CHANGELOG
11.1 6.4
• Added AccountNotOwnMinecraft exception
11.2 6.3
• Fixed #92
• Fixed #93
11.3 6.2
• Fix raising InvalidChecksum exception
11.4 6.1
• Added AzureAppNotPermitted exception

• Added is_minecraft_installed()
• Added callbacks to the mrpack module
• Fix some Bugs
11.5 6.0
• Added vanilla_launcher module

• Added mrpack module
• Added quilt module
• Added get_jvm_runtime_information()
• Added InvalidChecksum exception
• Remove account module (deprecated since 4.4 which was released 2022-02-16)
71
• Move module documentation into Code

• Change account type to msa
• Add support for Quick Play
• Add internal types
• Refactor Code
11.6 5.3
• Move minecraft-launcher-lib to Codeberg

• Add defaultExecutablePath option
• Add disableMultiplayer and disableChat options
• Change get_java_executable to use javaw.exe on Windows (osfanbuff63)
11.7 5.2
• Added a secure login option using pkce (get_secure_login_data)(Manuel Quarneti)

• Add forge_to_installed_version()
• Fix setMax callback
11.8 5.1
• Fix crash when custom clients use invalid releaseTime
11.9 5.0
• The minimum Python version is now 3.8

• All public APIs are now complety static typed (with help of Manuel Quarneti)
• minecraft-launcher-lib has now a py.typed file
• Installs now using requests.session for faster installing
• Add types and microsoft_types module
• Add is_platform_supported()
• Add get_installed_jvm_runtimes()
• The client secret is now optional for Microsoft Accounts
• Include release time in version list
• install_jvm_runtime() does now support symlinks
• Fix launching custom clients
72 Chapter 11. Changelog

11.10 4.6
• Add is_vanilla_version()
• Install version that is inherited from
• Fix command for 1.19-pre1
• Fix type annotations
• Cache requests
• Rewrite Maven parsing
11.11 4.5
• Fix Forge installation for 1.18 again (catnip)
11.12 4.4
• Fix Forge installation for 1.18

• Do not use bare except
• Add DeprecationWarning to the account module
11.13 4.3
• Add get_executable_path()
• Fix using Java Runtime on Windows
11.14 4.2
• Fix launching Forge 1.17.1
11.15 4.1
• Add get_minecraft_news()
• Replace deprecated distutils.spawn.find_executable() with shutil.which()
• Add support for using a custom Java runtime in different functions (BobDotCom)
• Fix Forge for 1.12.2
• Fix find_forge_version() (BobDotCom)
• Packages can now be built without requests being installed (BobDotCom)
• Fix finding Java runtime on Mac (BobDotCom)
11.10. 4.6 73
11.16 4.0
• Add Support for Microsoft Accounts

• All functions with a Path as Argument can now take a os.PathLike
• Fix crash in get_installed_versions() when a directory has no json file
• Fix Bug in install_forge_version()
11.17 3.6
• Fix install_forge_version() for 1.17.1
11.18 3.5
• Fix crash when logging is empty
11.19 3.4
• Add runtime module

• The runtime is now automatic installed if needed
11.20 3.3
• Add is_forge_version_valid()
• Add supports_automatic_install()
• Add UnsupportedVersion exception
• Add ExternalProgramError exception
• Add callbacks to install_fabric()
• Make install_forge_version() raise VersionNotFound exception
• Fix install_fabric()
• Better codestyle

11.21 3.2
• Use custom user agent for all requests

• Fix typo that causes crash (DiamondsBattle)
11.22 3.1
• Fix Bug in install_minecraft_version()
11.23 3.0
• Add fabric module

• install_minecraft_version supports now custom libraries urls
• Add VersionNotFound exception
• Add type annotations
• Add docstrings
• Add is_version_valid()
• Add generate_test_options()
11.24 2.1
• Add support for log4j configuration file

• Fix Bug with files in versions directory
11.25 2.0
• Add forge modul

• Add hash validation
11.26 1.4
• Fix downloading libraries on windows
11.21. 3.2 75
11.27 1.3
• Fix downloading libraries without url

• Fix get_available_versions()
• Improve get_java_executable()
11.28 1.2
• Fix Typo
11.29 1.1
• Fix Forge for older versions
11.30 1.0
• Add function to extract natives

• Add functions for upload and reset a skin
11.31 0.5
• Better support for older versions

• Add new functions to utils
11.32 0.4
• The natives are now extracted

• Fix running older versions of Forge
11.33 0.3
• The classpath has now the correct seperator on windows

• Add option to set the executable path
• Add support for {arch} in natives

11.34 0.2
• Add support for Forge

• Add more options
• Add callback functions
11.35 0.1
• First Release
11.34. 0.2 77

CHAPTER
TWELVE
HISTORY
I like the Design of the old Minecraft Launcher (2013-2016), but I don’t like the Design of the new one which was
released in 2016, so I kept using the old one. I was aware that the old Launcher is not going to be supported forever.
There are many 3rd party launcher out there so I thought: Why not writing my own Launcher that has the same GUI
as the old Launcher? So I started developing a Launcher in Python using QtWidgets from PyQt5. I chose Python,
because it’s an easy to use language. QtWidgets also allows me to write a classical styles user interface and is cross
platform as a Bonus. I finished the GUI soon. Everything except the launching was working. I looked how t do that,
but is was complicated and I run into a few problems, so I was looking for a library to do that or working Python code
that supports all edge cases. I haven’t found anything that was useable, so I decided to use mclauncher-api, which is a
Java library. I wrote a small wrapper program in Java that uses the lib and was called by my Launcher. I released it and
called it jdMinecraftLauncher, so it can also used by other who like the good old design.
I knew, this was not a good solution so I kept working on a Python code that can launch and install Minecraft. I was
able to archive this and install and launch the latest version at this time. I tried to use the code with older versions, but
I realized that the Way how to launch Minecraft changed a bit over time. I also got this part working. I remembered,
how hard it was for me to do this, so I decided to move all the functions that could also be used by others out of
jdMinecraftLauncher into a library. I am not very creative when it comes to names, so I just called the library minecraft-
launcher-lib, because it’s a library for Minecraft launchers. minecraft-launcher-lib was primarily made to meet the needs
of jdMinecraftLauncher, but I designed to library in a Way that it could be used by anyone out there and with any GUI
toolkit.
Version 0.1 was published on 2019-11-18 on GitLab together with a very minimalistic documentation and uploaded to
PyPI.
I kept working on it and added support for more and more Versions. I also tested the library more, as it was now
integreated in jdMinecraftLauncher. Version 1.0, which finally official supports all existing Versions was released on
2020-05-16.
After that, I added functions for automatically installing Forge, which was a lot of reverse engineering, and Farbric,
which is just downloading and executing the Installer. I also improved the Documentation and added tests using Pytest.
A big change came with the introduction of Microsoft Accounts. WIth old Mojang Accounts you just needed a User-
name and Password to log in. Now you need to create a Azure App before you can get started. The login also needs to
be done in a Web browser. This causes a lot of Problems.
It’s gotten even worse: Since 2023 you need to apply to get the Permission to use the Minecraft API. this makes it way
harder for people who want to try out this library.
Another big change happened in 2023: GitLab announces that inactive Repos will be deleted after one Year. This was
reversed later, but I felt like GitLab, which I was using since Microsoft bought GitHub, is no longer a good and safe
place for my Projects. So I looked for another Code hosting service and found Codeberg, which is non profit hosting
service for OpenSource Projects. After GitLab was blocking the CI for new Users, I decided that it was time to ditch
GitLab and moved the Repo to Codeberg.
79
80 Chapter 12. History

PYTHON MODULE INDEX
m
minecraft_launcher_lib.command, 15
minecraft_launcher_lib.exceptions, 32
minecraft_launcher_lib.fabric, 26
minecraft_launcher_lib.forge, 24
minecraft_launcher_lib.install, 16
minecraft_launcher_lib.java_utils, 23
minecraft_launcher_lib.microsoft_account, 17
minecraft_launcher_lib.microsoft_types, 39
minecraft_launcher_lib.mrpack, 31
minecraft_launcher_lib.natives, 17
minecraft_launcher_lib.quilt, 27
minecraft_launcher_lib.runtime, 28
minecraft_launcher_lib.types, 35
minecraft_launcher_lib.utils, 21
minecraft_launcher_lib.vanilla_launcher, 30
81
82 Python Module Index

INDEX
A complete_login() (in module

access_token (AuthorizationTokenResponse attribute), minecraft_launcher_lib.microsoft_account), 20
39 complete_refresh() (in module
access_token (CompleteLoginResponse attribute), 41 minecraft_launcher_lib.microsoft_account), 21
access_token (MinecraftAuthenticateResponse at- CompleteLoginResponse (class in
tribute), 40 minecraft_launcher_lib.microsoft_types),
AccountNotOwnMinecraft, 35 41
actual_checksum (InvalidChecksum attribute), 35 complianceLevel (MinecraftVersionInfo attribute), 36
add_vanilla_launcher_profile() (in module content_type (Image attribute), 37
minecraft_launcher_lib.vanilla_launcher), 30 customResolution (MinecraftOptions attribute), 36
alt (Image attribute), 37 customResolution (VanillaLauncherProfile attribute),
Article (class in minecraft_launcher_lib.types), 38 39
article_count (Articles attribute), 38 D
article_grid (Articles attribute), 38
default_tile (Article attribute), 38
article_url (Article attribute), 38
defaultExecutablePath (MinecraftOptions attribute),
articleLang (Article attribute), 38
35
Articles (class in minecraft_launcher_lib.types), 38
demo (MinecraftOptions attribute), 35
authenticate_with_minecraft() (in module
disableChat (MinecraftOptions attribute), 36
minecraft_launcher_lib.microsoft_account), 19
disableMultiplayer (MinecraftOptions attribute), 36
authenticate_with_xbl() (in module
DisplayClaimns (XSTSResponse attribute), 40
DisplayClaims (XBLResponse attribute), 40
authenticate_with_xsts() (in module
do_vanilla_launcher_profiles_exists() (in mod-
ule minecraft_launcher_lib.vanilla_launcher),
AuthorizationTokenResponse (class in
31
minecraft_launcher_lib.microsoft_types),
39 E
AzureAppNotPermitted, 35 enableLoggingConfig (MinecraftOptions attribute), 36
error (CompleteLoginResponse attribute), 41
B error (MinecraftProfileResponse attribute), 40
background_color (Image attribute), 37 errorMessage (CompleteLoginResponse attribute), 41
build (FabricLoader attribute), 37 errorMessage (MinecraftProfileResponse attribute), 41
build (QuiltLoader attribute), 37 executablePath (MinecraftOptions attribute), 35
expected_checksum (InvalidChecksum attribute), 34
C expires_in (AuthorizationTokenResponse attribute), 40
CallbackDict (class in minecraft_launcher_lib.types), expires_in (MinecraftAuthenticateResponse attribute),
36 40
capes (CompleteLoginResponse attribute), 41 ExternalProgramError, 33
capes (MinecraftProfileResponse attribute), 40 extract_natives() (in module
categories (Article attribute), 38 minecraft_launcher_lib.natives), 17
code (SecurityError attribute), 34
command (ExternalProgramError attribute), 33 F
FabricLoader (class in minecraft_launcher_lib.types),
83
37 get_latest_loader_version() (in module

FabricMinecraftVersion (class in minecraft_launcher_lib.fabric), 26
minecraft_launcher_lib.types), 36 get_latest_loader_version() (in module
FileOutsideMinecraftDirectory, 34 minecraft_launcher_lib.quilt), 28
find_forge_version() (in module get_latest_minecraft_version() (in module
minecraft_launcher_lib.forge), 25 minecraft_launcher_lib.fabric), 26
find_system_java_versions() (in module get_latest_minecraft_version() (in module
minecraft_launcher_lib.java_utils), 23 minecraft_launcher_lib.quilt), 27
find_system_java_versions_information() (in get_latest_stable_minecraft_version() (in mod-
module minecraft_launcher_lib.java_utils), 23 ule minecraft_launcher_lib.fabric), 26
forge_to_installed_version() (in module get_latest_stable_minecraft_version() (in mod-
minecraft_launcher_lib.forge), 25 ule minecraft_launcher_lib.quilt), 27
formatVersion (MrpackInformation attribute), 39 get_latest_version() (in module
minecraft_launcher_lib.utils), 21
G get_library_version() (in module
gameDirectory (MinecraftOptions attribute), 35 minecraft_launcher_lib.utils), 22
gameDirectory (VanillaLauncherProfile attribute), 39 get_login_url() (in module
generate_state() (in module minecraft_launcher_lib.microsoft_account), 17
minecraft_launcher_lib.microsoft_account), 17 get_minecraft_command() (in module
generate_test_options() (in module minecraft_launcher_lib.command), 15
minecraft_launcher_lib.utils), 22 get_minecraft_directory() (in module
get_all_loader_versions() (in module minecraft_launcher_lib.utils), 21
minecraft_launcher_lib.fabric), 26 get_minecraft_news() (in module
get_all_loader_versions() (in module minecraft_launcher_lib.utils), 22
minecraft_launcher_lib.quilt), 27 get_mrpack_information() (in module
get_all_minecraft_versions() (in module minecraft_launcher_lib.mrpack), 31
minecraft_launcher_lib.fabric), 26 get_mrpack_launch_version() (in module
get_all_minecraft_versions() (in module minecraft_launcher_lib.mrpack), 32
minecraft_launcher_lib.quilt), 27 get_profile() (in module
get_auth_code_from_url() (in module minecraft_launcher_lib.microsoft_account), 20
minecraft_launcher_lib.microsoft_account), 18 get_secure_login_data() (in module
get_authorization_token() (in module minecraft_launcher_lib.microsoft_account), 17
minecraft_launcher_lib.microsoft_account), 18 get_stable_minecraft_versions() (in module
get_available_versions() (in module minecraft_launcher_lib.fabric), 26
minecraft_launcher_lib.utils), 22 get_stable_minecraft_versions() (in module
get_executable_path() (in module minecraft_launcher_lib.quilt), 27
minecraft_launcher_lib.runtime), 29 get_store_information() (in module
get_installed_jvm_runtimes() (in module minecraft_launcher_lib.microsoft_account), 20
minecraft_launcher_lib.runtime), 28 get_vanilla_launcher_profile_version() (in
get_installed_versions() (in module module minecraft_launcher_lib.vanilla_launcher),
minecraft_launcher_lib.utils), 21 30
get_java_executable() (in module get_version_list() (in module
minecraft_launcher_lib.utils), 22 minecraft_launcher_lib.utils), 21
get_java_information() (in module get_version_runtime_information() (in module
minecraft_launcher_lib.java_utils), 23 minecraft_launcher_lib.runtime), 29
get_jvm_runtime_information() (in module
minecraft_launcher_lib.runtime), 29 H
get_jvm_runtimes() (in module height (VanillaLauncherProfileResolution attribute), 38
minecraft_launcher_lib.runtime), 28
get_latest_installer_version() (in module I
minecraft_launcher_lib.fabric), 26 id (CompleteLoginResponse attribute), 41
get_latest_installer_version() (in module id (MinecraftProfileResponse attribute), 40
minecraft_launcher_lib.quilt), 28 id (MinecraftVersionInfo attribute), 36
Image (class in minecraft_launcher_lib.types), 37
84 Index
image (Tile attribute), 37 launcherName (MinecraftOptions attribute), 35

imageURL (Image attribute), 37 launcherVersion (MinecraftOptions attribute), 35
install_fabric() (in module linkurl (Image attribute), 37
minecraft_launcher_lib.fabric), 26 list_forge_versions() (in module
install_forge_version() (in module minecraft_launcher_lib.forge), 25
minecraft_launcher_lib.forge), 24 load_vanilla_launcher_profiles() (in module
install_jvm_runtime() (in module minecraft_launcher_lib.vanilla_launcher), 30
minecraft_launcher_lib.runtime), 29
install_minecraft_version() (in module M
minecraft_launcher_lib.install), 16 maven (FabricLoader attribute), 37
install_mrpack() (in module maven (QuiltLoader attribute), 37
minecraft_launcher_lib.mrpack), 31 message (SecurityError attribute), 34
install_quilt() (in module minecraft_directory (FileOutsideMinecraftDirectory
minecraft_launcher_lib.quilt), 28 attribute), 34
InvalidChecksum, 34 minecraft_launcher_lib.command
InvalidRefreshToken, 33 module, 15
InvalidVanillaLauncherProfile, 33 minecraft_launcher_lib.exceptions
is_64bit (JavaInformation attribute), 38 module, 32
is_forge_version_valid() (in module minecraft_launcher_lib.fabric
minecraft_launcher_lib.forge), 25 module, 26
is_minecraft_installed() (in module minecraft_launcher_lib.forge
minecraft_launcher_lib.utils), 23 module, 24
is_minecraft_version_supported() (in module minecraft_launcher_lib.install
minecraft_launcher_lib.fabric), 26 module, 16
is_minecraft_version_supported() (in module minecraft_launcher_lib.java_utils
minecraft_launcher_lib.quilt), 27 module, 23
is_platform_supported() (in module minecraft_launcher_lib.microsoft_account
is_vanilla_version() (in module minecraft_launcher_lib.microsoft_types
is_version_valid() (in module minecraft_launcher_lib.mrpack
IssueInstant (XBLResponse attribute), 40 minecraft_launcher_lib.natives
IssueInstant (XSTSResponse attribute), 40 module, 17
minecraft_launcher_lib.quilt
J module, 27
java_path (JavaInformation attribute), 38 minecraft_launcher_lib.runtime
javaArguments (VanillaLauncherProfile attribute), 39 module, 28
javaExecutable (VanillaLauncherProfile attribute), 39 minecraft_launcher_lib.types
JavaInformation (class in module, 35
minecraft_launcher_lib.types), 38 minecraft_launcher_lib.utils
javaMajorVersion (VersionRuntimeInformation module, 21
attribute), 39 minecraft_launcher_lib.vanilla_launcher
javaw_path (JavaInformation attribute), 38 module, 30
jvmArguments (MinecraftOptions attribute), 35 MinecraftAuthenticateResponse (class in
JvmRuntimeInformation (class in minecraft_launcher_lib.microsoft_types),
minecraft_launcher_lib.types), 39 40
MinecraftOptions (class in
K minecraft_launcher_lib.types), 35
keyId (MinecraftStoreResponse attribute), 40 MinecraftProfileResponse (class in
minecraft_launcher_lib.microsoft_types),
L 40
LatestMinecraftVersions (class in MinecraftStoreResponse (class in
minecraft_launcher_lib.types), 36 minecraft_launcher_lib.microsoft_types),
Index 85
40 port (MinecraftOptions attribute), 36

minecraftVersion (MrpackInformation attribute), 39 preferred_tile (Article attribute), 38
MinecraftVersionInfo (class in primary_category (Article attribute), 38
minecraft_launcher_lib.types), 36 profile (InvalidVanillaLauncherProfile attribute), 33
module publish_date (Article attribute), 38
minecraft_launcher_lib.command, 15
minecraft_launcher_lib.exceptions, 32 Q
minecraft_launcher_lib.fabric, 26 quickPlayMultiplayer (MinecraftOptions attribute),
minecraft_launcher_lib.forge, 24 36
minecraft_launcher_lib.install, 16 quickPlayPath (MinecraftOptions attribute), 36
minecraft_launcher_lib.java_utils, 23 quickPlayRealms (MinecraftOptions attribute), 36
minecraft_launcher_lib.microsoft_account, quickPlaySingleplayer (MinecraftOptions attribute),
17 36
minecraft_launcher_lib.microsoft_types, QuiltLoader (class in minecraft_launcher_lib.types), 37
39 QuiltMinecraftVersion (class in
minecraft_launcher_lib.mrpack, 31 minecraft_launcher_lib.types), 37
minecraft_launcher_lib.natives, 17
minecraft_launcher_lib.quilt, 27 R
minecraft_launcher_lib.runtime, 28 refresh_authorization_token() (in module
minecraft_launcher_lib.types, 35 minecraft_launcher_lib.microsoft_account), 19
minecraft_launcher_lib.utils, 21 refresh_token (AuthorizationTokenResponse at-
minecraft_launcher_lib.vanilla_launcher, tribute), 40
30 refresh_token (CompleteLoginResponse attribute), 41
MrpackInformation (class in release (LatestMinecraftVersions attribute), 36
minecraft_launcher_lib.types), 39 released (JvmRuntimeInformation attribute), 39
MrpackInstallOptions (class in releaseTime (MinecraftVersionInfo attribute), 36
minecraft_launcher_lib.types), 39 resolutionHeight (MinecraftOptions attribute), 36
msg (UnsupportedVersion attribute), 33 resolutionWidth (MinecraftOptions attribute), 36
msg (VersionNotFound attribute), 32 roles (MinecraftAuthenticateResponse attribute), 40
run_forge_installer() (in module
N minecraft_launcher_lib.forge), 24
name (CompleteLoginResponse attribute), 41
name (JavaInformation attribute), 38 S
name (JvmRuntimeInformation attribute), 39
scope (AuthorizationTokenResponse attribute), 40
name (MinecraftProfileResponse attribute), 40
SecurityError, 33
name (MrpackInformation attribute), 39
separator (FabricLoader attribute), 37
name (VanillaLauncherProfile attribute), 38
separator (QuiltLoader attribute), 37
name (VersionRuntimeInformation attribute), 39
server (MinecraftOptions attribute), 36
nativesDirectory (MinecraftOptions attribute), 36
setMax (CallbackDict attribute), 36
NotAfter (XBLResponse attribute), 40
setProgress (CallbackDict attribute), 36
NotAfter (XSTSResponse attribute), 40
setStatus (CallbackDict attribute), 36
O signature (MinecraftStoreResponse attribute), 40
skins (CompleteLoginResponse attribute), 41
openjdk (JavaInformation attribute), 38 skins (MinecraftProfileResponse attribute), 40
optionalFiles (MrpackInformation attribute), 39 skipDependenciesInstall (MrpackInstallOptions at-
optionalFiles (MrpackInstallOptions attribute), 39 tribute), 39
snapshot (LatestMinecraftVersions attribute), 36
P stable (FabricLoader attribute), 37
parse_auth_code_url() (in module stable (FabricMinecraftVersion attribute), 36
minecraft_launcher_lib.microsoft_account), 18 stable (QuiltMinecraftVersion attribute), 37
path (FileOutsideMinecraftDirectory attribute), 34 stderr (ExternalProgramError attribute), 33
path (InvalidChecksum attribute), 34 stdout (ExternalProgramError attribute), 33
path (JavaInformation attribute), 38 sub_header (Tile attribute), 37
PlatformNotSupported, 35
86 Index
summary (MrpackInformation attribute), 39 X

supports_automatic_install() (in module XBLResponse (class in
minecraft_launcher_lib.forge), 25 minecraft_launcher_lib.microsoft_types),
40
T XSTSResponse (class in
tags (Article attribute), 38 minecraft_launcher_lib.microsoft_types),
Tile (class in minecraft_launcher_lib.types), 37 40
tile_size (Tile attribute), 37
title (Tile attribute), 38
token (MinecraftOptions attribute), 35
Token (XBLResponse attribute), 40
Token (XSTSResponse attribute), 40
token_type (AuthorizationTokenResponse attribute), 39
token_type (MinecraftAuthenticateResponse attribute),
40
type (MinecraftVersionInfo attribute), 36
U
UnsupportedVersion, 32
url (InvalidChecksum attribute), 34
url_contains_auth_code() (in module
username (MinecraftAuthenticateResponse attribute), 40
username (MinecraftOptions attribute), 35
uuid (MinecraftOptions attribute), 35
V
vanilla_launcher_profile_to_minecraft_options()
(in module minecraft_launcher_lib.vanilla_launcher),
30
VanillaLauncherProfile (class in
minecraft_launcher_lib.types), 38
VanillaLauncherProfileResolution (class in
version (FabricLoader attribute), 37
version (FabricMinecraftVersion attribute), 36
version (JavaInformation attribute), 38
version (QuiltLoader attribute), 37
version (QuiltMinecraftVersion attribute), 37
version (UnsupportedVersion attribute), 33
version (VanillaLauncherProfile attribute), 38
version (VersionNotFound attribute), 32
versionId (MrpackInformation attribute), 39
VersionNotFound, 32
VersionRuntimeInformation (class in
versionType (VanillaLauncherProfile attribute), 38
videoId (Image attribute), 37
videoProvider (Image attribute), 37
videoType (Image attribute), 37
videoURL (Image attribute), 37
W
width (VanillaLauncherProfileResolution attribute), 38
Index 87

Como Crear Tu Launcher de Minecraft en Ingles

Uploaded by

Copyright:

Available Formats

Como Crear Tu Launcher de Minecraft en Ingles

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Como Crear Tu Launcher de Minecraft en Ingles

Uploaded by

Copyright:

Available Formats

minecraft-launcher-lib

Jan 01, 2024

Python Module Index 81

1.1 What’s this?

These are the main goals of minecraft-launcher-lib:

1.3 Getting Started

Here are different methods to install minecraft-launcher-lib.

pip install -U minecraft-launcher-lib

pip install -U git+https://codeberg.org/JakobDev/minecraft-launcher-lib.git

3.1 Getting Started

3.1.1 Minecraft Directory

# Get the Minecraft Directory of your System

3.1.2 Install Minecraft

3.1.3 Get Minecraft Versions

3.1.4 Launch Minecraft

3.2 Microsoft Login

3.2.1 Create Azure Application

3.2.2 Apply for Permission

3.2.3 Let the User log in

3.2.4 Secure option

The minecraft_launcher_lib.microsoft_account.get_secure_login_data(client_id: str,

3.2.5 Do the Login

Use minecraft_launcher_lib.microsoft_account.complete_login(client_id: str, redirect_uri:

3.2. Microsoft Login 9

(continued from previous page)

To refresh just use minecraft_launcher_lib.microsoft_account.complete_refresh(client_id: str,

3.3 Get Installation Progress

def set_status(status: str):

def set_progress(progress: int):

def set_max(new_max: int):

(continued from previous page)

3.4 More Launch Options

3.4.1 JVM Arguemnts

3.4.2 Java Executable

3.4. More Launch Options 11

3.4.3 Custom Resolution

# Enable custom resolution

3.4.4 Game Directory

If the directory does not exists, Minecraft will create it.

3.4.5 Use Demo Mode

3.5 Install Forge

3.5.1 Get Forge Version

In this case we get the latest Forge version for 1.17.1.

3.5.2 Install Forge Version

install_forge_version() supports the same callbacks as install_minecraft_version().

3.5.3 Launch Forge Version

3.6 Install Fabric

This tutorial shows how to install forge using minecraft-launcher-lib.

3.6.1 Install Fabric

install_fabric() supports the same callbacks as install_minecraft_version().

3.6.2 Launch Fabric

3.7 Custom Types

3.6. Install Fabric 13

3.8 Getting Help

Here are some sources if you need more information.

command contains the function for creating the minecraft command

"jvmArguments": [], #The jvmArguments

"demo": False, # Run Minecraft in demo mode

def init(self) -> None: