Skip to content

Commit

Permalink
Add engine_override instructions to plugins README
Browse files Browse the repository at this point in the history
The top-level local engine instructions were removed when all platforms
gained --local-engine support in the flutter tooling, but since that doesn't
apply to plugins the instructions are still needed for plugin builds that
need a local engine.
  • Loading branch information
stuartmorgan committed May 16, 2019
1 parent ff2f59f commit c8f53e4
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions plugins/README.md
Expand Up @@ -118,6 +118,24 @@ function. For instance:
flutter_controller.GetRegistrarForPlugin("ColorPanel"));
```

### Local Engine Support

Since desktop plugin builds are not yet integrated with the Flutter tooling,
`--local-engine` does not exist for plugin builds, and is not passed through
from application-level builds (e.g., `testbed`). For now, you can get the same
effect by adding a file called `engine_override` at the root of your
`flutter-desktop-embedding` checkout containing the name of your build output
directory (i.e., the same thing you would pass to `--local-engine`). For instance
on Linux or macOS:
```
$ echo host_debug_unopt > engine_override
```

This should only be necessary if the plugin build requires changes in your local
engine, for instance if it use APIs that have been changed or added in your
local engine build. At runtime, the library used will be determined by
the application build.

### Example Use

See the runner under each platform's directory in the `testbed`
Expand Down

0 comments on commit c8f53e4

Please sign in to comment.