Skip to content

okitavera/bootwitch

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

bootwitch

Magisk-powered Android Kernel Installer

Version License: BSD 3-Clause okitavera

πŸ— Setup

magiskboot

Although bootwitch are powered by magiskboot, it doesn't comes with the magiskboot binary by default.
The main purpose of it is so you can decide what version of magiskboot by yourself.
So, before anything else, you need to put your preferred magiskboot binary file inside the external/ folder.

kernel related files

Like anykernel2, you can put your Image.gz-dtb (and dtbo.img if you also want to flash that) to the root of bootwitch folder.

Specific kernel configuration (kernel.conf)

There is several things that you can configure in the kernel.conf.

kernelid=

Used by buildzip.sh for naming your zip files. required if you're using buildzip.sh for building zip file.

kernelname=
kernelver=
kernelauthor=

Informations of your kernel release. it will be displayed in the installation process. OR :

banner_mode=

If you want to use your own banner at banner.txt, you can set banner_mode to custom.
It will display the content of banner.txt instead the default information.

blk_boot=
src_kernel=

Define your kernel filename, and where the boot device block on it.

with_dtbo=
blk_dtbo=
src_dtbo=

If your kernel release also provide the dtbo.img, you can enable with_dtbo=true.
Don't forget to set the dtbo device block on blk_dtbo, and dtbo filename on src_dtbo.
If not, then just set it to false.

preserve_magisk=

Mostly, custom kernel on system-as-root devices doesn't patch their initramfs.c (@okitavera does, hehehe).
Basically, in order preserve magisk functionality on system-as-root device, you need to hexpatch it like Magisk does.
But don't worry, we got you.
You just need to set it true to let the witch (and of course, magiskboot) does the job.

before_process() {
  ....
}
after_process() {
  ....
}

This is an optional function that will be invoked before/after the whole process happens
You can use it for example: device checking, backing-up files, etc.

πŸ“¦ Building zip file

bootwitch comes with buildzip.sh to generate zip easily.
If you're already setup all things (kernel.conf, external/magiskboot, Image.gz-dtb, and maybe dtbo.img),
you can just run the script directly in your bootwitch folder.

./buildzip.sh

Author

πŸ‘€ Nanda Oktavera

🀝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

πŸ“ License

Copyright Β© 2019 Nanda Oktavera.
This project is BSD 3-Clause licensed.


This README was generated with ❀️ by readme-md-generator

About

🎩 Magisk-powered Android Kernel Installer

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages