Quick Start/en

W4 SDK DEMO Launch Procedure.

Setup environment

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

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

1. Download the latest stable version of the installer from the project page (the download link is in the Assets drop-down list under the changelog)and install the application.
2. 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 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 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 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.

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

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