Difference between revisions of "Quick Start/en"
From Ciliz|W4
(Created page with "# Start VSCode and install Remote WSL extension # Connect to Debian WSL # Open SDK workspace # Install All recomemended extensions # Reload IDE and work with code") |
|||
| (34 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | W4 SDK DEMO Launch Procedure. | |
| − | |||
== Setup environment == <!--T:2--> | == Setup environment == <!--T:2--> | ||
| − | The project uses OS Debian. | + | The project uses Debian OS, if it is already installed, you can go directly to the ''Debian environment settings'' section. For MS Windows, you must follow these steps (or make sure they are completed). |
| − | |||
| − | |||
| − | |||
| − | # | + | === Install Windows Terminal === |
| − | + | https://paper-attachments.dropbox.com/s_0034A86D613416109E895A76DA7A4F66C33EEAB8671A5C439351EC00BAE5D5EC_1581002573663_.png | |
| − | # | + | |
| − | + | It is not obliged to use Windows Terminal if you prefer another tool skip this section. | |
| + | |||
| + | # Download the latest stable version of the installer from [https://github.com/microsoft/terminal/releases the project page] (the download link is in the Assets drop-down list under the changelog)and install the application. | ||
| + | # You can configure Windows Terminal by changing the settings.json file. In general, it is located in the directory LocalAppData\Packages\Microsoft.WindowsTerminal_8wekyb3d8bbwe\LocalState\ or similar one. | ||
| + | See [https://github.com/microsoft/terminal/blob/master/doc/user-docs/UsingJsonSettings.md the Windows Terminal documentation] for more information about customization. | ||
| + | |||
| + | |||
| + | === Install WSL === | ||
| + | To run a Debian image on Windows, use Windows Subsystem for Linux (WSL). It is recommended that you use WSL2, which requires Windows 10 build 18917 or later. If you have an old build of Windows 10, then you can work with WSL1. The difference is that on WSL1, some operations are much slower than on WSL2. | ||
| + | |||
| + | Follow these steps: | ||
| + | * Check / Enable the WSL component. To do this, in [https://docs.microsoft.com/en-us/powershell/?view=powershell-7 PowerShell], run the command: | ||
| + | dism.exe / online / enable-feature / featurename: Microsoft-Windows-Subsystem-Linux / all / norestart | ||
| + | * If you can use WSL2, then also use the Virtual Machine Platform component: | ||
| + | dism.exe / online / enable-feature / featurename: VirtualMachinePlatform / all / norestart | ||
| + | * Reboot the system to complete the installation of components. | ||
| + | |||
| + | === Install Debian WSL Image === | ||
| + | To add a Debian image, download and install the [https://www.microsoft.com/en-us/p/debian/9msvkqc78pk6?activetab=pivot:regionofsystemrequirementstab Debian application from the Microsoft Store]. | ||
| + | |||
| + | If you use WSL2, initialize the distribution with the command (for WSL1 skip this item): | ||
| + | wsl --set-version Debian 2 | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== Debian environment settings == | == Debian environment settings == | ||
| − | + | If you are working from another OS, start Debian (for example, through the Windows Terminal menu). | |
| − | + | At the first start, you will be asked to set a username and password for logging in. | |
| − | + | ||
| + | It is recommended to install the latest system updates by running the following commands: | ||
sudo apt-get update | sudo apt-get update | ||
sudo apt-get upgrade | sudo apt-get upgrade | ||
| + | |||
| + | === Install Midnight Commander === | ||
| + | If you are not comfortable working with files from the command line, install Midnight Commander. | ||
| + | sudo apt-get install mc | ||
| + | |||
=== Install Git === | === Install Git === | ||
| − | + | Install Git application: | |
sudo apt-get install git | sudo apt-get install git | ||
=== Clone SDK === | === Clone SDK === | ||
| − | + | Before the first call to the repository required [https://confluence.atlassian.com/bitbucket/set-up-an-ssh-key-728138079.html generate SSH key and add the public key in your account on Bitbucket]. The same key must be sent to the W4 team to gain access. | |
| − | git clone git@bitbucket.org:ciliz2/w4-sdk.git | + | |
| + | ''Note. Instead of generating a new key, you can use the existing key by copying the public and private parts to the .ssh directory of the Debian user home directory and setting access permissions to the key file with the command'' chmod =600 ~/.ssh/id_rsa | ||
| + | Clone the SDK repository: | ||
| + | git clone git@bitbucket.org:ciliz2/w4-sdk-demo.git | ||
=== Install SDK prerequisites === | === Install SDK prerequisites === | ||
| − | + | To get started with the SDK, go to the directory: | |
| − | + | cd w4-sdk-demo | |
| − | cd w4-sdk | + | Run the command: |
| − | ./w4-prereq | + | ./w4 --prereq |
| + | Reload Debian instance or subshell. Then run the command: | ||
npm -g install serve | npm -g install serve | ||
| − | + | '' You may also need to install node web server if it is needed for your project. '' | |
== Build == | == Build == | ||
| − | + | ''If you are using WSL1, the build process can take more time.'' | |
| − | '' | + | |
| − | + | To build the project, use the following commands (when you are located in the directory ''w4-sdk-demo''): | |
| − | * | + | * Delete the results of the previous assembly: '''./w4 --clean''' |
| − | * | + | * Build the project (release version): '''./w4 --build''' |
| + | |||
== Test Run == | == Test Run == | ||
| − | + | Start webserver: | |
| − | cd | + | cd deploy |
serve -l 8080 | serve -l 8080 | ||
| − | + | Check the game through the browser by typing in the address bar: | |
| − | == VSCode as IDE == | + | http://localhost:8080/ |
| − | === Initial setup === | + | |
| + | == Edit source code == | ||
| + | Here is some general information on working with the SDK. More details about working with the code can be found on the [[SDK Experiments]] page. | ||
| + | |||
| + | You can use any convenient environment to work with the code. The following describes the installation and configuration of Visual Studio Code, as this solution allows you to directly work with code in Debian Instance, when launched from your OS. | ||
| + | === VSCode as IDE === | ||
| + | ==== Install Visual Studio Code ==== | ||
| + | [https://code.visualstudio.com/ Download and install VSCode for your OS]. | ||
| + | ==== Initial setup ==== | ||
# Start VSCode and install Remote WSL extension | # Start VSCode and install Remote WSL extension | ||
# Connect to Debian WSL | # Connect to Debian WSL | ||
| − | # Open SDK workspace | + | # Open SDK workspace (specify the directory where the w4.code-workspace file is located in the cloned repository) |
| − | # Install All | + | # Install All recommended extensions |
# Reload IDE and work with code | # Reload IDE and work with code | ||
Latest revision as of 08:41, 21 May 2020
W4 SDK DEMO Launch Procedure.
Setup environment
The project uses Debian OS, if it is already installed, you can go directly to the Debian environment settings section. For MS Windows, you must follow these steps (or make sure they are completed).
Install Windows Terminal
It is not obliged to use Windows Terminal if you prefer another tool skip this section.
- Download the latest stable version of the installer from the project page (the download link is in the Assets drop-down list under the changelog)and install the application.
- You can configure Windows Terminal by changing the settings.json file. In general, it is located in the directory LocalAppData\Packages\Microsoft.WindowsTerminal_8wekyb3d8bbwe\LocalState\ or similar one.
See the Windows Terminal documentation for more information about customization.
Install WSL
To run a Debian image on Windows, use Windows Subsystem for Linux (WSL). It is recommended that you use WSL2, which requires Windows 10 build 18917 or later. If you have an old build of Windows 10, then you can work with WSL1. The difference is that on WSL1, some operations are much slower than on WSL2.
Follow these steps:
- Check / Enable the WSL component. To do this, in PowerShell, run the command:
dism.exe / online / enable-feature / featurename: Microsoft-Windows-Subsystem-Linux / all / norestart
- If you can use WSL2, then also use the Virtual Machine Platform component:
dism.exe / online / enable-feature / featurename: VirtualMachinePlatform / all / norestart
- Reboot the system to complete the installation of components.
Install Debian WSL Image
To add a Debian image, download and install the Debian application from the Microsoft Store.
If you use WSL2, initialize the distribution with the command (for WSL1 skip this item):
wsl --set-version Debian 2
Debian environment settings
If you are working from another OS, start Debian (for example, through the Windows Terminal menu). At the first start, you will be asked to set a username and password for logging in.
It is recommended to install the latest system updates by running the following commands:
sudo apt-get update sudo apt-get upgrade
Install Midnight Commander
If you are not comfortable working with files from the command line, install Midnight Commander.
sudo apt-get install mc
Install Git
Install Git application:
sudo apt-get install git
Clone SDK
Before the first call to the repository required generate SSH key and add the public key in your account on Bitbucket. The same key must be sent to the W4 team to gain access.
Note. Instead of generating a new key, you can use the existing key by copying the public and private parts to the .ssh directory of the Debian user home directory and setting access permissions to the key file with the command chmod =600 ~/.ssh/id_rsa Clone the SDK repository:
git clone git@bitbucket.org:ciliz2/w4-sdk-demo.git
Install SDK prerequisites
To get started with the SDK, go to the directory:
cd w4-sdk-demo
Run the command:
./w4 --prereq
Reload Debian instance or subshell. Then run the command:
npm -g install serve
You may also need to install node web server if it is needed for your project.
Build
If you are using WSL1, the build process can take more time.
To build the project, use the following commands (when you are located in the directory w4-sdk-demo):
- Delete the results of the previous assembly: ./w4 --clean
- Build the project (release version): ./w4 --build
Test Run
Start webserver:
cd deploy serve -l 8080
Check the game through the browser by typing in the address bar:
http://localhost:8080/
Edit source code
Here is some general information on working with the SDK. More details about working with the code can be found on the SDK Experiments page.
You can use any convenient environment to work with the code. The following describes the installation and configuration of Visual Studio Code, as this solution allows you to directly work with code in Debian Instance, when launched from your OS.
VSCode as IDE
Install Visual Studio Code
Download and install VSCode for your OS.
Initial setup
- Start VSCode and install Remote WSL extension
- Connect to Debian WSL
- Open SDK workspace (specify the directory where the w4.code-workspace file is located in the cloned repository)
- Install All recommended extensions
- Reload IDE and work with code