Quick Start

Рекомендации по быстрому запуску W4 SDK.

Setup environment

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

Windows

Install Windows Terminal

Не обязательно использовать именно 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, загрузите одноименное приложение из Microsoft Store.

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

wsl --set-version Debian 2

Mac OS (TBD)

???

Debian environment settings

Запустите Debian instance (например, через меню Windows Terminal). При первом запуске необходимо задать имя пользователя и пароль для входа в систему. Также рекомендуется установить последние обновления системы выполнив следующие команды:

sudo apt-get update 
sudo apt-get upgrade

Install Git

Установите Git:

sudo apt-get install git

Clone SDK

До первого обращения к репозиторию потребуется сгенерировать SSH ключ и добавить открытый ключ в ваш аккаунт на Bitbucket. Этот же ключ нужно отправить команде W4, чтобы получить доступ к разделу W4.

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

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

Install SDK prerequisites

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

Для начала работы с SDK выполните следующие команды:

cd w4-sdk
./w4 --prereq
npm -g install serve

Перезагрузите Debian instance (или subshell).

Build

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

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

• Очистить каталоги от результатов предыдущей сборки: ./w4 --clean
• Собрать релизную версию: ./w4 --build

Test Run

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

cd deploy
serve -l 8080

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

http://localhost:8080/

Modification of the code

Для работы с кодом можно использовать любую удобную среду. Решение 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.
4. Установите все приложения, которые будут рекомендованы системой.
5. Перезагрузите IDE.

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

Making an Example Change

В поставку SDK входят примеры, которые не столько показывают возможности движка, сколько позволяют понять как работать с кодом.

Пример 1 (Название семпла)

TBD Что можно изменить?

Как изменить?

Не забудьте сохранить изменения.

Test Changes

Соберите билд и откройте игру в браузере так же, как было описано выше в разделе Test Run.