exteraGram

Setup

How to start developing plugins.

Download exteraGram

Make sure you're using the latest version of exteraGram or derivative client.

You may download latest version from the beta channel.

Enable plugins engine

After logging into your account, go to the exteraGram Preferences > Plugins and enable plugins engine. Tap info button and enable developer mode.

Bootstrap project

Create a folder on your PC and create a Python file, e.g. first_plugin.py.

Create virtual environment and install exteragram-utils for typings and hot-reload client.

Connecting to the phone

Connect your phone to your PC using cable. Also make sure ADB is on your PATH.

# replace first_plugin.py with your actual filename
extera first_plugin.py
 
# for debugging support
extera first_plugin.py --debug

VS Code remote debugging example:

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python Debugger: Remote Attach exteraGram",
            "type": "debugpy",
            "request": "attach",
            "connect": {
                "host": "localhost",
                "port": 5678
            },
            "pathMappings": [
                {
                    "localRoot": "/Users/alexeyzavar/Projects/extera-plugins/first_plugin.py",
                    "remoteRoot": "/data/user/0/com.exteragram.messenger/files/plugins/first_plugin.py"
                }
            ]
        }
    ]
}

Note that remoteRoot should end with PLUGIN_ID.py.

Previous

Introduction

Next

First Plugin

On this page