Difference between revisions of "Quick Start/en"

From Ciliz|W4
(Updating to match new version of source page)
Line 1: Line 1:
 
<languages />
 
<languages />
−
Working with the engine using the example of launching and debugging Soccer application.
+
W4 SDK DEMO Launch Procedure.
 
== Setup environment == <!--T:2-->
 
== Setup environment == <!--T:2-->
 +
<div class="mw-translate-fuzzy">
 
The project uses OS Debian. Before you begin, you must complete the following steps (or make sure they are completed).
 
The project uses OS Debian. Before you begin, you must complete the following steps (or make sure they are completed).
 +
</div>
 +
 
=== Windows ===
 
=== Windows ===
 
==== Install Windows Terminal ====
 
==== Install Windows Terminal ====
−
''Не обязательно использовать именно Windows Terminal, если у вас установлен другой и вы знаете как с ним работать, можете пропустить этот раздел.''
+
https://paper-attachments.dropbox.com/s_0034A86D613416109E895A76DA7A4F66C33EEAB8671A5C439351EC00BAE5D5EC_1581002573663_.png
 +
 
 +
''Не обязательно использовать именно Windows Terminal, если у вас установлен другой и вы знаете как с ним работать, пропускайте этот раздел.''
  
−
# Загрузите установщик последней стабильной версии со [https://github.com/microsoft/terminal/releases страницы проекта] (ссылка на загрузку находится в раскрывающимся списке Assets под перечнем изменений).
+
# Загрузите установщик последней стабильной версии со [https://github.com/microsoft/terminal/releases страницы проекта] (ссылка на загрузку находится в раскрывающимся списке Assets под перечнем изменений) и установите приложение.
−
# Установите приложение (установка Windows Terminal не имеет каких-либо особенностей).
+
# Настройка 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].
 
Подробнее о настройке см. в [https://github.com/microsoft/terminal/blob/master/doc/user-docs/UsingJsonSettings.md документации Windows Terminal].
  
−
Терминал запускается как обычное приложение Windows (т.е. через меню Пуск).
+
Терминал запускается как обычное приложение Windows.
 +
 
 
==== Install WSL ====
 
==== Install WSL ====
 
Для запуска образа 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''
+
Выполните следующие действия:
−
# Для дальнейшей установки WSL2 задействуйте также компонент Virtual Machine Platform:  
+
* Проверьте/Задействуйте компонент WSL. Для этого в [https://docs.microsoft.com/en-us/powershell/?view=powershell-7 PowerShell] выполните команду:  
−
''dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart''
+
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 ====
 
==== Install Debian WSL Image ====
−
Для того чтобы добавить образ 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, инициализируйте дистрибутив командой: ''wsl --set-version Debian 2''
+
 
−
=== Mac OS ===
+
Если вы используете WSL2, инициализируйте дистрибутив командой (для WSL1 этот пункт пропускается):
 +
wsl --set-version Debian 2
 +
 
 +
=== Mac OS (TBD) ===
 
???
 
???
−
=== Install Visual Studio Code ===
+
 
−
[https://code.visualstudio.com/ Загрузите и установите VSCode для вашей ОС].
 
 
== Debian environment settings ==
 
== Debian environment settings ==
−
Запустите Debian instance (например, через меню Windows Terminal).
+
При работе из другой ОС, запустите Debian (например, через меню Windows Terminal).
−
При первом запуске необходимо задать имя пользователя и пароль для входа в систему.
+
При первом запуске будет предложено задать имя пользователя и пароль для входа в систему.
−
Также рекомендуется установить последние обновления системы выполнив следующие команды:
+
 
 +
Рекомендуется установить последние обновления системы выполнив следующие команды:
 
  sudo apt-get update  
 
  sudo apt-get update  
 
  sudo apt-get upgrade
 
  sudo apt-get upgrade
 +
 +
=== Install Midnight Commander ===
 +
Если вам не удобно работать с файлами из командной строки, установите Midnight Commander.
 +
 +
sudo apt-get install mc
 +
 
=== Install Git ===
 
=== Install Git ===
 
Установите Git:
 
Установите Git:
Line 38: Line 55:
 
<div class="mw-translate-fuzzy">
 
<div class="mw-translate-fuzzy">
 
.
 
.
−
</div>
+
</div>  
  
 
Клонируйте репозиторий с SDK:
 
Клонируйте репозиторий с SDK:
−
  git clone git@bitbucket.org:ciliz2/w4-sdk.git
+
  git clone git@bitbucket.org:ciliz2/w4-sdk-demo.git
  
 
=== Install SDK prerequisites ===
 
=== Install SDK prerequisites ===
−
''Если ваш проект требует node web server, его также можно установить.''
+
Для начала работы с SDK перейдите в каталог:
−
Для начала работы с SDK выполните следующие команды:
+
  cd w4-sdk-demo
−
  cd w4-sdk
+
Выполните команду:
−
  ./w4-prereq --install
+
  ./w4 --prereq
 +
<div class="mw-translate-fuzzy">
 +
Reload Debian instance or subshell.
 +
</div>
 
  npm -g install serve
 
  npm -g install serve
−
Reload Debian instance or subshell.
+
''Также может понадобиться установить node web server, если он необходим для вашего проекта.''
 
== Build ==
 
== Build ==
−
Для сборки проекта выполните одну из следующих команд
 
 
''При использовании WSL1 процесс сборки может быть долгим.''
 
''При использовании WSL1 процесс сборки может быть долгим.''
−
*Собрать дебаг версию: ./w4-build --build-debug
+
 
−
*Собрать резизную версию: ./w4-build --build-release
+
Для сборки проекта используйте следующие команды, находясь в каталоге '''w4-sdk-demo''':
−
*Собрать продакшн версию: ./w4-build --build-shiped
+
*Удалить результаты предыдущей сборки: '''./w4 --clean'''
 +
*Собрать проект (дебажная версия): '''./w4 --build'''
 +
 
 
== Test Run ==
 
== Test Run ==
 
Start webserver:
 
Start webserver:
−
  cd bin
+
  cd deploy
 
  serve -l 8080
 
  serve -l 8080
 
Проверьте игру через браузер, набрав в адресной строке:
 
Проверьте игру через браузер, набрав в адресной строке:
 
  http://localhost:8080/
 
  http://localhost:8080/
  
−
== VSCode as IDE ==
+
== Edit source code ==
−
=== Initial setup ===
+
Здесь даны общие сведения по работе с SDK. Подробнее работа с кодом разбирается на странице [[SDK Experiments]].
 +
 
 +
Для работы с кодом можно использовать любую удобную среду. Далее описывается установка и настройка Visual Studio Code, так как это решение позволяет напрямую работать с кодом в Debian Instance, при запуске из вашей основной ОС.
 +
=== VSCode as IDE ===
 +
==== Install Visual Studio Code ====
 +
[https://code.visualstudio.com/ Загрузите и установите VSCode для вашей ОС].
 +
==== Initial setup ====
 
<div class="mw-translate-fuzzy">
 
<div class="mw-translate-fuzzy">
 
# Start VSCode and install Remote WSL extension  
 
# Start VSCode and install Remote WSL extension  
Line 71: Line 98:
 
# Install All recomemended extensions
 
# Install All recomemended extensions
 
# Reload IDE and work with code
 
# Reload IDE and work with code
−
</div>
+
</div>serve -l 8080

Revision as of 11:10, 13 May 2020

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

W4 SDK DEMO Launch Procedure.

Setup environment

The project uses OS Debian. Before you begin, you must complete the following steps (or make sure they are completed).

Windows

Install Windows Terminal

s_0034A86D613416109E895A76DA7A4F66C33EEAB8671A5C439351EC00BAE5D5EC_1581002573663_.png

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

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

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

wsl --set-version Debian 2

Mac OS (TBD)

???

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

.

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

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

Install SDK prerequisites

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

cd w4-sdk-demo

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

./w4 --prereq

Reload Debian instance or subshell. 

npm -g install serve

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

Build

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

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

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

Test Run

Start webserver: 

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

  1. Start VSCode and install Remote WSL extension
  2. Connect to Debian WSL
  3. Open SDK workspace
  4. Install All recomemended extensions
  5. Reload IDE and work with code

serve -l 8080

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