Skip to content

Commit 967c2ba

Browse files
优化文档导航与仓库介绍
1 parent 90175fc commit 967c2ba

10 files changed

Lines changed: 44 additions & 7 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1717
- Added optional Rust MediaRoute native state and heartbeat implementation with C++ fallback.
1818

1919
### Changed
20+
- Refined README navigation, multilingual entry pages, build-output examples, and Maven-version guidance.
2021
- Hardened VPN startup to require user authorization, foreground notification startup, no default traffic routing, and explicit special-use subtype metadata.
2122
- Changed 1-pixel Activity and contacts/SMS observers to opt-in defaults, and stopped merging contacts/SMS permissions into host apps by default.
2223
- Updated PendingIntent background-launch handling for Android 14-16 sender/creator-side options.

CITATION.cff

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ authors:
1212
alias: "Pangu-Immortal"
1313
abstract: >-
1414
The most comprehensive open-source Android keep-alive library with 35+
15-
background service strategies, Native C++ daemon process, unified external
15+
background service strategies, Native C++/Rust JNI components, unified external
1616
startActivity orchestration, covering Android 7.0-16, compatible with 10+
1717
vendor ROMs. Implements every known keep-alive strategy used by commercial
1818
apps including foreground service, dual-process daemon, MediaRoute provider,

README-en.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,19 @@
2222

2323
> **The most comprehensive open-source Android keep-alive library — 35+ background service strategies, Native C++ daemon process, unified external startActivity strategies, covering Android 7.0–16, compatible with 10+ vendor ROMs.**
2424
25+
## Navigation
26+
27+
- [Quick Start](#quick-start)
28+
- [Configuration Reference](#configuration-reference)
29+
- [Permissions and User Consent](#permissions-and-user-consent)
30+
- [Use Case Recommendations](#use-case-recommendations)
31+
- [Build, Install, and Test](#build-install-and-test)
32+
- [Android Version Compatibility](#android-version-compatibility)
33+
- [Unified startActivity Strategy](#unified-startactivity-strategy)
34+
- [Vendor ROM Adaptation](#vendor-rom-adaptation)
35+
- [FAQ](#faq)
36+
- [Changelog](CHANGELOG.md)
37+
2538
---
2639

2740
## Quick Start
@@ -227,9 +240,11 @@ rustup target add armv7-linux-androideabi aarch64-linux-android i686-linux-andro
227240
./gradlew :framework:checkFwRustToolchain
228241
./gradlew :framework:assembleRelease -PfwBuildRust=true
229242
# If cargo is not in PATH, append: -PfwCargoPath=/path/to/cargo
243+
```
230244

231245
The optional Rust layer currently provides JNI dynamic registration, build-pipeline probing, read-only process diagnostics, and MediaRoute state/heartbeat logic. Existing `libfw_native.so` and `libfw_mediaroute.so` behavior remains available as fallback.
232246

247+
```bash
233248
# Repeated kill/recovery test
234249
./kill_alive.sh
235250

README-ja.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
# Fw — Android Keep-Alive Framework Encyclopedia
1+
# Fw — Android バックグラウンド常駐フレームワーク百科
22

33
> 既定で表示される README は引き続き [簡体中文](README.md) です。このページは、セットアップ、設定、権限フローを確認するための日本語入口です。完全な戦略リファレンスは [README.md](README.md) または [English](README-en.md) を参照してください。
44
5+
> Maven Central の現在の安定版は `2.0.1` です。この入口文書は最短の導入手順を優先し、詳細な戦略表と Android バージョン別の説明は完全版ドキュメントに集約しています。
6+
57
[简体中文](README.md) | [繁體中文](README-zh-Hant.md) | [English](README-en.md) | **日本語** | [한국어](README-ko.md)
68

79
---

README-ko.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
# Fw — Android Keep-Alive Framework Encyclopedia
1+
# Fw — Android 백그라운드 상주 프레임워크 백과
22

33
> 기본 README 는 계속 [간체 중국어](README.md) 입니다. 이 한국어 문서는 설치, 설정, 권한 흐름을 빠르게 확인하기 위한 진입점입니다. 전체 전략 설명은 [README.md](README.md) 또는 [English](README-en.md)를 참고하세요.
44
5+
> Maven Central 의 현재 안정 버전은 `2.0.1` 입니다. 이 문서는 빠른 통합 흐름을 우선으로 다루며, 전체 전략표와 Android 버전별 설명은 전체 문서에 정리되어 있습니다.
6+
57
[简体中文](README.md) | [繁體中文](README-zh-Hant.md) | [English](README-en.md) | [日本語](README-ja.md) | **한국어**
68

79
---

README-zh-Hant.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
> 預設 README 仍為 [簡體中文](README.md)。本頁是繁體中文入口,保留最常用的接入、配置與授權說明;完整策略細節請參考 [README.md](README.md)[English](README-en.md)
44
5+
> Maven Central 目前最新穩定版為 `2.0.1`。本入口文件優先保留快速接入流程,完整策略表、Android 版本適配與 FAQ 請以完整文件為準。
6+
57
[简体中文](README.md) | **繁體中文** | [English](README-en.md) | [日本語](README-ja.md) | [한국어](README-ko.md)
68

79
---

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,19 @@
2424
>
2525
> Fw 是目前开源社区中策略最全、版本覆盖最广的 Android 后台常驻框架。只需一行代码 `Fw.init(this)` 即可接入 35+ 种进程保护策略,覆盖 Android 7.0 到 16 全版本以及小米、华为、OPPO 等 10+ 厂商 ROM。无论是 IM 即时通讯、音乐播放、IoT 设备监控、健康运动追踪,还是需要研究 Android 体外 Activity / 后台启动 Activity / 统一 startActivity 策略的场景,Fw 都能通过灵活的配置项为你的应用量身定制防杀进程方案,让应用在后台保持运行不被系统回收。已发布至 Maven Central,开箱即用。
2626
27+
## 文档导航
28+
29+
- [快速集成](#快速集成)
30+
- [完整配置参考](#完整配置参考)
31+
- [权限说明](#权限说明)
32+
- [使用场景推荐配置](#使用场景推荐配置)
33+
- [构建运行](#构建运行)
34+
- [Android 版本适配](#android-版本适配)
35+
- [统一 startActivity 策略](#统一-startactivity-策略)
36+
- [厂商适配](#厂商适配)
37+
- [常见问题](#常见问题)
38+
- [更新日志](#更新日志)
39+
2740
---
2841

2942
## 快速集成
@@ -403,7 +416,7 @@ adb install -r app/build/outputs/apk/debug/app-debug.apk
403416

404417
# Release 构建(带时间戳)
405418
./gradlew buildTimestampedReleaseApk
406-
# 输出:release/app-202604101118.apk + mapping 文件
419+
# 输出:release/app-<yyyyMMddHHmm>.apk + mapping 文件
407420
```
408421

409422
### Rust Native(可选)
@@ -1282,6 +1295,8 @@ Native 守护进程(C++ fork)在普通应用中效果有限——Android 5.0
12821295

12831296
## 更新日志
12841297

1298+
> Maven Central 当前最新稳定版本为 `2.0.1`。下方 `v2.1.0``v2.2.0``v2.2.1` 为早期开发标签记录,用于保留历史能力演进说明;新接入请以 Maven Central 徽章和快速集成中的版本号为准。
1299+
12851300
### v2.0.1 (2026-05)
12861301

12871302
**README 多语言整理** — 默认中文 README + 全项目文档整理

framework/build.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ afterEvaluate {
357357

358358
pom {
359359
name.set("KeepLive Framework")
360-
description.set("Android 保活技术百科全书 — 35+ 种保活策略,Native C++ 守护进程,统一体外 Activity / startActivity 策略,适配 Android 7.0-16 全版本,覆盖 10+ 厂商 ROM")
360+
description.set("Android 保活技术百科全书 — 35+ 种保活策略,Native C++/Rust JNI 能力,统一体外 Activity / startActivity 策略,适配 Android 7.0-16 全版本,覆盖 10+ 厂商 ROM")
361361
url.set("https://github.com/Pangu-Immortal/KeepLiveService")
362362
inceptionYear.set("2024")
363363

llms-full.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Overview
66

7-
Fw (Framework) is a modular Android keep alive library that reproduces every known technique used by commercial apps to maintain a persistent background service. It combines Kotlin and Native C++17 in a dual-layer architecture to maximize process survival across all Android versions and vendor ROMs. The default README is Simplified Chinese (`README.md`), with English documentation in `README-en.md`.
7+
Fw (Framework) is a modular Android keep alive library that reproduces every known technique used by commercial apps to maintain a persistent background service. It combines Kotlin, Native C++17, and optional Rust JNI components in a layered architecture to maximize process survival across all Android versions and vendor ROMs. The default README is Simplified Chinese (`README.md`), with English, Traditional Chinese, Japanese, and Korean entry documents available from the language switcher.
88

99
The framework covers foreground service persistence, dual-process daemon watchdog, Native C++ fork daemon, MediaRoute media-route provider (the core keep alive approach used by KuGou Music), VPN system-level binding, CompanionDevice service, notification-permission exemptions (CallStyle + MediaSession), silent audio playback, 1-pixel Activity, account sync, JobScheduler, WorkManager, AlarmManager, accessibility service, notification listener, Bluetooth/WiFi/USB/NFC broadcast wake-up, ContentObserver, FileObserver, Binder direct-call to AMS to prevent process kill after force-stop, unified external startActivity orchestration, VirtualDisplay activity launch, and more.
1010

llms.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ English documentation: [README-en.md](README-en.md)
55

66
## 项目概览
77

8-
Fw 是一个 Android 7.0-16 保活技术百科全书 SDK,发布到 Maven Central:`io.github.pangu-immortal:keeplive-framework:2.0.1`。项目核心能力包括前台服务、MediaSession、Native C++ 守护、双进程守护、Socket 心跳、MediaRoute、VPN、CompanionDevice、通知权限豁免、账户同步、JobScheduler、WorkManager、AlarmManager、广播唤醒、ContentObserver、FileObserver、厂商 ROM 跳转和统一体外 Activity 启动策略。
8+
Fw 是一个 Android 7.0-16 保活技术百科全书 SDK,发布到 Maven Central:`io.github.pangu-immortal:keeplive-framework:2.0.1`。项目核心能力包括前台服务、MediaSession、Native C++/Rust JNI 能力、双进程守护、Socket 心跳、MediaRoute、VPN、CompanionDevice、通知权限豁免、账户同步、JobScheduler、WorkManager、AlarmManager、广播唤醒、ContentObserver、FileObserver、厂商 ROM 跳转和统一体外 Activity 启动策略。
99

1010
## Unified startActivity / 体外 Activity
1111

0 commit comments

Comments
 (0)