KantOS/README.md
2024-08-02 00:08:06 +10:00

60 lines
3.2 KiB
Markdown

![logo](https://github.com/user-attachments/assets/2a0d50dc-60bf-4c85-b4d4-b87e19013db6)
# About
KantOS is a theme ported for OnionOS, which is inspired by the Kanto region of Pokémon. It was built using a combination of custom and original sprites from the GBA Pokémon games.
The concept design was first created by [Tressley on muOS](https://github.com/Tressley/KantOS/tree/main) for the Anbernic handheld devices. I was a huge fan of it, and I'd like to express my appreciation to Tressley for creating the theme and also giving me permission to port it to OnionOS.
I have since heavily modified it to suit the vastly-different OnionOS architecture, and have included many of my own additions to the theme.
# Credits
- *Aemiii91* for letting me include their `Dot-art by Yoshi-kun` icon pack on the official [Onion Theme Repo](https://github.com/OnionUI/Themes/blob/main/generated/icons_standalone/index.md)
- [Spriters-Resource](https://www.spriters-resource.com) for the Pokémon sprites
- [Yuji Oshimoto](http://www.04.jp.org/) for the `04b_03` font
- Pokémon Black/White 2 for the Virbank City OST
# Important Notes
- It is ***highly*** recommended to update your OnionOS to at least `v4.3.1-1` or higher, as it removes the text-shadow effect that's present on earlier versions which is incompatible with the font used here (see the [OnionOS Releases page](https://github.com/OnionUI/Onion/releases) or use the OTA feature within the Apps on your Miyoo Mini)
- Font color of the highlighted item on the WIFI configuration page, as well as the font in the keyboard pop-up when entering a WIFI password is currently *bugged* since those are set at the system-level and isn't something I can change
- **In case you have any theme overrides set**, I recommend that you enable the `battery percentage` option for best UI experience if not already enabled (via `Apps > Tweaks > Appearance > Theme overrides > Battery Percentage` & set to Visible)
# Download
You can find the latest ZIP file on the [Releases](https://github.com/antonlabz/KantOS/releases) page.
# Installation
- Place the downloaded ZIP file into the `Themes` folder of your SD card
- Apply the theme by going to `Apps > Themes` and selecting it
# Screenshots
#### Home Screen (GIF)
![home](https://github.com/user-attachments/assets/b2126574-0733-46f9-ab79-6fd8a78f2871)
#### Settings
![settings](https://github.com/user-attachments/assets/027e7bcd-edc4-44dc-b3db-cad3d9a01620)
#### Games
![MainUI_012](https://github.com/user-attachments/assets/236ee89b-726b-4de2-8f31-1fc6d8c972fd)
#### Boot Screen
![bootScreen](https://github.com/user-attachments/assets/a7d30d8a-e063-450b-9886-08cf51e18131)
#### Low Battery
![lowBat](https://github.com/user-attachments/assets/40feca0d-f9d9-4b00-acd3-f72491f2d948)
#### Charging Animation
![charging](https://github.com/user-attachments/assets/15dfebf1-7684-4344-901e-03d14085d978)
#### Power Off + Save
![Screen_Off_Save](https://github.com/user-attachments/assets/2e0cc05f-de3c-4c0e-b57e-64bf2516207b)
#### Power Off
![Screen_Off](https://github.com/user-attachments/assets/c4bdab6a-4962-4a36-8059-b307de227a6d)
#### GameSwitcher
![GameSwitcher_000](https://github.com/user-attachments/assets/3a242d26-fed9-4d9d-bc6d-28fc0fdcc186)