Difference between revisions of "Quick Start"

From Ciliz|W4
(Marked this version for translation)
Line 1: Line 1:
 
<languages />
 
<languages />
 
<translate>
 
<translate>
 +
<!--T:1-->
 
Порядок работы с движком, на примере запуска и отладки приложения Soccer.
 
Порядок работы с движком, на примере запуска и отладки приложения Soccer.
 
</translate>
 
</translate>
 
<translate>
 
<translate>
−
== Базовая настройка окружения ==
+
== Базовая настройка окружения == <!--T:2-->
 
Проект собирается под OS Debian. Прежде чем начать работу, необходимо выполнить следующие действия (или убедиться, что они выполнены).
 
Проект собирается под OS Debian. Прежде чем начать работу, необходимо выполнить следующие действия (или убедиться, что они выполнены).
 
</translate>
 
</translate>
Line 10: Line 11:
 
==== Install Windows Terminal ====
 
==== Install Windows Terminal ====
 
<translate>
 
<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 не имеет каких-либо особенностей).
 
# Установите приложение (установка Windows Terminal не имеет каких-либо особенностей).
Line 17: Line 20:
 
Подробнее о настройке см. в [https://github.com/microsoft/terminal/blob/master/doc/user-docs/UsingJsonSettings.md документации Windows Terminal].
 
Подробнее о настройке см. в [https://github.com/microsoft/terminal/blob/master/doc/user-docs/UsingJsonSettings.md документации Windows Terminal].
  
 +
<!--T:5-->
 
Терминал запускается как обычное приложение Windows (т.е. через меню Пуск).
 
Терминал запускается как обычное приложение Windows (т.е. через меню Пуск).
 
</translate>
 
</translate>
 
==== Install WSL ====
 
==== Install WSL ====
 
<translate>
 
<translate>
 +
<!--T:6-->
 
Для запуска образа Debian под Windows используется Windows Subsystem for Linux (WSL). Рекомендуется использовать WSL2, для которой требуется Windows 10 build 18917 или более поздняя. Если у вас старая сборка Windows 10, то можно работать с WSL1. Разница в том, что на WSL1 некоторые операции выполняются значительно медленнее, чем на WSL2.
 
Для запуска образа 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''  
 
# Проверьте/Задействуйте компонент WSL. Для этого в PowerShell выполните команду: ''dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart''  
Line 29: Line 34:
 
==== Install Debian WSL Image ====
 
==== Install Debian WSL Image ====
 
<translate>
 
<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 Microsoft Store].
 
Если используется WSL2, инициализируйте дистрибутив командой: ''wsl --set-version Debian 2''
 
Если используется WSL2, инициализируйте дистрибутив командой: ''wsl --set-version Debian 2''
Line 34: Line 40:
 
=== Mac OS ===
 
=== Mac OS ===
 
<translate>
 
<translate>
 +
<!--T:8-->
 
???
 
???
 
</translate>
 
</translate>
 
=== Install Visual Studio Code ===
 
=== Install Visual Studio Code ===
 
<translate>
 
<translate>
 +
<!--T:9-->
 
[https://code.visualstudio.com/ Загрузите и установите VSCode для вашей ОС].
 
[https://code.visualstudio.com/ Загрузите и установите VSCode для вашей ОС].
 
</translate>
 
</translate>
 
== Настройка окружения в Debian ==
 
== Настройка окружения в Debian ==
 
<translate>
 
<translate>
 +
<!--T:10-->
 
Запустите Debian instance (например, через меню Windows Terminal).
 
Запустите Debian instance (например, через меню Windows Terminal).
 
При первом запуске необходимо задать имя пользователя и пароль для входа в систему.
 
При первом запуске необходимо задать имя пользователя и пароль для входа в систему.
Line 50: Line 59:
 
=== Install Git ===
 
=== Install Git ===
 
<translate>
 
<translate>
 +
<!--T:11-->
 
Установите Git:
 
Установите Git:
 
</translate>
 
</translate>
Line 55: Line 65:
 
=== Clone SDK ===
 
=== Clone SDK ===
 
<translate>
 
<translate>
 +
<!--T:12-->
 
Клонируйте репозиторий с SDK:
 
Клонируйте репозиторий с SDK:
 
</translate>
 
</translate>
Line 61: Line 72:
 
=== Install SDK prerequisites ===
 
=== Install SDK prerequisites ===
 
<translate>
 
<translate>
 +
<!--T:13-->
 
''Если ваш проект требует node web server, его также можно установить.''
 
''Если ваш проект требует node web server, его также можно установить.''
 
Для начала работы с SDK выполните следующие команды:
 
Для начала работы с SDK выполните следующие команды:
Line 68: Line 80:
 
  npm -g install serve
 
  npm -g install serve
 
<translate>
 
<translate>
 +
<!--T:14-->
 
Перезагрузите Debian instance или subshell.
 
Перезагрузите Debian instance или subshell.
 
</translate>
 
</translate>
 
== Build ==
 
== Build ==
 
<translate>
 
<translate>
 +
<!--T:15-->
 
Для сборки проекта выполните одну из следующих команд
 
Для сборки проекта выполните одну из следующих команд
 
''При использовании WSL1 процесс сборки может быть долгим.''
 
''При использовании WSL1 процесс сборки может быть долгим.''
Line 80: Line 94:
 
== Test Run ==
 
== Test Run ==
 
<translate>
 
<translate>
 +
<!--T:16-->
 
Запустите локальный веб-сервер:
 
Запустите локальный веб-сервер:
 
</translate>
 
</translate>
Line 85: Line 100:
 
  serve -l 8080
 
  serve -l 8080
 
<translate>
 
<translate>
 +
<!--T:17-->
 
Проверьте игру через браузер, набрав в адресной строке ''http://localhost:8080/''
 
Проверьте игру через браузер, набрав в адресной строке ''http://localhost:8080/''
 
</translate>
 
</translate>
Line 90: Line 106:
 
=== Initial setup ===
 
=== Initial setup ===
 
<translate>
 
<translate>
 +
<!--T:18-->
 
# Запустите VSCode и установите расширение Remote WSL  
 
# Запустите VSCode и установите расширение Remote WSL  
 
# Подключитесь к Debian WSL
 
# Подключитесь к Debian WSL

Revision as of 15:45, 13 April 2020

Other languages:
English • ‎русский

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

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

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

Windows

Install Windows Terminal

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

  1. Загрузите установщик последней стабильной версии со страницы проекта (ссылка на загрузку находится в раскрывающимся списке Assets под перечнем изменений).
  2. Установите приложение (установка Windows Terminal не имеет каких-либо особенностей).
  3. Настройте 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.

  1. Проверьте/Задействуйте компонент WSL. Для этого в PowerShell выполните команду: dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart
  2. Для дальнейшей установки WSL2 задействуйте также компонент Virtual Machine Platform:

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

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

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

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

Build

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

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

Test Run

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

cd bin
serve -l 8080

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

VSCode as IDE

Initial setup

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

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

Retrieved from "http://wiki.w4-dev.ciliz.com/index.php?title=Quick_Start&oldid=175"