Minecraft Batch Launcher

commit ad7cf3787e61dab7a0effcb7da19011a06ce75d2 Author: Alexander Popov Date: Mon May 16 20:17:17 2022 +0300 Init Docs diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..9e1b904 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,19 @@ +root = true + +[*] +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[{*.html,*.css,*.json}] +indent_style = tab +indent_size = 4 + +[package.json] +indent_style = space +indent_size = 2 + +[*.md] +indent_style = space +indent_size = 2 diff --git a/README.md b/README.md new file mode 100644 index 0000000..deb14e8 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +Documentation site built by [docsify](https://docsify.js.org/). diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..9a0be5b --- /dev/null +++ b/docs/README.md @@ -0,0 +1,19 @@ +# Minecraft Batch Launcher +Это простой скрипт для запуска Minecraft без официального лаунчера + +## Для чего он нужен? +* Для запуска необходимой версии игры, с любой директории и настройками +* Для создания собственных сборок (адаптирование и бинарный лаунчер) +* Для запуска Minecraft без лицензии (для тестирования серверов) + +Отсутствие необходимости в компилировании лаунчера позволяет на лету изменять параметры просто редакитуя `*.bat` файл. + +## Поддержка +🩸 Вы можете поддержать автора проекта материально. +В первую очередь это мотивирует поддерживать проект и разрабатывать похожие утилиты для других игр. +Способы доната: +* [Ko-Fi](https://ko-fi.com/iiiypuk) +* Переводом через [СБП](https://sbp.nspk.ru/) (`Тинкофф`, `СберБанк`, `ВТБ`) на номер **911 313-90-95**. + +## Сведения +![License](https://img.shields.io/github/license/iiiypuk/minecraft-launcher?style=for-the-badge) ![Latest release](https://img.shields.io/github/v/release/iiiypuk/minecraft-launcher?style=for-the-badge) ![Total downloads](https://img.shields.io/github/downloads/iiiypuk/minecraft-launcher/total?style=for-the-badge) diff --git a/docs/_coverpage.md b/docs/_coverpage.md new file mode 100644 index 0000000..3643d99 --- /dev/null +++ b/docs/_coverpage.md @@ -0,0 +1,15 @@ +![logo](_media/logo.svg ':size=10%') + +# Minecraft Batch Launcher 1.0.0 + +> Теперь запускать Minecraft просто + +* 📋 Открытый исходный код лаунчера +* 🏷️ Возможность изменять имя персонажа +* 🧰 Не требуется дополнительный зависимостей +* ⚙️ Нет необходимости в настройке + +[GitHub](https://github.com/iiiypuk/minecraft-launcher/) +[Начать](README) + +![color](#F8F8F8) diff --git a/docs/_media/favicon.ico b/docs/_media/favicon.ico new file mode 100644 index 0000000..1c56dc2 Binary files /dev/null and b/docs/_media/favicon.ico differ diff --git a/docs/_media/logo.svg b/docs/_media/logo.svg new file mode 100644 index 0000000..05b3f4b --- /dev/null +++ b/docs/_media/logo.svg @@ -0,0 +1,51 @@ + + + diff --git a/docs/_media/portable/01-launcher.png b/docs/_media/portable/01-launcher.png new file mode 100644 index 0000000..0999409 Binary files /dev/null and b/docs/_media/portable/01-launcher.png differ diff --git a/docs/_media/portable/02-directory.png b/docs/_media/portable/02-directory.png new file mode 100644 index 0000000..db9fba6 Binary files /dev/null and b/docs/_media/portable/02-directory.png differ diff --git a/docs/_navbar.md b/docs/_navbar.md new file mode 100644 index 0000000..682afbf --- /dev/null +++ b/docs/_navbar.md @@ -0,0 +1,7 @@ +- [Бинарные библиотеки](https://mega.nz/#F!hUNg0Y6I!93cYw1NZg4MUWUHaVrCO7w) + +- [Готовые сборки](https://mega.nz/folder/0E0QRKZL#HOyMLQ292PJ3xIE1vXbLJQ) + +- Translations + - [🇷🇺 Русский](/) + - [🇺🇸 English](/en-us/) diff --git a/docs/_sidebar.md b/docs/_sidebar.md new file mode 100644 index 0000000..5bad52b --- /dev/null +++ b/docs/_sidebar.md @@ -0,0 +1,10 @@ +- [Обзор](about.md) + +- Начало работы + + - [Установка](installing.md) + - [Переменные](variables.md) + +- [Создание портативной сборки](portable.md) + +- [История изменений](changelog.md) diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..457b3b2 --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1 @@ +# 1.0.0 (2021-02.14) diff --git a/docs/en-us/README.md b/docs/en-us/README.md new file mode 100644 index 0000000..0cd17cf --- /dev/null +++ b/docs/en-us/README.md @@ -0,0 +1,12 @@ +# Minecraft Batch Launcher +This is a simple script to launch Minecraft without an official launcher + +## What is? +* To run the required version of the game, from any directory and settings +* To create your assemblies (adaptation and binary launcher) +* To run Minecraft without a license (for testing servers) + +The absence of the need to compile the launcher allows you to change parameters on the fly simply by editing the `* .bat` file. + +## Information +![License](https://img.shields.io/github/license/iiiypuk/minecraft-launcher?style=for-the-badge) ![Latest release](https://img.shields.io/github/v/release/iiiypuk/minecraft-launcher?style=for-the-badge) ![Total downloads](https://img.shields.io/github/downloads/iiiypuk/minecraft-launcher/total?style=for-the-badge) diff --git a/docs/en-us/_navbar.md b/docs/en-us/_navbar.md new file mode 100644 index 0000000..734b686 --- /dev/null +++ b/docs/en-us/_navbar.md @@ -0,0 +1,7 @@ +- [Binary libraries](https://mega.nz/#F!hUNg0Y6I!93cYw1NZg4MUWUHaVrCO7w) + +- [Build](https://mega.nz/folder/0E0QRKZL#HOyMLQ292PJ3xIE1vXbLJQ) + +- Translations + - [🇷🇺 Русский](/) + - [🇺🇸 English](/en-us/) diff --git a/docs/en-us/_sidebar.md b/docs/en-us/_sidebar.md new file mode 100644 index 0000000..d138950 --- /dev/null +++ b/docs/en-us/_sidebar.md @@ -0,0 +1,8 @@ +- [About](about.md) + +- Getting start + + - [Installing](/en-us/installing.md) + - [Variables](/en-us/variables.md) + +- [ChangeLog](changelog.md) diff --git a/docs/en-us/installing.md b/docs/en-us/installing.md new file mode 100644 index 0000000..ce5549a --- /dev/null +++ b/docs/en-us/installing.md @@ -0,0 +1,37 @@ +# Installation + +## Preparing for installation +First of all, you must have already downloaded Minecraft with the required version of the game. +A **Demo** account is enough for this. + +?> Download Minecraft free [link](https://www.minecraft.net/ru-ru/free-trial). + +## Running Launcher +First of all, download the [launcher](https://github.com/iiiypuk/minecraft-launcher/releases) and unpack it into the Minecraft directory. + +- Windows default path `%appdata%\.minecraft` +- Linux default path `~/.minecraft` + +?> The current version of the launcher is set to launch the latest stable version of the game. + +Next, you need the binaries of the libraries. +Archives of binary versions are stored in the cloud on **MEGA** [[Download](https://mega.nz/#F!hUNg0Y6I!93cYw1NZg4MUWUHaVrCO7w)]. +To start, you just need to unpack the archive with libraries into the `/ bin /` directory and remove from the file name +`-windows` or `-linux` word. + +Libraries can be generated [by himself](#Generating-binary-libraries). + +?> The current version of the launcher is always found at this [link](https://github.com/iiiypuk/minecraft-launcher/releases/latest). + +## Generating binary libraries +?> If you downloaded binary libraries, skip this step. + +Binary libraries are generated when the game is started in the `/ bin /` directory and are removed after the game is closed. +The directory with binaries has the following name `d3ab-9be2-0b09-1052`, which changes every time. + +To save them, you need to start the game and copy the directory. + +## Complete +If you plan to run the current stable version of the game, nothing needs to be configured. Just double click on `mc_start.*` And enjoy the game. + +In other cases, you need to familiarize yourself with the [variables](variables) of the script. diff --git a/docs/en-us/variables.md b/docs/en-us/variables.md new file mode 100644 index 0000000..58820d2 --- /dev/null +++ b/docs/en-us/variables.md @@ -0,0 +1,77 @@ +# Variables +## MC_DIR +!> Minecraft directory + +The variable `MC_DIR` is the key variable on the basis of which the paths in the script are built. + +When using a non-standard path, you should change the directory at your discretion. + +You can specify a relative path if the script file is located in the directory with the game, for example: +* for Windows `%CD%` +* for Linux `./` + +?> However, it should be noted that on Windows, if the script file is located in a different directory and on a different local disk, +first you need to go to the disk where the game is located (by default `%SystemDrive%`). +Otherwise, the settings files and save directories will appear next to the script. + +## GAME_DIR +!> Directory with game settings + +User files are stored in this directory: +* `saves` - saves directory +* `resourcepacks` - resource packs directory +* `screenshots` - shapshots directory +* `options.txt` - options file + +?> It is recommended to keep them in a separate directory to avoid confusion and easily transfer your files to other computers. + +?> By default using `MC_DIR` + +## ASSETS_DIR +!> Minecraft assets directory + +## ASSETS_INDEX +!> Minecraft assets index + +Stored in `version['assetIndex']['id']`. +Has the same meaning as the version of the game, excluding the [patch](https://semver.org/lang/ru/#spec-item-2). + +Example `1.16` for game versions `1.16.3`, `1.16.4`, `1.16.5`. + +## GAME_VERSION +!> Minecraft version + +## NATIVES_DIR +!> Directory with binary libraries + +## LIBRARIES_LIST +!> Dependency library path list + +The `Release` version of the launcher is present. +In other cases, you need to generate it yourself. + +## PLAYER_NAME +!> Player name + +By default, when the script starts, the user is prompted to enter the player's name interactively. + +If there is no need to change the name when starting the script, write down the required name in the variable. +``` batch +set PLAYER_NAME=Steve +``` +and remove this line +``` batch +set /p player=What username would you like? +``` + +## WINDOW_W +!> Game window width + +## WINDOW_H +!> Game window height + +## JVM_RAM +!> Java virtual machine variable that determines the size of the consumed RAM + +## JVM_ARGS +!> Java virtual machine variable that defines its variables diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..677149c --- /dev/null +++ b/docs/index.html @@ -0,0 +1,33 @@ + + + + + Minecraft Batch Launcher + + + + + + + +

+ + + + + + + diff --git a/docs/installing.md b/docs/installing.md new file mode 100644 index 0000000..044e0e7 --- /dev/null +++ b/docs/installing.md @@ -0,0 +1,37 @@ +# Установка + +## Подготовка +Прежде всего у Вас уже должен быть скачан Minecraft с необходимой версией игры. +Для этого достаточно **Demo** аккаунта. + +?> Скачать Minecraft бесплатно можно по этой [ссылке](https://www.minecraft.net/ru-ru/free-trial). + +## Загрузка лаунчера +Первым делом скачиваем [лаунчер](https://github.com/iiiypuk/minecraft-launcher/releases) и распаковываем его в директорию с Minecraft. + +- В Windows по умолчанию `%appdata%\.minecraft` +- В Linux по умолчанию `~/.minecraft` + +?> Актуальная версия лаунчера настроена на запуск последней стабильной версии игры. + +Далее нам нужны бинарные файлы библиотек. +Архивы бинарных версий хранятся в облаке на **MEGA** [[Скачать](https://mega.nz/#F!hUNg0Y6I!93cYw1NZg4MUWUHaVrCO7w)]. +Для запуска необходимо лишь распаковать архив с библиотеками в директорию `/bin/` и удалить из имени файла +`-windows` или `-linux`. + +Библиотеки можно сгенерировать [самостоятельно](#Генерация-бинарных-библиотек). + +?> Актуальная версия лаунчера всегда находится по этой [ссылке](https://github.com/iiiypuk/minecraft-launcher/releases/latest). + +## Генерация бинарных библиотек +?> Если вы скачали бинарные библиотеки, пропустите этот шаг + +Бинарные библиотеки генерируются при запуске игры в директории `/bin/` и удаляются после её закрытия. +Директория с бинарными файлами имеет примерно следующие название `d3ab-9be2-0b09-1052`, которое меняется каждый раз. + +Чтобы их сохранить, необходимо запустить игру и скопировать директорию. + +## Готово +Если Вы планируете запускать текущую стабильную версию игры, ничего настраивать не требуется. Достаточно дважды кликнуть по `mc_start.*` и наслаждать игрой. + +В других случаях необходимо ознакомиться с [переменными](variables) скрипта. diff --git a/docs/portable.md b/docs/portable.md new file mode 100644 index 0000000..fe00f09 --- /dev/null +++ b/docs/portable.md @@ -0,0 +1,116 @@ +# Создание портативной сборки +В данном руководстве будет продемонстрировано создание своей кастомной сборки Minecraft на примере ОС Windows. + +## Подготовка +1. Создаём рабочую директорию. +В моём случае это `G:\Minecraft`. +``` batch +mkdir G:\Minecraft +G: +cd Minecraft +mkdir bin +mkdir game +``` + +2. Запускаем официальный **Minecraft Launcher**, выбираем версию и скачивает игру, а с ней и необходимые файлы. +![Minecraft Launcher](_media/portable/01-launcher.png) + +3. По окончании загрузки и запуска игры копируем бинарные библиотеки в рабочую директорию и закрываем игру. Она нам больше не понадобится. +``` batch +xcopy %appdata%\.minecraft\bin\1c1d-a80c-5999-cc54 bin /s +``` + +4. Копируем остальные файлы: +``` batch +xcopy %appdata%\.minecraft\assets assets /s +xcopy %appdata%\.minecraft\libraries libs /s +xcopy %appdata%\.minecraft\versions\1.16.5 vers /s +``` + +## Генерация LIBRARIES_LIST +Клонируем Git репозиторий [лаунчера](https://github.com/iiiypuk/minecraft-launcher) и устанавливаем зависимости Python скрипта: +``` batch +git clone --depth 1 git@github.com:iiiypuk/minecraft-launcher.git +cd minecraft-launcher + +pip install -r requirements.txt +``` + +Генерируем `LIBRARIES_LIST` и перемещаем его в корень сборки: +``` batch +cd tools + +copy ..\..\vers\1.16.5.json version.json + +python make_libs_list.py --platform win32 --output txt + +move libs.txt ..\..\vers + +cd ..\.. +``` + +## Редактирование лаунчера + +0. Удаляем эти строку, если нет необходимости спрашивать имя пользователя +``` batch +set /p player=What username would you like? +``` + +1. Изменяем переменную с директорией Minecraft `set MC_DIR=%CD%` +2. Изменяем путь к директории с файлами пользователя `set GAME_DIR=%MC_DIR%\game` +3. Изменяем путь к бинарным библиотекам `set NATIVES_DIR=%MC_DIR%\bin` +4. Заменяем в файле `libs.txt` фразы: +* `;%MC_DIR%/versions/%GAME_VERSION%/%GAME_VERSION%.jar` на `;%MC_DIR%/vers/%GAME_VERSION%.jar` +* `%MC_DIR%/libraries/` на `%MC_DIR%/libs/` +5. Копируем содержимое `libs.txt` в **%LIBRARIES_LIST%** + +?> Вставить содержимое файла в перменную интерактивно +таким образом `set /p LIBRARIES_LIST=