# YukiHookAPI Project Builder

![Blank](https://img.shields.io/badge/license-AGPL3.0-blue)
![Blank](https://img.shields.io/badge/version-v1.0.3-green)
[![Telegram](https://img.shields.io/badge/Follow-Telegram-blue.svg?logo=telegram)](https://t.me/YukiHookAPI)
<br/><br/>
<img src="https://github.com/fankes/YuKiHookAPI/blob/master/img-src/icon.png?raw=true" width = "100" height = "100"/>
<br/>
<br/>
A Xposed Project Builder by YukiHookAPI.
<br/>

English | [简体中文](https://github.com/fankes/YukiHookAPI-ProjectBuilder/blob/master/README-zh-CN.md)

## What's this

- This is an automatic building tool for Xposed modules using [YukiHookAPI](https://github.com/fankes/YukiHookAPI) as the core

- Implementing automated search relies on quickly building an Android project template that includes a Xposed module environment

## How to use

- This project is developed using **Electron** to quickly build and run multi-platform localized applications

You can download the application for your platform directly
from [Release](https://github.com/fankes/YukiHookAPI-ProjectBuilder/releases).

**The following are the manual deployment and compilation steps**

First you need to install [node.js](https://nodejs.org/en/)

IDE tools recommend **IntelliJ IDEA** or **WebStorm**

Formatting code with **Visual Studio Code** is not recommended and may cause some errors.

- Execute the following command to install Electron

```
npm install --save-dev electron
```

- Execute the following command to install yarn

```
npm install yarn
```

- Enter the project directory and execute the following command to install dependencies

```
npm install --save-dev @electron-forge/cli
```

```
npx electron-forge import
```

- Use the following command to debug

```
npm run start
```

- Use the following commands to compile & package

**Linux/macOS**

```
npm run make
```

**Windows**

```
npm run package
```

## License

- [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html)

```
Copyright (C) 2019-2023 HighCapable

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
```

Copyright © 2019-2023 HighCapable