# assistant

**Repository Path**: dwqnb/assistant

## Basic Information

- **Project Name**: assistant
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 5
- **Created**: 2025-07-02
- **Last Updated**: 2025-07-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# lazycat-assistant 玩机助手

该项目需要使用者在 `config.json` 上自己填写配置
公网地址：https://assistant.lazycat.cloud/#/home

## 目录结构要求

期望的目录结构如下：

```
public/
├── Assistant_xxxxx/                    # 助手key对应的文件夹（可自由取名）,文章顺序根据 `config.json` 的顺序排列
│   ├── Thumbnail/                  # 缩略图文件夹
│   │   └── thumbnail.png
│   ├── Android/                    # Android平台
│   │   ├── Step_1/
│   │   │   ├── media.png           # 文件名必须为media
│   │   │   └── article.md          # 文件名必须为article
│   │   ├── Step_2/
│   │   └── Step_3/
│   ├── iOS/                        # iOS平台
│   │   ├── Step_1/
│   │   ├── Step_2/
│   │   └── Step_3/
│   └── PC/                         # PC平台
│       ├── Step_1/
│       ├── Step_2/
│       └── Step_3/
└── Assistant_xxxxx/                    # 其他玩机文章...
```

这个脚本用于根据 `OriginAssistant` 配置自动生成 `AssistantList` 配置。

## 功能

- 读取 `src/config.ts` 中的 `OriginAssistant` 配置
- 扫描 `public` 文件夹中对应的目录结构
- 自动生成 `AssistantList` 配置
- 更新 `src/config.ts` 文件

## 使用方法

### 1. 修改 `src/config.json` 配置

### 2. 在 `public` 添加对应文章 `Assistant_1, Assistant_2, ...`

### 3. 使用 npm 脚本,生成对应 `src/config.ts` 配置

```bash
npm run generate-assistant
```

### 4. 本地验证没问题，将修改推送到 `origin/master` 上