kai/README.md

# kai

## All Your Batteries, at a Glance
kai will show any Bluetooth device that provides battery information, meaning you can check the battery of your iPhone, your Apple Watch, your AirPods, and your AirPods case, all from the lockscreen. Quickly and easily.

## Compatibility
kai works with many, many lockscreen tweak:
- Kalm
- Grupi
- Axon
- Quart
- Complications
- Watermelon
- Veza
- QuickLS
- Jellyfish
- And more!

## Make it Yours
kai comes with a multitude of customization options, so you can fine-tune your settings to fit you and your setup.

## Big and Bold, or Small and Simple
kai offers two main options for displaying battery information. (a) Vertical mode, to make kai fit in with your notifications, and (b) horizontal mode, an unobtrusive, scrollable, and tiny mode that doesn't take up any more space on your lock screen than it needs to.

## Full Feature/Option List
- Option to hide the large battery view coversheet charging animations on the lock screen
- Show all or just charging devices on kai
- Option to show Bluetooth devices always, and the phone only when charging
- Option to hide device glyphs on kai cells
- Option to hide percent label on kai cells
- Option to hide the device name label on kai cells
- Two-axis options: vertical mode, or horizontal mode
- Choose between adaptive, light, or dark mode for kai's cells
- Choose between adaptive, white, or black text for labels on kai's cells
- Choose to align kai to the left, right, or center for vertical mode
- Option to show kai above or below music player
- Adjust kai cell height
- Adjust kai banner width
- Adjust the spacing between kai cells vertically
- Adjust the spacing between kai cells horizontally
- Manual offset option for the x-axis
- Adjust device glyph size
- Adjust kai cell corner radius
- Adjust kai cell background blur alpha

## Note
Special thanks to my amazing beta testers in the server I co-own with Thomz. I could not have tested kai so extensively and brought it to where it is today without them. Thanks to Thomz (@Thomzi07 on Twitter) for making kai's icon, and depiction screenshots, and Thenatis (@thenatis1 on Twitter) for helping with design, and for making the banner for kai. Additionally, kai is inspired by LaughingQuoll's Maple tweak series and Apple's AirPower design. kai was built with inspiration from this. However, the main reason I made kai is because the Maple series does not work with notification grouping tweaks like Axon and Grupi. Additionally, kai features a wider range of customization options.

## Socials and Support
If you are encountering issues, or simply wish to reach out, you can contact me at my email (burrit0ztweaks@gmail.com) or join the discord server I co-own with Thomz to get support. Discord server invite link: https://discord.gg/NQ3uXtJ