Quick Start

Рекомендуемый порядок установки и запуска W4 SDK DEMO.

Setup environment

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

Install Windows Terminal

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

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

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

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

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

До первого обращения к репозиторию потребуется сгенерировать SSH ключ и добавить открытый ключ в ваш аккаунт на Bitbucket. Этот же ключ нужно отправить команде W4, чтобы получить доступ к разделу. Примечание. Вместо генерации нового ключа, можно использовать уже имеющийся ключ, скопировав публичную и приватную часть в каталог .ssh домашней директории пользователя Debian и задав разрешения доступа к файлу ключа, командой chmod =600 ~/.ssh/id_rsa Клонируйте репозиторий с SDK:

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

Install SDK prerequisites

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

cd w4-sdk-demo

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

./w4 --prereq --install

Перезагрузите Debian instance (или subshell). Затем выполните команду:

npm -g install serve

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

Build

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

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

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

Test Run

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

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. Запустите VSCode и установите расширение Remote WSL.
2. Подключитесь к Debian WSL.
3. Откройте SDK workspace (укажите каталог, в котором находится файл w4.code-workspace в склонированном репозитории).
4. Установите все расширения, которые будут рекомендованы системой.
5. Перезагрузите IDE.

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