View source for Quick Start/en

<languages />
W4 SDK DEMO Launch Procedure.
== Setup environment == <!--T:2-->
The project uses Debian OS, if it is already installed, you can go directly to the ''Debian environment settings'' section. For other operating systems, you must follow these steps (or make sure they are completed).

=== Windows ===
==== Install Windows Terminal ====
https://paper-attachments.dropbox.com/s_0034A86D613416109E895A76DA7A4F66C33EEAB8671A5C439351EC00BAE5D5EC_1581002573663_.png

It is not obliged to use Windows Terminal if you prefer another tool skip this section.

# Download the latest stable version of the installer from [https://github.com/microsoft/terminal/releases the project page] (the download link is in the Assets drop-down list under the changelog)and install the application.
# You can configure Windows Terminal by changing the settings.json file. In general, it is located in the directory LocalAppData\Packages\Microsoft.WindowsTerminal_8wekyb3d8bbwe\LocalState\ or similar one.
See [https://github.com/microsoft/terminal/blob/master/doc/user-docs/UsingJsonSettings.md the Windows Terminal documentation] for more information about customization.


==== Install WSL ====
To run a Debian image on Windows, use Windows Subsystem for Linux (WSL). It is recommended that you use WSL2, which requires Windows 10 build 18917 or later. If you have an old build of Windows 10, then you can work with WSL1. The difference is that on WSL1, some operations are much slower than on WSL2.

Follow these steps:
* Check / Enable the WSL component. To do this, in [https://docs.microsoft.com/en-us/powershell/?view=powershell-7 PowerShell], run the command:
  dism.exe / online / enable-feature / featurename: Microsoft-Windows-Subsystem-Linux / all / norestart
* If you can use WSL2, then also use the Virtual Machine Platform component:
  dism.exe / online / enable-feature / featurename: VirtualMachinePlatform / all / norestart
* Reboot the system to complete the installation of components.

==== Install Debian WSL Image ====
To add a Debian image, download and install the [https://www.microsoft.com/en-us/p/debian/9msvkqc78pk6?activetab=pivot:regionofsystemrequirementstab Debian application from the Microsoft Store].

If you use WSL2, initialize the distribution with the command (for WSL1 skip this item):
 wsl --set-version Debian 2

=== Mac OS (TBD) ===
TBD

== Debian environment settings ==
If you are working from another OS, start Debian (for example, through the Windows Terminal menu).
At the first start, you will be asked to set a username and password for logging in.

It is recommended to install the latest system updates by running the following commands:
 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 ===
<div class="mw-translate-fuzzy">
.
</div> 

Клонируйте репозиторий с SDK:
 git clone git@bitbucket.org:ciliz2/w4-sdk-demo.git

=== Install SDK prerequisites ===
Для начала работы с SDK перейдите в каталог:
 cd w4-sdk-demo
Выполните команду:
 ./w4 --prereq
<div class="mw-translate-fuzzy">
Reload Debian instance or subshell.
</div>
 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 ====
[https://code.visualstudio.com/ Загрузите и установите VSCode для вашей ОС].
==== Initial setup ====
<div class="mw-translate-fuzzy">
# Start VSCode and install Remote WSL extension 
# Connect to Debian WSL
# Open SDK workspace
# Install All recomemended extensions
# Reload IDE and work with code
</div>serve -l 8080