OLD | NEW |
1 # Running Blimp | 1 # Running Blimp |
2 [TOC] | 2 [TOC] |
3 | 3 |
4 See [build](build.md) for instructions on how to build Blimp. | 4 See [build](build.md) for instructions on how to build Blimp. |
5 | 5 |
6 ## Android Client | 6 ## Android Client |
7 | 7 |
8 ### Installing the client | 8 ### Installing the client |
9 | 9 |
10 Install the Blimp APK with the following: | 10 Install the Blimp APK with the following: |
(...skipping 145 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
156 ### On a workstation | 156 ### On a workstation |
157 The following flags are required to start an Engine instance: | 157 The following flags are required to start an Engine instance: |
158 | 158 |
159 * `--blimp-client-token-path=$PATH`: Path to a file containing a nonempty | 159 * `--blimp-client-token-path=$PATH`: Path to a file containing a nonempty |
160 token string. If this is not present, the engine will fail to boot. | 160 token string. If this is not present, the engine will fail to boot. |
161 * `--use-remote-compositing`: Ensures that the renderer uses the remote | 161 * `--use-remote-compositing`: Ensures that the renderer uses the remote |
162 compositor. | 162 compositor. |
163 * `--disable-cached-picture-raster`: Ensures that rasterized content is not | 163 * `--disable-cached-picture-raster`: Ensures that rasterized content is not |
164 destroyed before serialization. | 164 destroyed before serialization. |
165 * `--android-fonts-path=$PATH`: Path to where the fonts are located. | 165 * `--android-fonts-path=$PATH`: Path to where the fonts are located. |
166 Typically this would be `out-linux/Debug/gen/third_party/blimp_fonts`. | 166 If the Android client is Kitkat system, this would be |
| 167 `out-linux/Debug/gen/third_party/blimp_fonts/font_bundle/kitkat/`. |
| 168 If the Android client is Marshmallow system, this would be |
| 169 `out-linux/Debug/gen/third_party/blimp_fonts/font_bundle/marshmallow/`. |
167 * `--disable-remote-fonts`: Disables downloading of custom web fonts in the | 170 * `--disable-remote-fonts`: Disables downloading of custom web fonts in the |
168 renderer. | 171 renderer. |
169 | 172 |
170 #### Typical invocation | 173 #### Typical invocation |
171 | 174 |
172 One can start the engine using these flags: | 175 One can start the engine using these flags: |
173 | 176 |
174 ```bash | 177 ```bash |
175 out-linux/Debug/blimp_engine_app \ | 178 out-linux/Debug/blimp_engine_app \ |
176 --android-fonts-path=out-linux/Debug/gen/third_party/blimp_fonts \ | 179 --android-fonts-path=out-linux/Debug/gen/third_party/blimp_fonts/font_bundle/m
arshmallow/ \ |
177 --blimp-client-token-path=/tmp/blimpengine-token \ | 180 --blimp-client-token-path=/tmp/blimpengine-token \ |
178 --enable-logging=stderr \ | 181 --enable-logging=stderr \ |
179 --vmodule="blimp*=1" | 182 --vmodule="blimp*=1" |
180 ``` | 183 ``` |
181 | 184 |
182 ## Running client engine integration with script | 185 ## Running client engine integration with script |
183 | 186 |
184 When building the target `blimp` on a Linux host, a script is created which | 187 When building the target `blimp` on a Linux host, a script is created which |
185 automates running the Blimp client and starting the engine. Setting up the | 188 automates running the Blimp client and starting the engine. Setting up the |
186 environment like this is much quicker than executing each of the steps | 189 environment like this is much quicker than executing each of the steps |
(...skipping 50 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
237 killing engine if keyboard interrupts or client gets killed. | 240 killing engine if keyboard interrupts or client gets killed. |
238 | 241 |
239 ```bash | 242 ```bash |
240 out-linux/Debug/bin/client_engine_integration run | 243 out-linux/Debug/bin/client_engine_integration run |
241 ``` | 244 ``` |
242 | 245 |
243 2. Same as step 2 in Option A. | 246 2. Same as step 2 in Option A. |
244 | 247 |
245 3. Engine should be auto-killed by keyboard stopping the `{run}` script or the
client | 248 3. Engine should be auto-killed by keyboard stopping the `{run}` script or the
client |
246 gets wiped out. `{stop}` works as well. | 249 gets wiped out. `{stop}` works as well. |
OLD | NEW |