FoxiGram/README.en.md
instant992 bbb2b84f07 Auto-enable bundled proxy on first launch; drop in-app download button
- ApplicationLoader now enables a bundled VLESS proxy on a truly fresh
  install (one-time, guarded by builtin_proxy_autoenabled) so the app can
  connect even when plain Telegram is blocked; existing users' choices are
  left untouched
- Remove the 'Download FoxiGram' settings row (the app is already
  installed) and its strings; drop the in-app download mention from READMEs
2026-06-10 22:24:42 +04:00

84 lines
2.6 KiB
Markdown

# FoxiGram
[Русский](README.md) · **English**
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).
## 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.
- Based on Nekogram, which is based on Telegram for Android.
## License
This project is distributed under the **GNU General Public License v2.0 or
later** (GPL-2.0-or-later) — the same license as Telegram for Android and
Nekogram, on which it is based.
This means you are free to use, modify and distribute the app, including sharing
it with other people. When you distribute it — original or modified — you must
make the source code available under the same terms and keep the attribution.
FoxiGram is an independent fork and is not affiliated with official Telegram.
"Telegram", its logos and trademarks belong to their respective owners.