Difference between revisions of "Quick Start"

Latest revision as of 14:22, 1 June 2020

Рекомендуемый порядок установки и запуска W4 SDK DEMO.

Setup environment

Проект собирается под OS Debian, если она установлена можете сразу переходить к разделу Debian environment settings. Для работы под Windows необходимо предварительно выполнить следующие действия (или убедиться, что они выполнены).

Install Windows Terminal

s_0034A86D613416109E895A76DA7A4F66C33EEAB8671A5C439351EC00BAE5D5EC_1581002573663_.png

Не обязательно использовать именно Windows Terminal, если у вас установлен другой и вы знаете как с ним работать, пропускайте этот раздел.

Загрузите установщик последней стабильной версии со страницы проекта (ссылка на загрузку находится в раскрывающимся списке Assets под перечнем изменений) и установите приложение.
Настройка Windows Terminal производится через изменение settings.json. В общем случае он располагается в каталоге LocalAppData\Packages\Microsoft.WindowsTerminal_8wekyb3d8bbwe\LocalState\ или подобном. Пример настроек.

Подробнее о настройке см. в документации Windows Terminal.

Install WSL

Для запуска образа Debian под Windows используется Windows Subsystem for Linux (WSL). Рекомендуется использовать WSL2, для которой требуется Windows 10 build 18917 или более поздняя. Если у вас старая сборка Windows 10, то можно работать с WSL1. Разница в том, что на WSL1 некоторые операции выполняются значительно медленнее, чем на WSL2. Выполните следующие действия:

Проверьте/Задействуйте компонент WSL. Для этого в PowerShell выполните команду:

dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart

Если можете использовать WSL2, то задействуйте также компонент Virtual Machine Platform:

dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart

Перезагрузите систему для завершения установки компонентов.

Install Debian WSL Image

Для того чтобы добавить образ Debian, загрузите и установите приложение Debian из Microsoft Store.

Если вы используете WSL2, инициализируйте дистрибутив командой (для WSL1 этот пункт пропускается):

wsl --set-version Debian 2

Debian environment settings

При работе из другой ОС, запустите Debian (например, через меню Windows Terminal). При первом запуске будет предложено задать имя пользователя и пароль для входа в систему.

Рекомендуется установить последние обновления системы выполнив следующие команды:

sudo apt-get update 
sudo apt-get upgrade

Install Midnight Commander

Если вам не удобно работать с файлами из командной строки, установите Midnight Commander.

sudo apt-get install mc

Install Git

Установите Git:

sudo apt-get install git

Clone SDK

До первого обращения к репозиторию потребуется сгенерировать SSH ключ и добавить открытый ключ в ваш аккаунт на Bitbucket. Этот же ключ нужно отправить команде W4, чтобы получить доступ к разделу. Примечание. Вместо генерации нового ключа, можно использовать уже имеющийся ключ, скопировав публичную и приватную часть в каталог .ssh домашней директории пользователя Debian и задав разрешения доступа к файлу ключа, командой chmod =600 ~/.ssh/id_rsa Клонируйте репозиторий с SDK:

git clone git@bitbucket.org:ciliz2/w4-sdk-demo.git

Install SDK prerequisites

Для начала работы с SDK перейдите в каталог:

cd w4-sdk-demo

Выполните команду:

./w4 --prereq --install

Перезагрузите Debian instance (или subshell). Затем выполните команду:

npm -g install serve

Также может понадобиться установить node web server, если он необходим для вашего проекта.

Build

При использовании WSL1 процесс сборки может быть долгим.

Для сборки проекта используйте следующие команды, находясь в каталоге w4-sdk-demo:

Удалить результаты предыдущей сборки: ./w4 --clean
Собрать проект (дебажная версия): ./w4 --build

Test Run

Запустите локальный веб-сервер:

cd deploy
serve -l 8080

Проверьте игру через браузер, набрав в адресной строке:

http://localhost:8080/

Edit source code

Здесь даны общие сведения по работе с SDK. Подробнее работа с кодом разбирается на странице SDK Experiments.

Для работы с кодом можно использовать любую удобную среду. Далее описывается установка и настройка Visual Studio Code, так как это решение позволяет напрямую работать с кодом в Debian Instance, при запуске из вашей основной ОС.

VSCode as IDE

Install Visual Studio Code

Загрузите и установите VSCode для вашей ОС.

Initial setup

Запустите VSCode и установите расширение Remote WSL.
Подключитесь к Debian WSL.
Откройте SDK workspace (укажите каталог, в котором находится файл w4.code-workspace в склонированном репозитории).
Установите все расширения, которые будут рекомендованы системой.
Перезагрузите IDE.

Можно приступать к работе с кодом.

@@ Line 1: / Line 1: @@
-<languages />
 <translate>
 <!--T:1-->
-Порядок работы с движком, на примере запуска и отладки приложения Soccer.
+Рекомендуемый порядок установки и запуска W4 SDK DEMO.
 </translate>
 == Setup environment == <!--T:2-->
 <translate>
 <!--T:19-->
-Проект собирается под OS Debian. Прежде чем начать работу, необходимо выполнить следующие действия (или убедиться, что они выполнены).
+Проект собирается под OS Debian, если она установлена можете сразу переходить к разделу Debian environment settings. Для работы под Windows необходимо предварительно выполнить следующие действия (или убедиться, что они выполнены).
 </translate>
-=== Windows ===
-==== Install Windows Terminal ====
+=== Install Windows Terminal ===
+https://paper-attachments.dropbox.com/s_0034A86D613416109E895A76DA7A4F66C33EEAB8671A5C439351EC00BAE5D5EC_1581002573663_.png
 <translate>
 <!--T:3-->
-''Не обязательно использовать именно Windows Terminal, если у вас установлен другой, можете пропустить этот раздел.''
+''Не обязательно использовать именно Windows Terminal, если у вас установлен другой и вы знаете как с ним работать, пропускайте этот раздел.''
 <!--T:4-->
-# Загрузите установщик последней стабильной версии со [https://github.com/microsoft/terminal/releases страницы проекта] (ссылка на загрузку находится в раскрывающимся списке Assets под перечнем изменений).
+# Загрузите установщик последней стабильной версии со [https://github.com/microsoft/terminal/releases страницы проекта] (ссылка на загрузку находится в раскрывающимся списке Assets под перечнем изменений) и установите приложение.
-# Установите приложение. Установка не имеет каких-либо особенностей.
+# Настройка Windows Terminal производится через изменение settings.json. В общем случае он располагается в каталоге LocalAppData\Packages\Microsoft.WindowsTerminal_8wekyb3d8bbwe\LocalState\ или подобном. [https://gist.github.com/donkaban/3e9275f87c81e6ef5dbeb98aa5b96ee5 Пример настроек].
-# Настройте Windows Terminal. Настройка производится через изменение settings.json. В общем случае он располагается в каталоге LocalAppData\Packages\Microsoft.WindowsTerminal_8wekyb3d8bbwe\LocalState\ . [https://gist.github.com/donkaban/3e9275f87c81e6ef5dbeb98aa5b96ee5 Пример настроек].
 Подробнее о настройке см. в [https://github.com/microsoft/terminal/blob/master/doc/user-docs/UsingJsonSettings.md документации Windows Terminal].
-<!--T:5-->
-Терминал запускается как обычное приложение Windows.
 </translate>
-==== Install WSL ====
+=== Install WSL ===
 <translate>
 <!--T:6-->
 Для запуска образа Debian под Windows используется Windows Subsystem for Linux (WSL). Рекомендуется использовать WSL2, для которой требуется Windows 10 build 18917 или более поздняя. Если у вас старая сборка Windows 10, то можно работать с WSL1. Разница в том, что на WSL1 некоторые операции выполняются значительно медленнее, чем на WSL2.
+Выполните следующие действия:
 * Проверьте/Задействуйте компонент WSL. Для этого в [https://docs.microsoft.com/en-us/powershell/?view=powershell-7 PowerShell] выполните команду:
   dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart
-* Для дальнейшей установки WSL2 задействуйте также компонент Virtual Machine Platform:
+* Если можете использовать WSL2, то задействуйте также компонент Virtual Machine Platform:
   dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
 * Перезагрузите систему для завершения установки компонентов.
 </translate>
-==== Install Debian WSL Image ====
+=== Install Debian WSL Image ===
 <translate>
 <!--T:7-->
-Для того чтобы добавить образ Debian, загрузите [https://www.microsoft.com/en-us/p/debian/9msvkqc78pk6?activetab=pivot:regionofsystemrequirementstab одноименное приложение из Microsoft Store].
+Для того чтобы добавить образ Debian, загрузите и установите [https://www.microsoft.com/en-us/p/debian/9msvkqc78pk6?activetab=pivot:regionofsystemrequirementstab приложение Debian из Microsoft Store].
-Для WSL2, инициализируйте дистрибутив командой:
+<!--T:21-->
+Если вы используете WSL2, инициализируйте дистрибутив командой (для WSL1 этот пункт пропускается):
 </translate>
   wsl --set-version Debian 2
-=== Mac OS ===
-<translate>
-<!--T:8-->
-???
-</translate>
-=== Install Visual Studio Code ===
-<translate>
-<!--T:9-->
-[https://code.visualstudio.com/ Загрузите и установите VSCode для вашей ОС].
-</translate>
 == Debian environment settings ==
 <translate>
 <!--T:10-->
-Запустите Debian instance (например, через меню Windows Terminal).
+При работе из другой ОС, запустите Debian (например, через меню Windows Terminal).
-При первом запуске необходимо задать имя пользователя и пароль для входа в систему.
+При первом запуске будет предложено задать имя пользователя и пароль для входа в систему.
-Также рекомендуется установить последние обновления системы выполнив следующие команды:
+<!--T:22-->
+Рекомендуется установить последние обновления системы выполнив следующие команды:
 </translate>
   sudo apt-get update
   sudo apt-get upgrade
+=== Install Midnight Commander ===
+<translate>
+<!--T:28-->
+Если вам не удобно работать с файлами из командной строки, установите Midnight Commander.
+</translate>
+ sudo apt-get install mc
 === Install Git ===
 <translate>
@@ Line 73: / Line 73: @@
 <translate>
 <!--T:12-->
-До первого обращения к репозиторию потребуется [https://confluence.atlassian.com/bitbucket/set-up-an-ssh-key-728138079.html сгенерировать SSH ключ и добавить его в ваш аккаунт на Bitbucket].
+До первого обращения к репозиторию потребуется [https://confluence.atlassian.com/bitbucket/set-up-an-ssh-key-728138079.html сгенерировать SSH ключ и добавить открытый ключ в ваш аккаунт на Bitbucket]. Этот же ключ нужно отправить команде W4, чтобы получить доступ к разделу.
+''Примечание. Вместо генерации нового ключа, можно использовать уже имеющийся ключ, скопировав публичную и приватную часть в каталог .ssh домашней директории пользователя Debian и задав разрешения доступа к файлу ключа, командой'' chmod =600 ~/.ssh/id_rsa
+</translate>
+<translate>
 <!--T:20-->
 Клонируйте репозиторий с SDK:
 </translate>
-  git clone git@bitbucket.org:ciliz2/w4-sdk.git
+  git clone git@bitbucket.org:ciliz2/w4-sdk-demo.git
 === Install SDK prerequisites ===
 <translate>
 <!--T:13-->
-''Если ваш проект требует node web server, его также можно установить.''
+Для начала работы с SDK перейдите в каталог:
-Для начала работы с SDK выполните следующие команды:
+</translate>
+ cd w4-sdk-demo
+<translate>
+<!--T:23-->
+Выполните команду:
+</translate>
+ ./w4 --prereq --install
+<translate>
+<!--T:14-->
+Перезагрузите Debian instance (или subshell). Затем выполните команду:
 </translate>
- cd w4-sdk
- ./w4-prereq --install
   npm -g install serve
 <translate>
-<!--T:14-->
+<!--T:24-->
-Перезагрузите Debian instance или subshell.
+''Также может понадобиться установить node web server, если он необходим для вашего проекта.''
 </translate>
 == Build ==
 <translate>
 <!--T:15-->
-Для сборки проекта выполните одну из следующих команд
 ''При использовании WSL1 процесс сборки может быть долгим.''
-*Собрать дебаг версию: ./w4-build --build-debug
-*Собрать резизную версию: ./w4-build --build-release
+<!--T:25-->
-*Собрать продакшн версию: ./w4-build --build-shiped
+Для сборки проекта используйте следующие команды, находясь в каталоге '''w4-sdk-demo''':
+*Удалить результаты предыдущей сборки: '''./w4 --clean'''
+*Собрать проект (дебажная версия): '''./w4 --build'''
 </translate>
 == Test Run ==
 <translate>
@@ Line 107: / Line 119: @@
 Запустите локальный веб-сервер:
 </translate>
-  cd bin
+  cd deploy
   serve -l 8080
 <translate>
@@ Line 115: / Line 127: @@
   http://localhost:8080/
-== VSCode as IDE ==
+== Edit source code ==
-=== Initial setup ===
+<translate>
+<!--T:26-->
+Здесь даны общие сведения по работе с SDK. Подробнее работа с кодом разбирается на странице [[SDK Experiments]].
+<!--T:27-->
+Для работы с кодом можно использовать любую удобную среду. Далее описывается установка и настройка Visual Studio Code, так как это решение позволяет напрямую работать с кодом в Debian Instance, при запуске из вашей основной ОС.
+</translate>
+=== VSCode as IDE ===
+==== Install Visual Studio Code ====
+<translate>
+<!--T:9-->
+[https://code.visualstudio.com/ Загрузите и установите VSCode для вашей ОС].
+</translate>
+==== Initial setup ====
 <translate>
 <!--T:18-->
 # Запустите VSCode и установите расширение Remote WSL.
 # Подключитесь к Debian WSL.
-# Откройте SDK workspace.
+# Откройте SDK workspace (укажите каталог, в котором находится файл w4.code-workspace в склонированном репозитории).
-# Установите все приложения, которые будут рекомендованы системой.
+# Установите все расширения, которые будут рекомендованы системой.
 # Перезагрузите IDE.
 Можно приступать к работе с кодом.
 </translate>