<img width="100%" src="https://github.com/Ruyue-Kinsenka/Logo_design_backup/blob/main/AviumUI/Avium_wiki_header.png" align="center">
<h1 align="center">AviumUI</h1>
<h3 align="center">Sunward wings etch freedom on the dawn.</h3>
---
**English** | [CN](README_CN.mkdn)
> ### Refined Android Experience
**AviumUI** is a meticulously crafted interface layer based on LineageOS/AOSP, delivering a polished "stock-Android-plus" experience. We focus on thoughtful enhancements to core functionality while preserving Android's fundamental purity and performance.
## ✨ Design Principles
- **Essence Preservation**: Maintain Android's core integrity while refining the experience
- **Purpose-Driven Enhancements**: Only meaningful additions that solve real user needs
## 📥 Getting Started
### To Sync ###
```bash
# Initialize local repository
repo init -u https://github.com/AviumUI/android_manifests -b avium-16.2 --git-lfs
# Sync
repo sync -c -j$(nproc --all) --force-sync --no-clone-bundle --no-tags
```
### To Start ###
We are fully compatible with the Lineage device tree. You can directly sync the Lineage device applicable to this device. We provide some special configs:
```
# AVIUM_VERSION_APPEND_TIME_OF_DAY is a boolean flag to indicate
# whether to append time of day to the build date.
AVIUM_VERSION_APPEND_TIME_OF_DAY ?= false
# Maintainer
# AVIUM_MAINTAINER is a string that represents the maintainer of the build.
AVIUM_MAINTAINER ?= Unknown
# Settings
# Soc model name
AVIUM_SETTINGS_SOC_MODEL_NAME ?= Unknown
# Device code name
AVIUM_SETTINGS_DEVICE_CODENAME ?= Unknown
# GMS
# WITH_GMS is a boolean flag to indicate
# whether to include Google Mobile Services (GMS) in the build.
WITH_GMS ?= false
# Google Sans
# Enable this to set default fonts to Google Sans.
# This also works when building vanilla, but you
# need to sync vendor/pixel/gsans repo.
TARGET_USES_GSANS := false
# LatinIMEGooglePrebuilt
# Only works on vanilla builds,
# GMS builds will use the Google IME from GMS.
TARGET_INCLUDE_GOOGLEIME ?= false
TARGET_GOOGLEIME_OVERRIDE_IME ?= false
# Spoof Props
# Set to true to enable spoofing fake props.
# For letting apps think they are running on a locked device.
AVIUM_FORCE_SET_FAKE_PROP ?= false
# Blur Effect
# The blur usually enabled on Android 16 QPR2.
# If the blur not enabled, set to true to force enable blur for SystemUI.
TARGET_FORCE_ENABLE_BLUR ?= false
```
Please add these configs to lineage_xxx.mk, device.mk or equivalent Makefile.
### To Build ###
```bash
# Set up environment
. build/envsetup.sh
# Choose a target
lunch lineage_$device-bp4a-userdebug
# To build
m bacon -j$(nproc --all)
```