OLD | NEW |
1 # Running Blimp | 1 # Running Blimp |
2 | 2 |
3 See [build](build.md) for instructions on how to build Blimp. | 3 See [build](build.md) for instructions on how to build Blimp. |
4 | 4 |
5 ## Running the client | 5 ## Running the client |
6 | 6 |
7 There are both Android and Linux clients. The Android client is the shipping | 7 There are both Android and Linux clients. The Android client is the shipping |
8 client while the Linux client is used for development purposes. | 8 client while the Linux client is used for development purposes. |
9 | 9 |
10 ### Android Client | 10 ### Android Client |
11 | 11 |
12 Install the Blimp APK with the following: | 12 Install the Blimp APK with the following: |
13 | 13 |
14 ```bash | 14 ```bash |
15 ./build/android/adb_install_apk.py $(PRODUCT_DIR)/apks/Blimp.apk | 15 ./build/android/adb_install_apk.py $(PRODUCT_DIR)/apks/Blimp.apk |
16 ``` | 16 ``` |
17 | 17 |
18 Set up any command line flags with: | 18 Set up any command line flags with: |
19 | 19 |
20 ```bash | 20 ```bash |
21 ./build/android/adb_blimp_command_line --enable-webgl | 21 ./build/android/adb_blimp_command_line --enable-webgl |
22 ``` | 22 ``` |
23 | 23 |
| 24 To have the client connect to a custom engine use the `--blimplet-endpoint` |
| 25 flag. This takes values in the form of scheme:ip:port. The possible valid |
| 26 schemes are 'tcp', 'quic', and 'ssl'. An example valid endpoint would be |
| 27 `--blimplet-endpoint=tcp:127.0.0.1:500`. |
| 28 |
24 Run the Blimp APK with: | 29 Run the Blimp APK with: |
25 | 30 |
26 ```bash | 31 ```bash |
27 adb_run_blimp_client | 32 adb_run_blimp_client |
28 ``` | 33 ``` |
29 | 34 |
30 ### Linux Client | 35 ### Linux Client |
31 | 36 |
32 TBD | 37 TBD |
33 | 38 |
34 ## Running the engine | 39 ## Running the engine |
35 | 40 |
36 ### In a container | 41 ### In a container |
37 For running the engine in a container, see [container](container.md). | 42 For running the engine in a container, see [container](container.md). |
38 | 43 |
39 ### On a workstation | 44 ### On a workstation |
40 If you are running the engine on your workstation and are connected to the | 45 If you are running the engine on your workstation and are connected to the |
41 client device via USB, you'll need remote port forwarding to allow the Blimp | 46 client device via USB, you'll need remote port forwarding to allow the Blimp |
42 client to talk to your computer. Follow the instructions | 47 client to talk to your computer. Follow the instructions |
43 [here](https://developer.chrome.com/devtools/docs/remote-debugging) to get | 48 [here](https://developer.chrome.com/devtools/docs/remote-debugging) to get |
44 started. You'll probably want to remap 25467 to "localhost:25467". | 49 started. You'll probably want to remap 25467 to "localhost:25467". |
45 | 50 |
46 ### Required flags | 51 ### Required flags |
47 * `--blimp-client-token-path=$PATH`: Path to a file containing a nonempty | 52 * `--blimp-client-token-path=$PATH`: Path to a file containing a nonempty |
48 token string. If this is not present, the engine will fail to boot. | 53 token string. If this is not present, the engine will fail to boot. |
| 54 |
OLD | NEW |