# SwordHolder

**Repository Path**: kuangthree/sword-holder

## Basic Information

- **Project Name**: SwordHolder
- **Description**: No description available
- **Primary Language**: Kotlin
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2025-10-17
- **Last Updated**: 2026-01-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 捉刀人 (SwordHolder)

一个基于Android平台的AI辅助写作应用，使用Jetpack Compose构建的现代化移动写作工具。

## 项目简介

**捉刀人**是一个专为写作者设计的移动应用，集成了AI助手功能，帮助用户进行创作、编辑和优化文本内容。应用采用现代化的Android开发技术栈，提供流畅的用户体验。

## 技术栈

- **开发语言**: Kotlin
- **UI框架**: Jetpack Compose
- **架构模式**: MVVM (Model-View-ViewModel)
- **数据库**: Room
- **网络请求**: OkHttp
- **依赖注入**: 使用Gradle插件
- **构建工具**: Gradle

## 开源库引用

### OkHttp
用于实现网络请求。

### [ComposeReorderable](https://github.com/aclassen/ComposeReorderable) 
该项目基于Apache 2.0协议，与GPLv3协议兼容。
另外，由于原作者没有继续维护，这里合并了两位开发者的Pull Request，分别是 [Compose 1.4, AGP 8.0, refactored forEachGesture with awaitEachGesture](https://github.com/aclassen/ComposeReorderable/pull/257) 与 [Updated dependencies to latest versions #294](https://github.com/aclassen/ComposeReorderable/pull/294) 。
特此申明，非常感谢原作者与更新者的贡献。

### [skb-global](https://github.com/boybeak/skb-global)
用于获取软键盘的高度和显示状态。

## 主要功能

### 📝 作品管理
- 创建和管理多个作品
- 支持书籍和单篇作品两种类型
- 作品信息编辑和存储

### 💬 AI聊天助手
- 集成DeepSeek等AI模型
- 智能对话和文本生成
- 实时流式响应

### ✏️ 文章编辑器
- 富文本编辑功能
- 实时保存和预览
- 智能格式处理

### ⚙️ 配置管理
- AI模型配置
- 提示词设置
- 应用偏好设置

## 项目结构

```
app/src/main/java/com/universest/swordholder/
├── aitool/           # AI工具相关
│   ├── AbstractLlmApi.kt
│   ├── DeepSeekApi.kt
│   └── Message.kt
├── data/             # 数据层
├── model/            # 数据模型
├── ui/               # UI层
│   ├── activity/     # Activity组件
│   ├── screen/       # 主要屏幕
│   ├── widget/       # 可复用组件
│   └── theme/        # 主题和样式
├── viewmodel/        # ViewModel层
└── tools/            # 工具类
```

## 快速开始

### 环境要求
- Android Studio Arctic Fox 或更高版本
- Android SDK 26+
- Java 11

### 构建步骤
1. 克隆项目到本地
2. 使用Android Studio打开项目
3. 同步Gradle依赖
4. 连接Android设备或启动模拟器
5. 运行应用

### 构建命令
```bash
# 使用Gradle Wrapper构建
./gradlew assembleDebug

# 安装到设备
./gradlew installDebug
```

## 配置说明

### AI服务配置
应用支持配置多个AI服务提供商，目前主要集成DeepSeek API。在应用设置中可以配置API密钥和端点。

### 数据存储
- 使用Room数据库进行本地数据持久化
- 支持作品、章节、对话历史等数据的存储
- 使用DataStore进行应用配置存储

## 开发特色

### 现代化架构
- 使用Compose声明式UI
- MVVM架构确保关注点分离
- 响应式状态管理

### 用户体验优化
- 流畅的动画和过渡效果
- 自适应布局设计
- 离线功能支持

### 代码质量
- 遵循Kotlin最佳实践
- 模块化设计
- 完善的错误处理

## 许可证

本项目采用 GNU General Public License v3.0 开源许可证。详见 [LICENSE](LICENSE) 文件。

## 贡献

欢迎提交Issue和Pull Request来帮助改进这个项目。

## 联系方式

如有问题或建议，请通过以下方式联系：
- 提交GitHub Issue
- 发送邮件至项目维护者

---

*让AI成为您的创作伙伴，让写作变得更加轻松愉快！*