Skip to content

Latest commit

 

History

History
224 lines (170 loc) · 10.5 KB

README.md

File metadata and controls

224 lines (170 loc) · 10.5 KB
Raw

NekoX

NekoX is an free and open source third-party Telegram client, based on Telegram-FOSS with features added.

中文FAQ

Get it on F-Droid Fdroid releases can not upgrade to other releases.

NekoX Changes

  • Most of Nekogram's features
  • Unlimited login accounts
  • Proxy
    • Built-in VMess, Shadowsocks, SSR, Trojan-GFW proxies support (No longer maintained)
    • Built-in public proxy (WebSocket relay via Cloudflare CDN), documentation and for PC
    • Proxy subscription support
    • Ipv6 MTProxy support
    • Able to parse all proxy subscription format: SIP008, ssr, v2rayN, vmess1, shit ios app formats, clash config and more
    • Proxies import and export, remarks, speed measurement, sorting, delete unusable nodes, etc
    • Scan the QR code (any link, can add a proxy)
    • The ( vmess / vmess1 / ss / ssr / trojan ) proxy link in the message can be clicked
    • Allow auto-disabling proxy when VPN is enabled
    • Proxy automatic switcher
    • Don't alert "Proxy unavailable" for non-current account
  • Stickers
    • Custom Emoji packs
    • Add stickers without sticker pack
    • Sticker set list backup / restore / share
  • Internationalization
    • OpenCC Chinese Convert
    • Full InstantView translation support
    • Translation support for selected text on input and in messages
    • Google Cloud Translate / Yandex.Translate support
    • Force English emoji keywords to be loaded
    • Persian calendar support
  • Additional Options
    • Option to disable vibration
    • Dialog sorting is optional "Unread and can be prioritized for reminding" etc
    • Option to skip "regret within five seconds"
    • Option to not send comment first when forwarding
    • Option to use nekox chat input menu: replace record button with a menu which contains an switch to control link preview (enabled by default)
    • Option to disable link preview by default: to prevent the server from knowing that the link is shared through Telegram.
    • Option to ignore Android-only content restrictions (except for the Play Store version).
    • Custom cache directory (supports external storage)
    • Custom server (official, test DC)
    • Option to block others from starting a secret chat with you
    • Option to disable trending
  • Additional Actions
    • Allow clicking on links in self profile
    • Delete all messages in group
    • Unblock all users support
    • Login via QR code
    • Scan and confirm the login QR code directly
    • Allow clearing app data
    • Proxies, groups, channels, sticker packs are able to be shared as QR codes
    • Add "@Name" when long-pressing @user option
    • Allow creating a group without inviting anyone
    • Allow upgrading a group to a supergroup
    • Mark dialogs as read using tab menu
    • Option to hide device info
    • Enabled set auto delete timer option for private chats and private groups
    • Support saving multiple selected messages to Saved Messages
    • Support unpinning multiple selected messages
    • View stats option for messages
  • Optimization
    • Keep the original file name when downloading files
    • View the data center you belong to when you don't have an avatar
    • Enhanced notification service, optional version without Google Services
    • Improved session dialog
    • Improved link long click menu
    • Improved hide messages from blocked users feature
    • Don't process cleanup draft events after opening chat
  • Others
    • OpenKeychain client (sign / verify / decrypt / import)
    • Text replacer
  • UI
    • Telegram X style menu for unpinning messages
    • Built-in Material Design themes / Telegram X style icons
  • And more :)

Compilation Guide

NOTE: Building on Windows is, unfortunately, not supported. Consider using a Linux VM or dual booting.

Important:

  1. Checkout all submodules
git submodule update --init --recursive
  1. Install Android SDK and NDK (default location is $HOME/Android/SDK, otherwise you need to specify $ANDROID_HOME for it)

It is recommended to use AndroidStudio to install.

  1. Install golang and yasm
apt install -y golang-1.16 yasm
  1. Install Rust and its stdlib for Android ABIs, and add environment variables for it.

It is recommended to use the official script, otherwise you may not find rustup.

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain none -y
echo "source \$HOME/.cargo/env" >> $HOME/.bashrc && source $HOME/.cargo/env

rustup install $(cat ss-rust/src/main/rust/shadowsocks-rust/rust-toolchain)
rustup default $(cat ss-rust/src/main/rust/shadowsocks-rust/rust-toolchain)
rustup target install armv7-linux-androideabi aarch64-linux-android i686-linux-android x86_64-linux-android
  1. Build native dependencies: ./run init libs
  2. Build external libraries and native code: ./run libs update
  3. Fill out TELEGRAM_APP_ID and TELEGRAM_APP_HASH in local.properties
  4. Replace TMessagesProj/google-services.json if you want fcm to work.
  5. Replace release.keystore with yours and fill out ALIAS_NAME, KEYSTORE_PASS and ALIAS_PASS in local.properties if you want a custom sign key.

./gradlew assemble<Full/Mini><Debug/Release/ReleaseNoGcm>

Compilation with GitHub Actions

  1. Change the package name, API ID

  2. Generate your signing keystore

  3. Fill GitHub Actions Secrets like below:

    B64_SIGNING_KEY: base64 --encode <your_keystore_file>

    KEYSTORE_PASS:

keyAlias=
keyPassword=
storeFile=luvletter2333.jks
storePassword=

These codes are used to decode the signing key and keypass from secrets:

  echo "${{ secrets.B64_SIGNING_KEY }}" | base64 --decode - > TMessagesProj/luvletter2333.jks
  echo "${{ secrets.KEYSTORE_PASS }}" > TMessagesProj/priv-signing.properties
  sha256sum TMessagesProj/luvletter2333.jks

FAQ

What is the differences between NekoX and Nekogram?

Developed by different developers, read the feature list above to understand the differences.

What is the difference between the Full and Mini version?

The full version comes with built-in proxy support for v2ray, shadowsocks, shadowsocksr, and trojan, which is usually provided to advanced users to help friends who have no computer knowledge in mainland China to bypass censorship. Don't complain about imperfect functions or ask to add other rare proxy types, you can use their clients directly.

What if I don't need a proxy?

Then it is recommended to use the Mini version.

What is the noGcm version?

Google Cloud Messaging, also known as gcm / fcm, message push service by google used by original Telegram android app, it requires your device to have Google Service Framework (non-free) installed.

I've encountered a bug!

First, make sure you have the latest version installed (check the channel, Play store versions usually have a delay).

Then, if the issue appears in the official Telegram client too, please submit it to the officials, (be careful not to show NekoX in the description and screenshots, the official developers doesn't like us!).

Then, please detail your issue, create an issue or submit it to our group with #bug.

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.

Localization

Is NekoX not in your language, or the translation is incorrect or incomplete? Get involved in the translations on our Weblate.

Translation status

Adding a new language

First and foremost, Android must already support the specific language and locale you want to add. We cannot work with languages that Android and the SDK do not support, the tools simply break down. Next, if you are considering adding a country-specific variant of a language (e.g. de-AT), first make sure that the main language is well maintained (e.g. de). Your contribution might be useful to more people if you contribute to the existing version of your language rather than the country-specific variant.

Anyone can create a new language via Weblate.

Adding unofficial translations for Telegram

Current built-in language packs:

You can open an issue to request to amend the built-in translation.

Credits