Init Docs

This commit is contained in:
Alexander Popov 2022-05-16 20:17:17 +03:00
commit ad7cf3787e
Signed by: iiiypuk
GPG Key ID: 3F76816AEE08F908
21 changed files with 534 additions and 0 deletions

19
.editorconfig Normal file
View File

@ -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

1
README.md Normal file
View File

@ -0,0 +1 @@
Documentation site built by [docsify](https://docsify.js.org/).

19
docs/README.md Normal file
View File

@ -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)

15
docs/_coverpage.md Normal file
View File

@ -0,0 +1,15 @@
![logo](_media/logo.svg ':size=10%')
# Minecraft Batch Launcher <small>1.0.0</small>
> Теперь запускать Minecraft просто
* 📋 Открытый исходный код лаунчера
* 🏷️ Возможность изменять имя персонажа
* 🧰 Не требуется дополнительный зависимостей
* ⚙️ Нет необходимости в настройке
[GitHub](https://github.com/iiiypuk/minecraft-launcher/)
[Начать](README)
![color](#F8F8F8)

BIN
docs/_media/favicon.ico Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.2 KiB

51
docs/_media/logo.svg Normal file
View File

@ -0,0 +1,51 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- Generator: Adobe Illustrator 19.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
viewBox="0 0 469.333 469.333" style="enable-background:new 0 0 469.333 469.333;" xml:space="preserve">
<path style="fill:#303C42;" d="M426.667,0h-384C19.135,0,0,19.135,0,42.667v384c0,23.531,19.135,42.667,42.667,42.667h384
c23.531,0,42.667-19.135,42.667-42.667v-384C469.333,19.135,450.198,0,426.667,0z"/>
<g>
<path style="fill:#E57373;" d="M448,42.667v106.667H320v-128h106.667C438.427,21.333,448,30.906,448,42.667z"/>
<rect x="170.667" y="170.667" style="fill:#E57373;" width="277.333" height="128"/>
<rect x="21.333" y="170.667" style="fill:#E57373;" width="128" height="128"/>
<path style="fill:#E57373;" d="M42.667,21.333h256v128H21.333V42.667C21.333,30.906,30.906,21.333,42.667,21.333z"/>
<path style="fill:#E57373;" d="M21.333,426.667V320h277.333v128h-256C30.906,448,21.333,438.427,21.333,426.667z"/>
<path style="fill:#E57373;" d="M426.667,448H320V320h128v106.667C448,438.427,438.427,448,426.667,448z"/>
</g>
<linearGradient id="SVGID_1_" gradientUnits="userSpaceOnUse" x1="-68.6888" y1="619.0512" x2="-43.3842" y2="607.2509" gradientTransform="matrix(21.3333 0 0 -21.3333 1430.1112 13315.2227)">
<stop offset="0" style="stop-color:#FFFFFF;stop-opacity:0.2"/>
<stop offset="1" style="stop-color:#FFFFFF;stop-opacity:0"/>
</linearGradient>
<path style="fill:url(#SVGID_1_);" d="M426.667,0h-384C19.135,0,0,19.135,0,42.667v384c0,23.531,19.135,42.667,42.667,42.667h384
c23.531,0,42.667-19.135,42.667-42.667v-384C469.333,19.135,450.198,0,426.667,0z"/>
<g>
</g>
<g>
</g>
<g>
</g>
<g>
</g>
<g>
</g>
<g>
</g>
<g>
</g>
<g>
</g>
<g>
</g>
<g>
</g>
<g>
</g>
<g>
</g>
<g>
</g>
<g>
</g>
<g>
</g>
</svg>

After

Width:  |  Height:  |  Size: 1.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 553 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

7
docs/_navbar.md Normal file
View File

@ -0,0 +1,7 @@
- [Бинарные библиотеки](https://mega.nz/#F!hUNg0Y6I!93cYw1NZg4MUWUHaVrCO7w)
- [Готовые сборки](https://mega.nz/folder/0E0QRKZL#HOyMLQ292PJ3xIE1vXbLJQ)
- Translations
- [🇷🇺 Русский](/)
- [🇺🇸 English](/en-us/)

10
docs/_sidebar.md Normal file
View File

@ -0,0 +1,10 @@
- [Обзор](about.md)
- Начало работы
- [Установка](installing.md)
- [Переменные](variables.md)
- [Создание портативной сборки](portable.md)
- [История изменений](changelog.md)

1
docs/changelog.md Normal file
View File

@ -0,0 +1 @@
# 1.0.0 (2021-02.14)

12
docs/en-us/README.md Normal file
View File

@ -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)

7
docs/en-us/_navbar.md Normal file
View File

@ -0,0 +1,7 @@
- [Binary libraries](https://mega.nz/#F!hUNg0Y6I!93cYw1NZg4MUWUHaVrCO7w)
- [Build](https://mega.nz/folder/0E0QRKZL#HOyMLQ292PJ3xIE1vXbLJQ)
- Translations
- [🇷🇺 Русский](/)
- [🇺🇸 English](/en-us/)

8
docs/en-us/_sidebar.md Normal file
View File

@ -0,0 +1,8 @@
- [About](about.md)
- Getting start
- [Installing](/en-us/installing.md)
- [Variables](/en-us/variables.md)
- [ChangeLog](changelog.md)

37
docs/en-us/installing.md Normal file
View File

@ -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.

77
docs/en-us/variables.md Normal file
View File

@ -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

33
docs/index.html Normal file
View File

@ -0,0 +1,33 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Minecraft Batch Launcher</title>
<link rel="icon" href="_media/favicon.ico" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="Description">
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
</head>
<body>
<div id="app">Loading...</div>
<script>
window.$docsify = {
name: 'Minecraft Batch Launcher',
basePath: 'https://iiiypuk.github.io/minecraft-launcher/',
repo: 'https://github.com/iiiypuk/minecraft-launcher/',
coverpage: true,
onlyCover: true,
loadNavbar: true,
mergeNavbar: true,
loadSidebar: true,
subMaxLevel: 2,
auto2top: true
}
</script>
<!-- Docsify v4 -->
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
<script src="//unpkg.com/prismjs/components/prism-batch.min.js"></script>
</body>
</html>

37
docs/installing.md Normal file
View File

@ -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) скрипта.

116
docs/portable.md Normal file
View File

@ -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=<vers\libs.txt` не получится.
Ограничение по длине :(
6. Удаляем строки
``` batch
%SystemDrive%
cd %MC_DIR%
```
## Готово
Получится что-то вроде этого:
![Листинг директори](_media/portable/02-directory.png)
Полный листинг скрипта:
```batch
rem @echo off
title Minecraft Launcher Portable
set MC_DIR=%CD%
set GAME_DIR=%MC_DIR%\game
set ASSETS_DIR=%MC_DIR%\assets
set ASSETS_INDEX=1.16
set GAME_VERSION=1.16.5
set NATIVES_DIR=%MC_DIR%\bin
set LIBRARIES_LIST=%MC_DIR%/...;%MC_DIR%/vers/%GAME_VERSION%.jar
set PLAYER_NAME=Steve
set WINDOW_W=800
set WINDOW_H=640
set "JVM_RAM="
set "JVM_ARGS="
java.exe %JVM_RAM% %JVM_ARGS% ^
-Djava.library.path=%NATIVES_DIR% ^
-cp %LIBRARIES_LIST% ^
net.minecraft.client.main.Main ^
--username %PLAYER_NAME% ^
--version %GAME_VERSION% ^
--accessToken 0 --userProperties {} ^
--gameDir %GAME_DIR% ^
--assetsDir %ASSETS_DIR% ^
--assetIndex %ASSETS_INDEX% ^
--width %WINDOW_W% ^
--height %WINDOW_H%
```
Готовые сборки ванильного Minecraft + Forge вы можете скачать по [этой ссылке](https://mega.nz/folder/0E0QRKZL#HOyMLQ292PJ3xIE1vXbLJQ).

79
docs/variables.md Normal file
View File

@ -0,0 +1,79 @@
# Переменные
Разберём перменные скрипта, для более тонкой настройки.
## MC_DIR
!> Директория Minecraft
Переменная `MC_DIR` является ключевой, на основе которой строятся пути в скрипте.
При использовании не стандартного пути, следует изменить директорию по своему усмотрению.
Можно указать относительный путь, если файл скрипта находится в директории с игрой, например:
* Для Windows `%CD%`
* Для Linux `./`
?> Однако стоит заметить, что в Windows если файл скрипта находится в другой директории и на другом локальном диске,
сначала необходимо перейти на диск, где находится игра (по умолчанию `%SystemDrive%`).
В противном случае файлы настроек и директории сохранений появятся рядом со скриптом.
## GAME_DIR
!> Директория с настройками игры
В этой директории хранятся файлы пользователя:
* `saves` - директория с сохранениями
* `resourcepacks` - директория с ресурс-паками
* `screenshots` - директория со скриншотами
* `options.txt` - файл с настройками
?> Рекомендуется хранить их в отдельной директории, чтобы избежать путаницы и легко переносить свои файлы на другие компьютеры.
?> Однако по умолчанию используется `MC_DIR`
## ASSETS_DIR
!> Директория с ассетами игры
## ASSETS_INDEX
!> Индекс ассетов для версии игры
Храниться в `version['assetIndex']['id']`.
Имеет одинаковое значение с версией игры, без учёта [патча](https://semver.org/lang/ru/#spec-item-2).
Например `1.16` для версий игры `1.16.3`, `1.16.4`, `1.16.5`.
## GAME_VERSION
!> Версия игры
## NATIVES_DIR
!> Директория с бинарными библиотеками
## LIBRARIES_LIST
!> Список путей библиотек зависимостей
В `Release` версии лаунчера присутсвует.
В остальных случаях необходимо [сгенерировать](/portable#000) самостоятельно.
## PLAYER_NAME
!> Имя игрока
По умолчанию при запуске скрипта пользователю предлагают вписать имя игрока в интерактивном режиме.
Если нет необходимости в смене имени при запуске скрипта, запишите в переменной необходимое имя.
``` batch
set PLAYER_NAME=Steve
```
и удалите эту строку
``` batch
set /p player=What username would you like?
```
## WINDOW_W
!> Размер игрового окна по ширине
## WINDOW_H
!> Размер игрового окна по высоте
## JVM_RAM
!> Переменная виртуальной машины Java, которая определяет размер потребляемой оперативной памяти
## JVM_ARGS
!> Переменная виртуальной машины Java, которая определяет её переменные

5
package.json Normal file
View File

@ -0,0 +1,5 @@
{
"dependencies": {
"docsify-cli": "4.4.2"
}
}