diff --git a/.gitignore b/.gitignore index de58237..9cf3da5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,6 @@ venv +node_modules/ +package-lock.json tools/version.json tools/libs.txt for_build/ diff --git a/INSTALLATION_EN.md b/INSTALLATION_EN.md deleted file mode 100644 index a632a80..0000000 --- a/INSTALLATION_EN.md +++ /dev/null @@ -1,26 +0,0 @@ -English help -============ -## 1. Installing -Download of [actually](https://github.com/iiiypuk/minecraft-launcher/releases/latest) version launcher. -Next [download](https://www.minecraft.net/download) Minecraft and start Demo mode. After successfully run close game. -Download required [libraries](https://mega.nz/#F!hUNg0Y6I!93cYw1NZg4MUWUHaVrCO7w) for run game for **your system** and game **version**. - -## 2. Client Minecraft -By default script configured for run Minecraft from default directory: -for Windows is `%APPDATA%\.minecraft`. -for Linux is `~/.minecraft`. - -Extract launcher files in game directory, if necessary, you can create a shortcut on the desktop. -Start. ENJOY! - -## 3. Configuration -This launcher configurable. Configuration made by changing the parameters in the source code of the launcher. - -**Parameters list and values are presented below:** - -+ `%MC_DIR%` - directory with Minecraft client. -+ `%GAME_DIR%` - directory with user files. Resource packs, saves, screenshots and etc. -+ `%PLAYER%` - player name. -+ `%WINDOW_W%` - window width in window mode. -+ `%WINDOW_H%` - height width in window mode. -+ `%RAM%` - the amount of RAM that the JVM will use. The default is 2GB. diff --git a/INSTALLATION_RU.md b/INSTALLATION_RU.md deleted file mode 100644 index d85508c..0000000 --- a/INSTALLATION_RU.md +++ /dev/null @@ -1,26 +0,0 @@ -Русская справка -=============== -## 1. Установка -Скачиваем [актуальную](https://github.com/iiiypuk/minecraft-launcher/releases/latest) версию лаунчера. -Далее [скачиваем](https://www.minecraft.net/download) Minecraft и запускаем демо-режим. После успешного запуска, закрываем игру. -Скачиваем необходимые для запуска [библиотеки](https://mega.nz/#F!hUNg0Y6I!93cYw1NZg4MUWUHaVrCO7w) для **вашей системы** и **версии игры**. - -## 2. Клиент Minecraft -По умолчанию скрипт настроен на запуск Minecraft из стандартной директории: -для Windows это `%APPDATA%\.minecraft`. -для Linux это `~/.minecraft`. - -Распаковываем файлы лаунчера в директорию с игрой, при необходимости можно создать ярлык на рабочем столе. -Запускаем. ENJOY! - -## 3. Настройка -Этот лаунчер можно настроить. Настройка производится путём изменения параметров в исходном коде лаунчера. - -**Список параметров и их значений представлены ниже:** - -+ `%MC_DIR%` - директория с клиентом Minecraft. -+ `%GAME_DIR%` - директория с файлами пользователя. Ресурс-паки, сохранения, скриншоты и др. -+ `%PLAYER%` - имя игрока. -+ `%WINDOW_W%` - ширина окна в оконном режиме. -+ `%WINDOW_H%` - высота окна в оконном режиме. -+ `%RAM%` - количество оперативной памяти, которое JVM будет использовать. По умолчанию 2GB. diff --git a/README.md b/README.md index e47c8dc..abc0d44 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,4 @@ Minecraft [Java Edition] Batch Launcher * 🧰 No need for extra deps * ⚙️ No need configuration -### Instaling: -+ 🇺🇸 [English help](https://github.com/IIIypuk/minecraft-launcher/blob/master/INSTALLATION_EN.md) -+ 🇷🇺 [Русская справка](https://github.com/IIIypuk/minecraft-launcher/blob/master/INSTALLATION_RU.md) - ![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/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/docs/_coverpage.md b/docs/_coverpage.md new file mode 100644 index 0000000..707164a --- /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/) +[Начать](about) + +![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/_navbar.md b/docs/_navbar.md new file mode 100644 index 0000000..44a8066 --- /dev/null +++ b/docs/_navbar.md @@ -0,0 +1,3 @@ +- Translations + - [🇷🇺 Русский](/) + - [🇺🇸 English](/en/) 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/about.md b/docs/about.md new file mode 100644 index 0000000..994cf2c --- /dev/null +++ b/docs/about.md @@ -0,0 +1,20 @@ +# Minecraft Batch Launcher +Это простой скрипт для запуска Minecraft без официального лаунчера + +## Для чего он нужен? +* Для запуска необходимой версии игры, с любой директории и настройками +* Для создания собственных сборок (адаптирование и бинарный лаунчер) +* Для запуска Minecraft без лицензии (для тестирования серверов) + +Отсутствие необходимости в компилировании лаунчера позволяет на лету изменять параметры просто редакитуя `*.bat` файл. + +## Поддержка +🩸 Вы можете поддержать автора проекта материально. +В первую очередь это мотивирует поддерживать проект и разрабатывать похожие утилиты для других игр. +Вот способы доната: + +* [Ko-Fi](https://ko-fi.com/iiiypuk) +* Переводом через СБП (`Тинкофф` `СберБанк` `ВТБ`) на номер **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/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/index.html b/docs/index.html new file mode 100644 index 0000000..f6c955a --- /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..5c14231 --- /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..bf5117d --- /dev/null +++ b/docs/portable.md @@ -0,0 +1,2 @@ +# Создание портативной сборки + diff --git a/docs/variables.md b/docs/variables.md new file mode 100644 index 0000000..8eecf7e --- /dev/null +++ b/docs/variables.md @@ -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, которая определяет её переменные diff --git a/for_build/README.txt b/for_build/README.txt deleted file mode 100644 index 67c9fe1..0000000 --- a/for_build/README.txt +++ /dev/null @@ -1,2 +0,0 @@ -Natives catalog: - https://mega.nz/#F!hUNg0Y6I!93cYw1NZg4MUWUHaVrCO7w diff --git a/package.json b/package.json new file mode 100644 index 0000000..e19e724 --- /dev/null +++ b/package.json @@ -0,0 +1,5 @@ +{ + "dependencies": { + "docsify-cli": "4.4.2" + } +}