Setup
How to start developing plugins.
Install a recent app build
Make sure you are using a recent build of exteraGram with plugin support enabled.
For this SDK tree, treat exteraGram 12.5.1+ as the practical minimum.
Current test builds are usually published in the beta channel.
Enable the plugin engine
After logging into your account, go to exteraGram Preferences > Plugins and enable the plugin engine.
Then open the info screen for plugins and enable developer mode.
Create a local project
Create a folder on your PC and add a Python file for the plugin.
A simple layout is enough:
Recommended desktop-development tips:
- keep the filename stable; the least surprising setup is
filename == __id__ + ".py" - point your IDE at this repository's
src/directory for imports and autocomplete - keep metadata as plain top-level constants so the loader can parse them
Minimal starter file:
Connect to the device
Connect your phone to your PC and make sure ADB is available on your PATH.
You have two common workflows:
- copy the
.pyfile into the app's plugins directory and reload it manually - use your own helper tooling which talks to the built-in
DevServerfor write/reload/debug flows
On-device plugin files live under a path similar to:
Debugging ports
The built-in development server listens on 42690 by default.
The debugger port is separate and chosen by you or your tooling. In the example below it is 5678.
VS Code remote attach example:
Inside that remote directory, your plugin file should still match the plugin id, for example hello_world.py.