Difference between revisions of "Quick Start"

Revision as of 15:31, 13 April 2020

Other languages:

English • ‎русский

Порядок работы с движком, на примере запуска и отладки приложения Soccer.

Базовая настройка окружения

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

Для OS Windows

Install Windows Terminal

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

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

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

Терминал запускается как обычное приложение Windows (т.е. через меню Пуск).

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, загрузите приложение из Microsoft Store. Если используется WSL2, инициализируйте дистрибутив командой: wsl --set-version Debian 2

Для Mac OS

???

Install Visual Studio Code

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

Настройка окружения в Debian

Запустите Debian instance (например, через меню Windows Terminal). При первом запуске необходимо задать имя пользователя и пароль для входа в систему. Также рекомендуется установить последние обновления системы выполнив следующие команды:

sudo apt-get update 
sudo apt-get upgrade

Установка Git

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

sudo apt-get install git

Clone SDK

Клонируйте репозиторий с SDK:

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

Install SDK prerequisites

Если ваш проект требует node web server, его также можно установить. Для начала работы с SDK выполните следующие команды:

cd w4-sdk
./w4-prereq --install
npm -g install serve

Перезагрузите Debian instance или subshell.

Сборка проекта

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

Собрать дебаг версию: ./w4-build --build-debug
Собрать резизную версию: ./w4-build --build-release
Собрать продакшн версию: ./w4-build --build-shiped

Тестовый запуск

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

cd bin
serve -l 8080

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

Использование VSCode в качестве IDE

Первичная настройка

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

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

@@ Line 1: / Line 1: @@
-Рассмотрим порядок начала работы с движком, на примере запуска и отладки приложения Soccer.
+<languages />
+Порядок работы с движком, на примере запуска и отладки приложения Soccer.
 == Базовая настройка окружения ==
 Проект собирается под OS Debian. Прежде чем начать работу, необходимо выполнить следующие действия (или убедиться, что они выполнены):
@@ Line 21: / Line 23: @@
 ==== Install Debian WSL Image ====
 Для того чтобы добавить образ Debian, загрузите приложение из  [https://www.microsoft.com/en-us/p/debian/9msvkqc78pk6?activetab=pivot:regionofsystemrequirementstab Microsoft Store].
-При первом запуске необходимо задать имя пользователя и пароль для входа в систему.
 Если используется WSL2, инициализируйте дистрибутив командой: ''wsl --set-version Debian 2''
@@ Line 31: / Line 32: @@
 == Настройка окружения в Debian ==
+Запустите Debian instance (например, через меню Windows Terminal).
+При первом запуске необходимо задать имя пользователя и пароль для входа в систему.
+Также рекомендуется установить последние обновления системы выполнив следующие команды:
+ sudo apt-get update
+ sudo apt-get upgrade
+=== Установка Git ===
+Установите Git:
+ sudo apt-get install git
+=== Clone SDK ===
+Клонируйте репозиторий с SDK:
+ git clone git@bitbucket.org:ciliz2/w4-sdk.git
+=== Install SDK prerequisites ===
+''Если ваш проект требует node web server, его также можно установить.''
+Для начала работы с SDK выполните следующие команды:
+ cd w4-sdk
+ ./w4-prereq --install
+ npm -g install serve
+Перезагрузите Debian instance или subshell.
+== Сборка проекта ==
+Для сборки проекта выполните одну из следующих команд
+''При использовании WSL1 процесс сборки может быть долгим.''
+*Собрать дебаг версию: ./w4-build --build-debug
+*Собрать резизную версию: ./w4-build --build-release
+*Собрать продакшн версию: ./w4-build --build-shiped
+== Тестовый запуск ==
+Запустите локальный веб-сервер:
+ cd bin
+ serve -l 8080
+Проверьте игру через браузер, набрав в адресной строке ''http://localhost:8080/''
-Установка Git
+== Использование VSCode в качестве IDE ==
+=== Первичная настройка ===
+# Запустите VSCode и установите расширение Remote WSL
+# Подключитесь к Debian WSL
+# Откройте SDK workspace
+# Установите все приложения, которые будут рекомендованы системой.
+# Перезагрузите IDE.
+Можно приступать к работе с кодом.