Difference between revisions of "Quick Start"
Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
− | + | Рекомендации по быстрому запуску W4 SDK. | |
</translate> | </translate> | ||
== Setup environment == <!--T:2--> | == Setup environment == <!--T:2--> | ||
Line 69: | Line 69: | ||
<translate> | <translate> | ||
<!--T:12--> | <!--T:12--> | ||
− | До первого обращения к репозиторию потребуется [https://confluence.atlassian.com/bitbucket/set-up-an-ssh-key-728138079.html сгенерировать SSH ключ и добавить | + | До первого обращения к репозиторию потребуется [https://confluence.atlassian.com/bitbucket/set-up-an-ssh-key-728138079.html сгенерировать SSH ключ и добавить открытый ключ в ваш аккаунт на Bitbucket]. Этот же ключ нужно отправить команде W4, чтобы получить доступ к разделу W4. |
− | |||
− | |||
<!--T:20--> | <!--T:20--> | ||
Line 86: | Line 84: | ||
</translate> | </translate> | ||
cd w4-sdk | cd w4-sdk | ||
− | ./w4-prereq | + | ./w4 --prereq |
npm -g install serve | npm -g install serve | ||
<translate> | <translate> | ||
<!--T:14--> | <!--T:14--> | ||
− | Перезагрузите Debian instance или subshell. | + | Перезагрузите Debian instance (или subshell). |
</translate> | </translate> | ||
Line 98: | Line 96: | ||
''При использовании WSL1 процесс сборки может быть долгим.'' | ''При использовании WSL1 процесс сборки может быть долгим.'' | ||
− | Для сборки проекта | + | Для сборки проекта используйте следующие команды, находясь в каталоге w4-sdk: |
− | *Очистить каталоги от предыдущей сборки: ./w4 | + | *Очистить каталоги от результатов предыдущей сборки: ./w4 --clean |
− | *Собрать релизную версию: ./w4- | + | *Собрать релизную версию: ./w4 --build |
− | |||
</translate> | </translate> | ||
Line 109: | Line 106: | ||
Запустите локальный веб-сервер: | Запустите локальный веб-сервер: | ||
</translate> | </translate> | ||
− | cd | + | cd deploy |
serve -l 8080 | serve -l 8080 | ||
<translate> | <translate> |
Revision as of 13:57, 24 April 2020
Рекомендации по быстрому запуску W4 SDK.
Contents
Setup environment
Проект собирается под OS Debian. Прежде чем начать работу, необходимо выполнить следующие действия (или убедиться, что они выполнены).
Windows
Install Windows Terminal
Не обязательно использовать именно Windows Terminal, если у вас установлен другой, можете пропустить этот раздел.
- Загрузите установщик последней стабильной версии со страницы проекта (ссылка на загрузку находится в раскрывающимся списке Assets под перечнем изменений).
- Установите приложение. Установка не имеет каких-либо особенностей.
- Настройте 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
- Запустите VSCode и установите расширение Remote WSL.
- Подключитесь к Debian WSL.
- Откройте SDK workspace.
- Установите все приложения, которые будут рекомендованы системой.
- Перезагрузите IDE.
Можно приступать к работе с кодом.
Making an Example Change
В поставку SDK входят примеры, которые не столько показывают возможности движка, сколько позволяют понять как работать с кодом.
Пример 1 (Название семпла)
TBD Что можно изменить?
Как изменить?
Не забудьте сохранить изменения.
Test Changes
Соберите билд и откройте игру в браузере так же, как было описано выше в разделе Test Run.