Difference between revisions of "Quick Start"
| Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
| − | + | Рекомендуемый порядок установки и запуска W4 SDK DEMO. | |
</translate> | </translate> | ||
== Setup environment == <!--T:2--> | == Setup environment == <!--T:2--> | ||
| Line 14: | Line 14: | ||
<translate> | <translate> | ||
<!--T:3--> | <!--T:3--> | ||
| − | ''Не обязательно использовать именно Windows Terminal, если у вас установлен другой и вы знаете как с ним работать, | + | ''Не обязательно использовать именно Windows Terminal, если у вас установлен другой и вы знаете как с ним работать, пропускайте этот раздел.'' |
<!--T:4--> | <!--T:4--> | ||
# Загрузите установщик последней стабильной версии со [https://github.com/microsoft/terminal/releases страницы проекта] (ссылка на загрузку находится в раскрывающимся списке Assets под перечнем изменений) и установите приложение. | # Загрузите установщик последней стабильной версии со [https://github.com/microsoft/terminal/releases страницы проекта] (ссылка на загрузку находится в раскрывающимся списке Assets под перечнем изменений) и установите приложение. | ||
| − | # | + | # Настройка Windows Terminal производится через изменение settings.json. В общем случае он располагается в каталоге LocalAppData\Packages\Microsoft.WindowsTerminal_8wekyb3d8bbwe\LocalState\ или подобном. [https://gist.github.com/donkaban/3e9275f87c81e6ef5dbeb98aa5b96ee5 Пример настроек]. |
Подробнее о настройке см. в [https://github.com/microsoft/terminal/blob/master/doc/user-docs/UsingJsonSettings.md документации Windows Terminal]. | Подробнее о настройке см. в [https://github.com/microsoft/terminal/blob/master/doc/user-docs/UsingJsonSettings.md документации Windows Terminal]. | ||
| Line 29: | Line 29: | ||
<!--T:6--> | <!--T:6--> | ||
Для запуска образа Debian под Windows используется Windows Subsystem for Linux (WSL). Рекомендуется использовать WSL2, для которой требуется Windows 10 build 18917 или более поздняя. Если у вас старая сборка Windows 10, то можно работать с WSL1. Разница в том, что на WSL1 некоторые операции выполняются значительно медленнее, чем на WSL2. | Для запуска образа Debian под Windows используется Windows Subsystem for Linux (WSL). Рекомендуется использовать WSL2, для которой требуется Windows 10 build 18917 или более поздняя. Если у вас старая сборка Windows 10, то можно работать с WSL1. Разница в том, что на WSL1 некоторые операции выполняются значительно медленнее, чем на WSL2. | ||
| + | Выполните следующие действия: | ||
* Проверьте/Задействуйте компонент WSL. Для этого в [https://docs.microsoft.com/en-us/powershell/?view=powershell-7 PowerShell] выполните команду: | * Проверьте/Задействуйте компонент WSL. Для этого в [https://docs.microsoft.com/en-us/powershell/?view=powershell-7 PowerShell] выполните команду: | ||
dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart | 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 | dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart | ||
* Перезагрузите систему для завершения установки компонентов. | * Перезагрузите систему для завершения установки компонентов. | ||
| Line 39: | Line 40: | ||
<translate> | <translate> | ||
<!--T:7--> | <!--T:7--> | ||
| − | Для того чтобы добавить образ Debian, загрузите [https://www.microsoft.com/en-us/p/debian/9msvkqc78pk6?activetab=pivot:regionofsystemrequirementstab | + | Для того чтобы добавить образ Debian, загрузите и установите [https://www.microsoft.com/en-us/p/debian/9msvkqc78pk6?activetab=pivot:regionofsystemrequirementstab приложение Debian из Microsoft Store]. |
Если вы используете WSL2, инициализируйте дистрибутив командой (для WSL1 этот пункт пропускается): | Если вы используете WSL2, инициализируйте дистрибутив командой (для WSL1 этот пункт пропускается): | ||
| Line 54: | Line 55: | ||
<translate> | <translate> | ||
<!--T:10--> | <!--T:10--> | ||
| − | При работе из другой ОС, запустите Debian | + | При работе из другой ОС, запустите Debian (например, через меню Windows Terminal). |
При первом запуске будет предложено задать имя пользователя и пароль для входа в систему. | При первом запуске будет предложено задать имя пользователя и пароль для входа в систему. | ||
| − | + | ||
| + | Рекомендуется установить последние обновления системы выполнив следующие команды: | ||
</translate> | </translate> | ||
sudo apt-get update | sudo apt-get update | ||
sudo apt-get upgrade | sudo apt-get upgrade | ||
| + | |||
| + | === Install Midnight Commander === | ||
| + | Если вам не удобно работать с файлами из командной строки, установите Midnight Commander. | ||
| + | |||
| + | sudo apt-get install mc | ||
| + | |||
=== Install Git === | === Install Git === | ||
<translate> | <translate> | ||
| Line 70: | Line 78: | ||
<!--T:12--> | <!--T:12--> | ||
До первого обращения к репозиторию потребуется [https://confluence.atlassian.com/bitbucket/set-up-an-ssh-key-728138079.html сгенерировать SSH ключ и добавить открытый ключ в ваш аккаунт на Bitbucket]. Этот же ключ нужно отправить команде W4, чтобы получить доступ к разделу. | До первого обращения к репозиторию потребуется [https://confluence.atlassian.com/bitbucket/set-up-an-ssh-key-728138079.html сгенерировать SSH ключ и добавить открытый ключ в ваш аккаунт на Bitbucket]. Этот же ключ нужно отправить команде W4, чтобы получить доступ к разделу. | ||
| + | ''Примечание. Вместо генерации нового ключа, можно использовать уже имеющийся ключ, скопировав публичную и приватную часть в каталог .ssh домашней директории пользователя Debian и задав разрешения доступа к файлу ключа, командой'' chmod =600 ~/.ssh/id_rsa | ||
<!--T:20--> | <!--T:20--> | ||
Клонируйте репозиторий с SDK: | Клонируйте репозиторий с SDK: | ||
</translate> | </translate> | ||
| − | git clone git@bitbucket.org:ciliz2/w4-sdk.git | + | git clone git@bitbucket.org:ciliz2/w4-sdk-demo.git |
=== Install SDK prerequisites === | === Install SDK prerequisites === | ||
<translate> | <translate> | ||
<!--T:13--> | <!--T:13--> | ||
| − | Для начала работы с SDK | + | Для начала работы с SDK перейдите в каталог: |
| + | </translate> | ||
| + | cd w4-sdk-demo | ||
| + | <translate> | ||
| + | Выполните команду: | ||
</translate> | </translate> | ||
| − | |||
./w4 --prereq | ./w4 --prereq | ||
| + | <translate> | ||
| + | <!--T:14--> | ||
| + | Перезагрузите Debian instance (или subshell). Затем выполните команду: | ||
| + | </translate> | ||
npm -g install serve | npm -g install serve | ||
<translate> | <translate> | ||
''Также может понадобиться установить node web server, если он необходим для вашего проекта.'' | ''Также может понадобиться установить node web server, если он необходим для вашего проекта.'' | ||
| − | |||
| − | |||
</translate> | </translate> | ||
| − | |||
== Build == | == Build == | ||
<translate> | <translate> | ||
| Line 95: | Line 108: | ||
''При использовании WSL1 процесс сборки может быть долгим.'' | ''При использовании WSL1 процесс сборки может быть долгим.'' | ||
| − | Для сборки проекта используйте следующие команды, находясь в каталоге '''w4-sdk''': | + | Для сборки проекта используйте следующие команды, находясь в каталоге '''w4-sdk-demo''': |
*Удалить результаты предыдущей сборки: '''./w4 --clean''' | *Удалить результаты предыдущей сборки: '''./w4 --clean''' | ||
*Собрать проект (дебажная версия): '''./w4 --build''' | *Собрать проект (дебажная версия): '''./w4 --build''' | ||
| Line 128: | Line 141: | ||
# Запустите VSCode и установите расширение Remote WSL. | # Запустите VSCode и установите расширение Remote WSL. | ||
# Подключитесь к Debian WSL. | # Подключитесь к Debian WSL. | ||
| − | # Откройте SDK workspace (каталог, в который был склонирован репозиторий). | + | # Откройте SDK workspace (укажите каталог, в который был склонирован репозиторий). |
# Установите все расширения, которые будут рекомендованы системой. | # Установите все расширения, которые будут рекомендованы системой. | ||
# Перезагрузите IDE. | # Перезагрузите IDE. | ||
| Line 136: | Line 149: | ||
=== Making an Example Change === | === Making an Example Change === | ||
<translate> | <translate> | ||
| − | В поставку SDK входят примеры, которые не столько показывают возможности движка, сколько позволяют понять как работать с кодом. | + | В поставку SDK входят примеры, которые не столько показывают возможности движка, сколько позволяют понять как работать с кодом. Работа с примерами описана TBD. |
| − | |||
| − | |||
| − | TBD | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</translate> | </translate> | ||
Revision as of 12:36, 28 April 2020
Рекомендуемый порядок установки и запуска W4 SDK DEMO.
Contents
Setup environment
Проект собирается под OS Debian, если она установлена можете сразу переходить к разделу Debian environment settings. Для работы под другими операционными системами необходимо предварительно выполнить следующие действия (или убедиться, что они выполнены).
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, загрузите и установите приложение Debian из Microsoft Store.
Если вы используете WSL2, инициализируйте дистрибутив командой (для WSL1 этот пункт пропускается):
wsl --set-version Debian 2
Mac OS (TBD)
???
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
Перезагрузите 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/
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 входят примеры, которые не столько показывают возможности движка, сколько позволяют понять как работать с кодом. Работа с примерами описана TBD.