FoxiGram/README.md
instant992 d1bd2d7b2d Add Russian README and in-app download link
- New README.ru.md (Russian) with a download section pointing to the
  GitHub releases page; both READMEs cross-link via a language switcher
- Add 'Download FoxiGram' row in Foxi settings opening the releases page
- Provide English and Russian strings for the download row and the
  previously added phone-number privacy option
2026-06-10 03:26:32 +04:00

74 lines
2.2 KiB
Markdown

# FoxiGram
**English** · [Русский](README.ru.md)
An unofficial Telegram client based on Nekogram, with a built-in VLESS+Reality
proxy client (Xray) for bundled, one-tap proxy access.
## Download
Latest builds are on the releases page:
**https://github.com/instant992/FoxiGram/releases**
Download `FoxiGram-<version>-<code>-arm64-v8a.apk` from the newest release and
install it on your device (you may need to allow installs from unknown
sources).
You can also open the download link straight from the app:
**Settings → Foxi → Download FoxiGram**.
## Built-in proxy servers
Server credentials are intentionally kept out of this repository.
- The real servers live in
`TMessagesProj/src/main/java/org/telegram/messenger/XrayServers.java`,
which is git-ignored.
- A template is provided at `XrayServers.java.template`.
To configure your own bundled proxies:
```sh
cd TMessagesProj/src/main/java/org/telegram/messenger/
cp XrayServers.java.template XrayServers.java
# then edit XrayServers.java and fill in your VLESS+Reality server data
```
Leaving the addresses empty disables the bundled proxies — the app still builds
and runs, you just won't see the pre-configured entries in the proxy list.
## Native Xray library (libxray.so)
The proxy core is a small Go wrapper around xray-core, built as a JNI shared
library. The source is in `libxray/`. The compiled `libxray.so` is git-ignored
and must be built locally.
Build for Android arm64 (requires Go and the Android NDK):
```sh
cd libxray
go mod tidy
set CGO_ENABLED=1
set GOOS=android
set GOARCH=arm64
set CC=<NDK>/toolchains/llvm/prebuilt/<host>/bin/aarch64-linux-android21-clang
go build -buildmode=c-shared -o ../TMessagesProj/src/main/jniLibs/arm64-v8a/libxray.so .
```
## Building the app
Standard Gradle build:
```sh
./gradlew :TMessagesProj_App:assembleRelease -Pandroid.injected.build.abi.filter=arm64-v8a
```
The output APK is named `FoxiGram-<version>-<code>-<abi>.apk`.
## Notes
- `google-services.json`, signing keystores, and `local.properties` are not
committed. Provide your own for release builds.
- This is a fork for personal use. Based on Nekogram, which is based on
Telegram for Android.