Automated build system for RalyxOS, a rooted version of CalyxOS
Go to file
DrMaxNix 90c2a014ce 📝 notes of calyx build reverse engineering 2024-05-14 09:30:17 +02:00
.editorconfig 🔧 add editorconfig 2024-04-22 20:07:52 +02:00
LICENSE 📄 add license 2024-04-22 20:07:34 +02:00
README.md 📝 add repo tool install instructions 2024-04-22 20:21:01 +02:00
patch-notes.md 📝 notes of calyx build reverse engineering 2024-05-14 09:30:17 +02:00

README.md

RalyxOS

Automated build system for RalyxOS, a rooted version of CalyxOS

⚠️ Cautionary Statement ⚠️

You are using this software at your OWN RISK!
Flashing custom firmware can cause PERMANENT DAMAGE to your device!
This project is not affiliated with Google, CalyxOS, Magisk or any other tool used!

  • ⚠️ Do NOT use the update tool provided by the Magisk app. This will brick your device!
  • ⚠️ If unsure, always enable OEM Unlocking before making any changes to the bootloader or rebooting afterwards!
  • ⚠️ RalyxOS has only been tested on Android 14
  • ⚠️ Even though this is an automated script, you should have a decent understanding of the Android build workflow and how firmware flashing works
  • ⚠️ The script will warn you about dangerous steps and precautions to take. Read prompts thoroughly before proceeding!

Setup

Installing required tools

$ sudo apt update
$ sudo apt install bc curl default-jdk-headless default-jre-headless git libncurses5 libncurses5-dev libssl-dev lz4 m4 python3-lxml python3-protobuf python3-yaml python-is-python3 rsync zip
$ curl https://storage.googleapis.com/git-repo-downloads/repo | sudo tee /usr/local/bin/repo > /dev/null
$ sudo chmod +x /usr/local/bin/repo

Selecting a suitable storage location

$ cd /mnt/some-big-nvme-disk

The Android codebase is huge. Make sure the ralyxos folder has at least 400GB of free space and reasonably fast read/write speeds (SSD)!

Installing the script

$ git clone https://git.tjdev.de/DrMaxNix/ralyxos.git

TODO

Attribution / Credits

This project's MIT license only applies to files inside of its repository.
Files downloaded by this software remain property of their respective owners!