Install¶

There is no release build yet. Build Mollygram from source on macOS 12 or later. Release builds will be published on GitHub Releases.

Before you start¶

• Install Xcode and FVM. The repository pins Flutter 3.47.7 in .fvmrc.
• Get an api_id and api_hash at my.telegram.org. Mollygram does not ship one. See the FAQ.

Build and run¶

1. Clone the repository with its submodules. QuickJS, the plugin engine, lives in a submodule.

   git clone --recurse-submodules https://github.com/mollykitten/mollygram.git
   cd mollygram
   

   If you cloned without --recurse-submodules, run git submodule update --init --recursive.

2. Install Flutter and the dependencies.

   fvm install
   fvm flutter pub get
   

3. Copy the example config and fill in your credentials.

   cp config/telegram.example.json config/telegram.json
   

   {
     "TELEGRAM_API_ID": "your api_id",
     "TELEGRAM_API_HASH": "your api_hash"
   }
   

   config/telegram.json is git-ignored. Keep it out of commits.

4. Run the app.

   cd packages/app
   fvm flutter run -d macos --dart-define-from-file=../../config/telegram.json
   

The Xcode build downloads the prebuilt TDLib library (libtdjson) for the version pinned in packages/tdlib/tdlib.json and checks its sha256. You do not build TDLib yourself. To use your own library, set TDJSON_PATH.

Next: Sign in.