minecraft-handicraft

Handicraft is a Minecraft tool that can be used automate the installation of launchers. It also allows the installation of addons through a valid CurseForge Custom Profile.

Manually dealing with launchers and addons is a problem of the past.

Customize which launcher to download and install. Define a profile and let it automatically handle the setup of all the necessary addons you need for that specific server. Forge? Fabric? No problem!

Prerequisites

• Python 3 - Python is an interpreted, high-level and general-purpose programming language. The project already contains the Python Embeddable Package for 64-bits, so it is not mandatory on Windows.

IMPORTANT: Check the options "Install launcher for all users (recommended)" and "Add Python to PATH", then select the "Install Now" button. Alternatively, select the "Customize installation" button, check the option "for all users (requires elevation)" when installing the Optional Features and continue the installation.

• Visual C++ Redistributable for Visual Studio 2015 - The Visual C++ Redistributable Packages install run-time components that are required to run C++ applications built using Visual Studio 2015. This is only required on Windows since the embedded distribution does not include the Microsoft C Runtime.

Installation

1. Download the main project.
2. Extract the package.
3. Run as administrator either main.bat on Windows, main.sh on Linux or manually run the required commands for every other case.

pip3 install -r "requirements.txt"
python "./src/main.py"

5. Follow the program instructions.

Customization

Structure

/public/

Path	Type	Description
configuration/	Required	Directory that contains all the configuration files.
data/	Required	Directory that stores the downloaded files.
log/	Required	Directory that contains log files.
profile/	Optional	Directory that stores CurseForge Minecraft Instance files, usually named minecraftinstance.json.

/public/configuration/

Path	Type	Description
autorun.json	Optional	File that allows you to automatically run the program by defining a valid launcher or profile key. In case this file is deleted, the program will ask you for input.
launcher.json	Required	File that allows you to handle the setup of launchers independently for each platform (Windows, MacOS, Linux).
profile.json	Required	File that allows you to handle the setup of loaders and mods based on a CurseForge Minecraft Instance profile.

Configuration

autorun.json

Key	Type	Description
launcher	Required	Launcher key.
profile	Required	Profile key.

launcher.json

Key	Type	Description
[key]	Required	Launcher key.
↦ name	Required	Option name.
↦ platform	Optional	Platform settings.
↦ ↦ [platform]	Optional	Specific platform settings. Valid keys are: linux, osx, windows.
↦ ↦ ↦ data	Optional	Minecraft data directory location.
↦ ↦ ↦ tasks	Optional	Task list. Allowed tasks are: call, cd, clear, exit, java, modal, unzip, wget.

profile.json

Key	Type	Description
[key]	Required	Profile key.
↦ name	Required	Option name.
↦ location	Required	CurseForge Minecraft Instance location.
↦ tasks	Optional	Task list. Allowed tasks are: backup, clear, exit, java, modal, remove, wget.

Task

Item	Parameter	Type	Description
backup			Creates a backup of a file or directory.
	path	Required	Operation path.
clear			Clears a path from its content.
	path	Required	Operation path.
call			Runs an executable file.
	file	Required	Operation file.
	key	Required	Operation key.
	timeout	Optional	Timeout until the subprocess is killed. If null, the subprocess runs asynchronously. If less than 0, the subprocess runs until it is done.
	parameters	Optional	Additional parameters.
cd			Changes the current directory.
	path	Required	Operation path.
dialog			Changes the current directory.
	caption	Required	Title or caption.
	header	Required	Highlight or header.
	messages	Optional	Body or messages.
exit			Exits a running subprocess.
	key	Required	Operation key.
java			Runs a java file.
	file	Required	Operation file.
	key	Required	Operation key.
	timeout	Optional	Timeout until the subprocess is killed. If null, the subprocess runs asynchronously. If less than 0, the subprocess runs until it is done.
remove			Removes a specific file or directory.
	path	Required	Operation path.
unzip			Tries to exit a running subprocess.
	file	Required	Operation file.
wget			Downloads a file from the internet.
	url	Required	Operation url.
	file	Required	Operation file.
	pattern	Optional	Match the url with a specific pattern.
	repl	Optional	Text to replace the matched pattern with.

© RatserX