mirror of
https://github.com/topjohnwu/Magisk.git
synced 2024-11-23 12:09:48 +00:00
Update development docs
This commit is contained in:
topjohnwu
parent
e3cb5f8ddd
commit
a8c1ed8795
25
README.MD
25
README.MD
@ -26,6 +26,7 @@ Some highlight features:
|
||||
## Useful Links
|
||||
|
||||
- [Installation Instruction](https://topjohnwu.github.io/Magisk/install.html)
|
||||
- [Building and Development](https://topjohnwu.github.io/Magisk/build.html)
|
||||
- [Magisk Documentation](https://topjohnwu.github.io/Magisk/)
|
||||
|
||||
## Bug Reports
|
||||
@ -36,30 +37,6 @@ For installation issues, upload both boot image and install logs.<br>
|
||||
For Magisk issues, upload boot logcat or dmesg.<br>
|
||||
For Magisk app crashes, record and upload the logcat when the crash occurs.
|
||||
|
||||
## Building and Development
|
||||
|
||||
- Magisk builds on any OS Android Studio supports. Install Android Studio and do the initial setups.
|
||||
- Clone sources: `git clone --recurse-submodules https://github.com/topjohnwu/Magisk.git`
|
||||
- Install Python 3.8+ \
|
||||
(Windows only: select **'Add Python to PATH'** in installer, and run `pip install colorama` after install)
|
||||
- Configure to use the JDK bundled in Android Studio:
|
||||
- macOS: `export JAVA_HOME="/Applications/Android Studio.app/Contents/jre/Contents/Home"`
|
||||
- Linux: `export PATH="/path/to/androidstudio/jre/bin:$PATH"`
|
||||
- Windows: Add `C:\Path\To\Android Studio\jre\bin` to environment variable `PATH`
|
||||
- Set environment variable `ANDROID_SDK_ROOT` to the Android SDK folder (can be found in Android Studio settings)
|
||||
- Run `./build.py ndk` to let the script download and install NDK for you
|
||||
- To start building, run `build.py` to see your options. \
|
||||
For each action, use `-h` to access help (e.g. `./build.py all -h`)
|
||||
- To start development, open the project with Android Studio. The IDE can be used for both app (Kotlin/Java) and native sources.
|
||||
- Optionally, set custom configs with `config.prop`. A sample `config.prop.sample` is provided.
|
||||
|
||||
## Signing and Distribution
|
||||
|
||||
- The certificate of the key used to sign the final Magisk APK product is also directly embedded into some executables. In release builds, Magisk's root daemon will enforce this certificate check and reject and forcefully uninstall any non-matching Magisk apps to protect users from malicious and unverified Magisk APKs.
|
||||
- To do any development on Magisk itself, switch to an **official debug build and reinstall Magisk** to bypass the signature check.
|
||||
- To distribute your own Magisk builds signed with your own keys, set your signing configs in `config.prop`.
|
||||
- Check [Google's Documentation](https://developer.android.com/studio/publish/app-signing.html#generate-key) for more details on generating your own key.
|
||||
|
||||
## Translation Contributions
|
||||
|
||||
Default string resources for the Magisk app and its stub APK are located here:
|
||||
|
||||
@ -7,7 +7,8 @@
|
||||
|
||||
The following sections are for developers
|
||||
|
||||
- [Developer Guides](guides.md)
|
||||
- [Building and Developing Magisk](build.md) (for developing Magisk itself)
|
||||
- [Developer Guides](guides.md) (for developers **using** Magisk)
|
||||
- [Magisk Tools](tools.md)
|
||||
- [Internal Details](details.md)
|
||||
- [Android Booting Shenanigans](boot.md)
|
||||
|
||||
64
docs/build.md
Normal file
64
docs/build.md
Normal file
@ -0,0 +1,64 @@
|
||||
# Building and Development
|
||||
|
||||
## Setup Environment
|
||||
|
||||
- Supported platforms:
|
||||
- Linux x64
|
||||
- macOS x64 (Intel)
|
||||
- macOS arm64 (Apple Silicon)
|
||||
- Windows x64
|
||||
- Windows only: Enable [developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development). This is required because we need symbolic link support.
|
||||
- Install Python 3.8+:
|
||||
- On Unix, install python3 using your favorite package manager
|
||||
- On Windows, download and install the latest Python version on the [offical website](https://www.python.org/downloads/windows/).<br>
|
||||
Make sure to select **"Add Python to PATH"** during installation.
|
||||
- (Optional on Windows): Run `pip install colorama` to install the `colorama` python package
|
||||
- Install Git:
|
||||
- On Unix, install git with your favorite package manager
|
||||
- On Windows, download the install the latest Git version on the [official website](https://git-scm.com/download/win).<br>
|
||||
Make sure to **"Enable symbolic links"** during installation.
|
||||
- Install Android Studio and follow the instructions and go through the initial setup.
|
||||
- Set environment variable `ANDROID_SDK_ROOT` to the Android SDK folder. This path can be found in Android Studio settings.
|
||||
- Setup JDK:
|
||||
- The recommended option is to set environment variable `ANDROID_STUDIO` to the path where your Android Studio is installed. The build script will automatically find and use the bundled JDK.
|
||||
- You can also setup JDK 17 yourself, but this guide will not cover the instructions.
|
||||
- Clone sources: `git clone --recurse-submodules https://github.com/topjohnwu/Magisk.git`
|
||||
- Run `./build.py ndk` to let the script download and install NDK for you
|
||||
|
||||
## Building
|
||||
|
||||
- To build everything and create the final Magisk APK, run `./build.py all`.
|
||||
- You can also build specific sub-components; call `build.py` to see your options. \
|
||||
For each action, use `-h` to access help (e.g. `./build.py binary -h`)
|
||||
- Configure the build by using `config.prop`. A sample `config.prop.sample` is provided.
|
||||
|
||||
## IDE Support
|
||||
|
||||
- The repository can be directly opened with Android Studio as a project.
|
||||
- The Kotlin, Java, C++, and C code in the project should be properly supported in Android Studio out of the box.
|
||||
- Run `./build.py binary` before working on native code, as some generated code is only created during the build process.
|
||||
|
||||
### Developing Rust in Android Studio
|
||||
|
||||
Because the Magisk NDK package, [ONDK](https://github.com/topjohnwu/ondk) (the one installed with `./build.py ndk`), contains a fully self contained Clang + Rust toolchain, building the Magisk project alone does not require configuring toolchains. However, due to the way how the Intellij Rust plugin works, you'll have to go through some additional setup to make Android Studio work with Magisk's Rust codebase:
|
||||
|
||||
- Install [rustup](https://rustup.rs/), the official Rust toolchain manager
|
||||
- Link the ONDK Rust toolchain and set it as default:
|
||||
|
||||
```bash
|
||||
# Link the ONDK toolchain with the name "magisk"
|
||||
rustup toolchain link magisk "$ANDROID_SDK_ROOT/ndk/magisk/toolchains/rust"
|
||||
# Set as default
|
||||
rustup default magisk
|
||||
```
|
||||
|
||||
- Install the [Intellij Rust plugin](https://www.jetbrains.com/rust/) in Android Studio
|
||||
- In Preferences > Languages & Frameworks > Rust, set `$ANDROID_SDK_ROOT/ndk/magisk/toolchains/rust/bin` as the toolchain location
|
||||
- Open `native/src/Cargo.toml`, and select "Attach" in the "No Cargo projects found" banner
|
||||
|
||||
## Signing and Distribution
|
||||
|
||||
- In release builds, the certificate of the key signing the Magisk APK will be used by Magisk's root daemon as a reference to reject and forcefully uninstall any non-matching Magisk apps to protect users from malicious and unverified Magisk APKs.
|
||||
- To do any development on Magisk itself, switch to an **official debug build and reinstall Magisk** to turn off the signature check.
|
||||
- To distribute your own Magisk builds signed with your own keys, set your signing configs in `config.prop`.
|
||||
- Check [Google's Documentation](https://developer.android.com/studio/publish/app-signing.html#generate-key) for more details on generating your own key.
|
||||
@ -184,26 +184,28 @@ The `customize.sh` script runs in Magisk's BusyBox `ash` shell with "Standalone
|
||||
|
||||
```
|
||||
ui_print <msg>
|
||||
print <msg> to console
|
||||
Print <msg> to console
|
||||
Avoid using 'echo' as it will not display in custom recovery's console
|
||||
|
||||
abort <msg>
|
||||
print error message <msg> to console and terminate the installation
|
||||
Print error message <msg> to console and terminate the installation
|
||||
Avoid using 'exit' as it will skip the termination cleanup steps
|
||||
|
||||
set_perm <target> <owner> <group> <permission> [context]
|
||||
if [context] is not set, the default is "u:object_r:system_file:s0"
|
||||
this function is a shorthand for the following commands:
|
||||
If [context] is not specified, the default is "u:object_r:system_file:s0"
|
||||
This function is a shorthand for the following commands:
|
||||
chown owner.group target
|
||||
chmod permission target
|
||||
chcon context target
|
||||
|
||||
set_perm_recursive <directory> <owner> <group> <dirpermission> <filepermission> [context]
|
||||
if [context] is not set, the default is "u:object_r:system_file:s0"
|
||||
for all files in <directory>, it will call:
|
||||
set_perm file owner group filepermission context
|
||||
for all directories in <directory> (including itself), it will call:
|
||||
set_perm dir owner group dirpermission context
|
||||
If [context] is not specified, the default is "u:object_r:system_file:s0"
|
||||
This function is a shorthand for the following psuedo code:
|
||||
set_perm <directory> owner group dirpermission context
|
||||
for file in <directory>:
|
||||
set_perm file owner group filepermission context
|
||||
for dir in <directory>:
|
||||
set_perm_recursive dir owner group dirpermission context
|
||||
```
|
||||
|
||||
For convenience, you can also declare a list of folders you want to replace in the variable name `REPLACE`. The module installer script will create the `.replace` file into the folders listed in `REPLACE`. For example:
|
||||
|
||||
@ -1,27 +0,0 @@
|
||||
# Native Development
|
||||
|
||||
## Prerequisite
|
||||
|
||||
Install the NDK required to build and develop Magisk with `./build.py ndk`. The NDK will be installed to `$ANDROID_SDK_ROOT/ndk/magisk`. You don't need to manually install a Rust toolchain with `rustup`, as the NDK installed already has a Rust toolchain bundled.
|
||||
|
||||
## Build Configs
|
||||
|
||||
All C/C++ code and its dependencies are built with [`ndk-build`](https://developer.android.com/ndk/guides/ndk-build) and configured with several `*.mk` files scattered in many places.
|
||||
|
||||
The `src` folder is also a proper Cargo workspace, and all Rust code is built with `cargo` just like normal Rust projects.
|
||||
|
||||
## Rust + C/C++
|
||||
|
||||
To reduce complexity involved in linking, all Rust code is built as `staticlib` and linked to C++ targets to ensure our final product is built with an officially supported NDK build system. Each C++ target can at most link to **one** Rust `staticlib` or else multiple definitions error will occur.
|
||||
|
||||
We use the [`cxx`](https://cxx.rs) project for Rust and C++ interop.
|
||||
|
||||
## Development / IDE
|
||||
|
||||
All C++ code should be recognized and properly indexed by Android Studio out of the box. For Rust:
|
||||
|
||||
- Install the [Rust plugin](https://www.jetbrains.com/rust/) in Android Studio
|
||||
- In Preferences > Languages & Frameworks > Rust, set `$ANDROID_SDK_ROOT/ndk/magisk/toolchains/rust/bin` as the toolchain location
|
||||
- Open `native/src/Cargo.toml`, and select "Attach" in the "No Cargo projects found" banner
|
||||
|
||||
Note: run `./build.py binary` before developing to make sure generated code is created.
|
||||
Loading…
Reference in New Issue
Block a user