make docs by docsify
This commit is contained in:
parent
7ad66a0b50
commit
d0d3a7a90f
2
.gitignore
vendored
2
.gitignore
vendored
@ -1,4 +1,6 @@
|
||||
venv
|
||||
node_modules/
|
||||
package-lock.json
|
||||
tools/version.json
|
||||
tools/libs.txt
|
||||
for_build/
|
||||
|
||||
@ -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.
|
||||
@ -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.
|
||||
@ -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)
|
||||
|
||||
  
|
||||
|
||||
0
docs/.nojekyll
Normal file
0
docs/.nojekyll
Normal file
15
docs/_coverpage.md
Normal file
15
docs/_coverpage.md
Normal file
@ -0,0 +1,15 @@
|
||||
|
||||
|
||||
# Minecraft Batch Launcher <small>1.0.0</small>
|
||||
|
||||
> Теперь запускать Minecraft просто
|
||||
|
||||
* 📋 Открытый исходный код лаунчера
|
||||
* 🏷️ Возможность изменять имя персонажа
|
||||
* 🧰 Не требуется дополнительный зависимостей
|
||||
* ⚙️ Нет необходимости в конфигурационных файлах
|
||||
|
||||
[GitHub](https://github.com/iiiypuk/minecraft-launcher/)
|
||||
[Начать](about)
|
||||
|
||||
|
||||
BIN
docs/_media/favicon.ico
Normal file
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
51
docs/_media/logo.svg
Normal 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 |
3
docs/_navbar.md
Normal file
3
docs/_navbar.md
Normal file
@ -0,0 +1,3 @@
|
||||
- Translations
|
||||
- [🇷🇺 Русский](/)
|
||||
- [🇺🇸 English](/en/)
|
||||
10
docs/_sidebar.md
Normal file
10
docs/_sidebar.md
Normal file
@ -0,0 +1,10 @@
|
||||
- [Обзор](about.md)
|
||||
|
||||
- Начало работы
|
||||
|
||||
- [Установка](installing.md)
|
||||
- [Переменные](variables.md)
|
||||
|
||||
- [Создание портативной сборки](portable.md)
|
||||
|
||||
- [История изменений](changelog.md)
|
||||
20
docs/about.md
Normal file
20
docs/about.md
Normal file
@ -0,0 +1,20 @@
|
||||
# Minecraft Batch Launcher
|
||||
Это простой скрипт для запуска Minecraft без официального лаунчера
|
||||
|
||||
## Для чего он нужен?
|
||||
* Для запуска необходимой версии игры, с любой директории и настройками
|
||||
* Для создания собственных сборок (адаптирование и бинарный лаунчер)
|
||||
* Для запуска Minecraft без лицензии (для тестирования серверов)
|
||||
|
||||
Отсутствие необходимости в компилировании лаунчера позволяет на лету изменять параметры просто редакитуя `*.bat` файл.
|
||||
|
||||
## Поддержка
|
||||
🩸 Вы можете поддержать автора проекта материально.
|
||||
В первую очередь это мотивирует поддерживать проект и разрабатывать похожие утилиты для других игр.
|
||||
Вот способы доната:
|
||||
|
||||
* [Ko-Fi](https://ko-fi.com/iiiypuk)
|
||||
* Переводом через СБП (`Тинкофф` `СберБанк` `ВТБ`) на номер **911 313-90-95**.
|
||||
|
||||
## Сведения
|
||||
  
|
||||
1
docs/changelog.md
Normal file
1
docs/changelog.md
Normal file
@ -0,0 +1 @@
|
||||
# 1.0.0 (2021-02.14)
|
||||
33
docs/index.html
Normal file
33
docs/index.html
Normal file
@ -0,0 +1,33 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<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">Пожалуйста, подождите...</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,
|
||||
// notFoundPage: 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
37
docs/installing.md
Normal 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) скрипта.
|
||||
2
docs/portable.md
Normal file
2
docs/portable.md
Normal file
@ -0,0 +1,2 @@
|
||||
# Создание портативной сборки
|
||||
|
||||
79
docs/variables.md
Normal file
79
docs/variables.md
Normal 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, которая определяет её переменные
|
||||
@ -1,2 +0,0 @@
|
||||
Natives catalog:
|
||||
https://mega.nz/#F!hUNg0Y6I!93cYw1NZg4MUWUHaVrCO7w
|
||||
5
package.json
Normal file
5
package.json
Normal file
@ -0,0 +1,5 @@
|
||||
{
|
||||
"dependencies": {
|
||||
"docsify-cli": "4.4.2"
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user