| - Official Site: <https://nagram.app> |
| 6 | - Channel: <https://t.me/nagram_channel> |
| 7 | - Assets: <https://t.me/nagram_assets> |
| 8 | - Releases: <https://github.com/NextAlone/Nagram/releases> |
| 9 | - Issues: <https://github.com/NextAlone/Nagram/issues> |
| 10 | - Issues (Telegram): <https://t.me/na_gram_reports/18> |
| 11 |
| 12 | ## Branding |
| 13 |
| 14 | Nagram's source code is licensed under GPLv3. The Nagram name and project |
| 15 | identity belong to [@NextAlone](https://github.com/NextAlone); the Nagram |
| 16 | application icon artwork is copyright © MaitungTM. These are separate brand |
| 17 | assets. Modified, forked, and third-party distributions must use distinct |
| 18 | branding and replace the Nagram brand assets. See [BRANDING.md](BRANDING.md) |
| 19 | for the complete policy. |
| 20 |
| 21 | ## Additional feature over Nagram |
| 22 |
| 23 | 1. Nice icon (copyright © MaitungTM) |
| 24 | 2. Combine message |
| 25 | 3. Editable text style |
| 26 | 4. Forced copy |
| 27 | 5. Invert reply |
| 28 | 6. Quick reply in longClick menu (thanks to @blxueya) |
| 29 | 7. Undo and Redo |
| 30 | 8. Scrollable chat preview (thanks to TeleTux) |
| 31 | 9. Noise suppress and voice enhance (thanks to ) |
| 32 |
| 33 | ---- |
| 34 |
| 35 | ## NekoX Changes |
| 36 |
| 37 | - Most of Nekogram's features |
| 38 | - Unlimited login accounts |
| 39 | - **Proxy** |
| 40 | - Built-in VMess, Shadowsocks, SSR, Trojan-GFW proxies support (No longer maintained) |
| 41 | - Built-in public proxy (WebSocket relay via Cloudflare CDN), [documentation and for PC](https://github.com/arm64v8a/NekoXProxy) |
| 42 | - Proxy subscription support |
| 43 | - Ipv6 MTProxy support |
| 44 | - Able to parse all proxy subscription format: SIP008, ssr, v2rayN, vmess1, shit ios app formats, clash config and more |
| 45 | - Proxies import and export, remarks, speed measurement, sorting, delete unusable nodes, etc |
| 46 | - Scan the QR code (any link, can add a proxy) |
| 47 | - The ( vmess / vmess1 / ss / ssr / trojan ) proxy link in the message can be clicked |
| 48 | - Allow auto-disabling proxy when VPN is enabled |
| 49 | - Proxy automatic switcher |
| 50 | - Don't alert "Proxy unavailable" for non-current account |
| 51 | - **Stickers** |
| 52 | - Custom [Emoji packs](https://web.archive.org/web/20221126140435/https://github.com/NekoX-Dev/NekoX/wiki/emoji) |
| 53 | - Add stickers without sticker pack |
| 54 | - Sticker set list backup / restore / share |
| 55 | - **Internationalization** |
| 56 | - OpenCC Chinese Convert |
| 57 | - Full InstantView translation support |
| 58 | - Translation support for selected text on input and in messages |
| 59 | - Google Cloud Translate / Yandex.Translate support |
| 60 | - Force English emoji keywords to be loaded |
| 61 | - Persian calendar support |
| 62 | - **Additional Options** |
| 63 | - Option to disable vibration |
| 64 | - Dialog sorting is optional "Unread and can be prioritized for reminding" etc |
| 65 | - Option to skip "regret within five seconds" |
| 66 | - Option to not send comment first when forwarding |
| 67 | - Option to use nekox chat input menu: replace record button with a menu which contains an switch to control link preview (enabled by default) |
| 68 | - Option to disable link preview by default: to prevent the server from knowing that the link is shared through Telegram. |
| 69 | - Option to ignore Android-only content restrictions (except for the Play Store version). |
| 70 | - Custom cache directory (supports external storage) |
| 71 | - Custom server (official, test DC) |
| 72 | - Option to block others from starting a secret chat with you |
| 73 | - Option to disable trending |
| 74 | - **Additional Actions** |
| 75 | - Allow clicking on links in self profile |
| 76 | - Delete all messages in group |
| 77 | - Unblock all users support |
| 78 | - Login via QR code |
| 79 | - Scan and confirm the login QR code directly |
| 80 | - Allow clearing app data |
| 81 | - Proxies, groups, channels, sticker packs are able to be shared as QR codes |
| 82 | - Add "@Name" when long-pressing @user option |
| 83 | - Allow creating a group without inviting anyone |
| 84 | - Allow upgrading a group to a supergroup |
| 85 | - Mark dialogs as read using tab menu |
| 86 | - Enabled set auto delete timer option for private chats and private groups |
| 87 | - Support saving multiple selected messages to Saved Messages |
| 88 | - Support unpinning multiple selected messages |
| 89 | - View stats option for messages |
| 90 | - **Optimization** |
| 91 | - Keep the original file name when downloading files |
| 92 | - View the data center you belong to when you don't have an avatar |
| 93 | - Enhanced notification service, optional version without Google Services |
| 94 | - Improved session dialog |
| 95 | - Improved link long click menu |
| 96 | - Improved hide messages from blocked users feature |
| 97 | - Don't process cleanup draft events after opening chat |
| 98 | - **Others** |
| 99 | - OpenKeychain client (sign / verify / decrypt / import) |
| 100 | - Text replacer |
| 101 | - **UI** |
| 102 | - Telegram X style menu for unpinning messages |
| 103 | - Built-in Material Design themes / Telegram X style icons |
| 104 | - And more :) |
| 105 |
| 106 | ## API and Protocol documentation |
| 107 |
| 108 | Telegram API manuals: <https://core.telegram.org/api> |
| 109 |
| 110 | MTProto protocol manuals: <https://core.telegram.org/mtproto> |
| 111 |
| 112 | ## Compilation Guide |
| 113 |
| 114 | **NOTE: For Windows users, please consider using a Linux VM (such as WSL2) or dual booting.** |
| 115 |
| 116 | Environment: |
| 117 |
| 118 | - Linux distribution based on Debian or Arch Linux, or macOS |
| 119 |
| 120 | - Optional: `ccache` in `PATH` speeds up rebuilding the native code. |
| 121 |
| 122 | The third-party native libraries (FFmpeg, BoringSSL, libvpx, ...) are committed prebuilt under |
| 123 | **TMessagesProj/jni/prebuild/lib**; the `build_*.sh` scripts there, and the tools they need |
| 124 | (`go`, `yasm`, `make`, ...), are only for regenerating them. |
| 125 | - Android SDK: `build-tools;33.0.0` `platforms;android-33` `ndk;27.2.12479018` `cmake;3.18.1` `cmake;3.22.1` (the default location is **$HOME/Android/SDK**, otherwise you need to specify **$ANDROID_HOME** for it) |
| 126 |
| 127 | It is recommended to use [Android Studio](https://developer.android.com/studio) to install, but you can also use `sdkmanager` command on distributions based on Debian: |
| 128 |
| 129 | ```shell |
| 130 | sudo apt install sdkmanager |
| 131 | sdkmanager --sdk_root $HOME/Android/SDK --install "build-tools;33.0.0" "platforms;android-33" "ndk;27.2.12479018" "cmake;3.18.1" "cmake;3.22.1" |
| 132 | ``` |
| 133 |
| 134 | Build: |
| 135 |
| 136 | 1. Checkout submodules |
| 137 |
| 138 | ```shell |
| 139 | git submodule update --init --recursive |
| 140 | ``` |
| 141 |
| 142 | The build applies **TMessagesProj/jni/patches** to `tgcalls` itself. When an update moves the `tgcalls` |
| 143 | submodule, add `--force` so the patched files are reset before the new commit is checked out. |
| 144 |
| 145 | 2. Disable signature check by removing the following lines in **TMessagesProj/jni/jni.c**: |
| 146 | ```c |
| 147 | if (verifySign(env) != JNI_OK) { |
| 148 | return JNI_ERR; |
| 149 | } |
| 150 | ``` |
| 151 |
| 152 | 3. Fill out `TELEGRAM_APP_ID` and `TELEGRAM_APP_HASH` in **local.properties** (from [Telegram Developer](https://my.telegram.org/auth)) |
| 153 |
| 154 | 4. Replace **TMessagesProj/google-services.json** if you want FCM to work. |
| 155 |
| 156 | 5. Replace **release.keystore** with yours and fill out `ALIAS_NAME`, `KEYSTORE_PASS` and `ALIAS_PASS` in **local.properties**. |
| 157 |
| 158 | 6. Build with Gradle (the native code is compiled as part of the build): |
| 159 |
| 160 | ```shell |
| 161 | ./gradlew assemble<Release/Debug> |
| 162 | ``` |
| 163 |
| 164 | ---- |
| 165 |
| 166 | ## Compilation with GitHub Action |
| 167 |
| 168 | 1. Create your own `release.keystore` to replace `TMessagesProj/release.keystore`. |
| 169 |
| 170 | 2. Prepare LOCAL_PROPERTIES |
| 171 |
| 172 | - KEYSTORE_PASS: from your keystore |
| 173 | - ALIAS_NAME: from your keystore |
| 174 | - ALIAS_PASS: from your keystore |
| 175 | - TELEGRAM_APP_ID: from [Telegram Developer](https://my.telegram.org/auth) |
| 176 | - TELEGRAM_APP_HASH: from [Telegram Developer](https://my.telegram.org/auth) |
| 177 |
| 178 | ```env |
| 179 | KEYSTORE_PASS=123456 |
| 180 | ALIAS_NAME=key0 |
| 181 | ALIAS_PASS=123456 |
| 182 | TELEGRAM_APP_ID=123456 |
| 183 | TELEGRAM_APP_HASH=abcdefg |
| 184 | ``` |
| 185 |
| 186 | Then, use base64 to encode the above. |
| 187 |
| 188 | 3. Add Repo Action Secrets |
| 189 |
| 190 | - LOCAL_PROPERTIES: from step 2 |
| 191 | - HELPER_BOT_TOKEN: from telegram [@Botfather](https://t.me/Botfather), such as `1111:abcd`; the bot that keeps the in-app update metadata |
| 192 | - NAGRAM_CHANNEL_BOT_TOKEN, NAGRAM_API_ID, NAGRAM_API_HASH: the bot that posts the builds to the channels, and the Telegram API credentials its Bot API server runs with |
| 193 |
| 194 | The channels are repository variables: NAGRAM_CHANNEL_ASSETS_CHAT_ID gets every build, NAGRAM_CHANNEL_CHAT_ID gets a copy of the releases. Nothing is posted while the token or the channels are not set. A release needs its notes in `docs/releases/<version code>.md`, with optional English notes in `<version code>.en.md`. |
| 195 |
| 196 | The GitLab pipeline posts to its own channel instead, with the HELPER_BOT_TARGET CI/CD variable holding the chat id, such as `-1001234567890`. |
| 197 |
| 198 | 4. Disable signature check by removing the following lines in **TMessagesProj/jni/jni.c**: |
| 199 | ```c |
| 200 | if (verifySign(env) != JNI_OK) { |
| 201 | return JNI_ERR; |
| 202 | } |
| 203 | ``` |
| 204 |
| 205 | 5. Run Release Build |
| 206 |
| 207 | ## FAQ |
| 208 |
| 209 | #### What is the differences between Nagram, NekoX and Nekogram? |
| 210 |
| 211 | Developed by different developers, read the feature list above to understand the differences. |
| 212 |
| 213 | #### I've encountered a bug! |
| 214 |
| 215 | First, make sure you have the latest version installed (check the channel). |
| 216 |
| 217 | Then, if the issue appears in the official Telegram client too, please submit it to the officials, (be careful not to show custom clients in the description and screenshots). |
| 218 |
| 219 | Then, submit it to our [bot](https://t.me/OrIssuesBot). |
| 220 |
| 221 | If you experience a *crash*, you also need to click on the version number at the bottom of the settings and select "Enable Log" and send it to us. |
| 222 |
| 223 | ## Localization |
| 224 |
| 225 | Nagram is forked from Telegram, thus most locales follows the translations of Telegram for Android, checkout <https://translations.telegram.org/en/android/>. |
| 226 |
| 227 | Is Nagram not in your language, or the translation is incorrect or incomplete? Get involved in the translations on our [Weblate](https://xtaolabs.crowdin.com/nagram). |
| 228 |
| 229 | [](https://xtaolabs.crowdin.com/nagram) |
| 230 |
| 231 | ## Thanks |
| 232 |
| 233 | - [NekoX](https://web.archive.org/web/20240306062834/https://github.com/NekoX-Dev/NekoX) |
| 234 | - [Nekogram](https://gitlab.com/Nekogram/Nekogram) |
| 235 | - [Pigeongram](https://gitlab.com/JasonKhew96/Nekogram) |
| 236 | - [Nullgram](https://github.com/qwq233/Nullgram) |
| 237 | - [TeleTux](https://github.com/TeleTux/TeleTux) |
| 238 | - [OwlGram](https://github.com/OwlGramDev/OwlGram) |
| 239 |