Skip to content

Home

Jump to bottom
xingguangcuican6666 edited this page May 17, 2026 · 2 revisions

ABK 项目总览 / ABK Project Overview

Relevant source files

中文

项目目标

ABK (AnyBase Kernel) 是一个旨在简化通用内核映像 (GKI) 构建、分发与管理流程的自动化框架。它将繁琐的 GitHub 仓库 Fork、Actions 配置、内核参数填写、产物下载以及 Root 环境下的刷写步骤，整合进一个无缝的 CI/CD 流水线与 Android 移动端应用中。

项目核心目标包括：

  • 自动化构建 ：通过 GitHub Actions 实现多版本 GKI (Android 12-16) 的一键编译 README.md#L34-L37。
  • 功能集成 ：内置 KernelSU (Official/Next)、SUSFS、ZRAM 增强 (LZ4K)、DDK LSM 等安全与性能补丁 .github/workflows/build.yml#L47-L88。
  • 移动端闭环 ：提供 Android 管理器应用，实现 GitHub 授权、构建调度、进度监控及设备端一键刷写 README.md#L194-L205。

双组件架构

ABK 由两个主要部分组成：

  1. CI/CD 流水线 ：基于 GitHub Actions，负责同步上游源码、应用补丁、编译内核并发布制品。
  2. ABK Manager App ：基于 Jetpack Compose 的 Android 应用，作为用户的操作中枢，通过 GitHub API 驱动云端构建并处理本地刷写逻辑 app/build.gradle.kts#L104-L115。

系统架构图：从代码到实体

该图展示了 ABK 如何将云端工作流与本地应用逻辑关联。

DeepWiki client-side-rendered block omitted in static export.

Sources: .github/workflows/build.yml#L1-L31 app/build.gradle.kts#L40-L43 README.md#L194-L205

English

Project Goals

ABK (AnyBase Kernel) is an automation framework designed to streamline the process of building, distributing, and managing Generic Kernel Images (GKI). It consolidates manual tasks—such as forking repositories, configuring Actions, inputting GKI parameters, downloading artifacts, and flashing in root environments—into a seamless CI/CD pipeline and Android mobile application.

Key objectives include:

  • Automated Builds : One-click compilation for multiple GKI versions (Android 12-16) via GitHub Actions README-EN.md#L34-L37
  • Feature Integration : Built-in support for KernelSU (Official/Next), SUSFS, ZRAM enhancements (LZ4K), DDK LSM, and other security/performance patches .github/workflows/build.yml#L47-L88
  • Mobile Loop : An Android manager app that serves as a command center for GitHub authorization, build dispatching, progress monitoring, and on-device flashing README-EN.md#L194-L205

Dual-Component Architecture

ABK consists of two primary pillars:

  1. CI/CD Pipeline : Powered by GitHub Actions, responsible for syncing upstream sources, applying patches, compiling kernels, and publishing release artifacts.
  2. ABK Manager App : A Jetpack Compose-based Android application that drives cloud builds via the GitHub API and handles local flashing logic app/build.gradle.kts#L104-L115

System Architecture: Bridging Code to Entities

The following diagram illustrates the relationship between cloud workflows and local application logic.

DeepWiki client-side-rendered block omitted in static export.

Sources: .github/workflows/build.yml#L9-L23 app/build.gradle.kts#L118-L128 README-EN.md#L108-L125

核心章节索引 / Core Section Index

章节 / Section 内容概述 / Content Summary
入门与仓库结构 / Getting Started & Repository Structure 仓库目录布局、Fork 指南与 Actions 初始化。 / Repository layout, fork guide, and Actions initialization.
支持的内核版本与 GKI 数据 / Supported Kernel Versions & GKI Data Android 与内核版本矩阵、GKI 子版本跟踪数据。 / Android/Kernel matrix and GKI sub-level tracking data.
CI/CD 内核构建流水线 / CI/CD Kernel Build Pipeline 深入解析 build.yml 工作流、发布编排与自定义配置。 / Deep dive into build.yml workflow, release orchestration, and custom configs.
内核补丁子系统 / Kernel Patch Subsystems DDK LSM、ZRAM LZ4K 及内置模块的技术细节。 / Technical details of DDK LSM, ZRAM LZ4K, and bundled modules.
ABK Manager Android 应用 / ABK Manager Android Application 应用架构、GitHub 集成、ViewModel 状态管理与刷写逻辑。 / App architecture, GitHub integration, ViewModel state, and flash logic.
Web 仪表盘 / Web Dashboard 静态仪表盘结构与 SCSS 样式系统。 / Static dashboard structure and SCSS styling system.

Sources: README.md#L24-L30 README-EN.md#L24-L30 .github/workflows/build.yml#L132-L135

null

Clone this wiki locally