Quick Start

Порядок работы с движком, на примере запуска и отладки приложения Soccer.

Setup environment

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

Windows

Install Windows Terminal

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

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

wsl --set-version Debian 2

Mac OS

???

Install Visual Studio Code

Загрузите и установите VSCode для вашей ОС.

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 SDK в репозитории. Если нет, обратитесь к backend команде.

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

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

Install SDK prerequisites

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

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

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

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

Build

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

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

• Собрать дебаг версию: ./w4-build --build-debug
• Собрать релизную версию: ./w4-build --build-release
• Собрать продакшн версию: ./w4-build --build-shiped

Test Run

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

cd bin
serve -l 8080

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

http://localhost:8080/

VSCode as IDE

Initial setup

1. Запустите VSCode и установите расширение Remote WSL.
2. Подключитесь к Debian WSL.
3. Откройте SDK workspace.
4. Установите все приложения, которые будут рекомендованы системой.
5. Перезагрузите IDE.

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