Metadata-Version: 2.3
Name: kamihime-auto
Version: 1.0.0
Summary: Image-recognition bot for the browser game Kamihime Project
Author: seria
Author-email: seria <seria.ati@gmail.com>
Requires-Dist: nicegui[native]>=3.17.1
Requires-Dist: numpy>=2.5.3
Requires-Dist: opencv-python-headless>=5.0.0.93
Requires-Dist: platformdirs>=4.12.1
Requires-Dist: playwright>=1.63.0
Requires-Dist: pydantic>=2.13.5
Requires-Dist: pywebview[qt] ; sys_platform == 'linux'
Requires-Python: >=3.14
Description-Content-Type: text/markdown

# kamihime-auto

English | [中文](README_ZH.md)

kamihime-auto is a tool for automating the game Kamihime Project, it helps players automate repetitive tasks like raids and farming a level repeatedly.

Although this README is written in English, kamihime-auto doesn't support the game in English, it supports Traditional Chinese only, which is the version of the game I play. However, support for other languages is totally possible, and the tool is built in a way that makes it easy to add support for other languages. If you're interested, see [Contributing](CONTRIBUTING.md) for more information.

This project is heavily inspired by [AzurLaneAutoScript](https://github.com/LmeSzinc/AzurLaneAutoScript), as seen from the UI and the way tasks and scheduler are implemented. However, the code and UI are still written from scratch with my additional thoughts and design philosophies sprinkled on top of it. Additionally, the fundamental codebase is written in a way that makes it super easy to add support for new tasks in the future, something that I'm quite proud of (although I don't think there will be need for any new tasks since there's only that much you can do in this game :/).

As the same with all my other open-source projects, I made kamihime-auto for myself, so it might not be updated anymore once I stop playing this game :D

## Installation

1. [Install uv](https://docs.astral.sh/uv/getting-started/installation/)
2. Run `uv tool install kamihime-auto`
3. Run `ka` or `kamihime-auto` to start the app!

## Usage

![kamihime-auto GUI](gui.png)

Use the sidebar to configure each task and turn them on/off. Enabled tasks will appear in the queue, click "Start" to start the scheduler, it will begin running the tasks and won't stop until it encounters an error. Tasks get rescheduled automatically. More to discover once you actually start using it!