# lukee-reader

**Repository Path**: dogtornado/novel-reader

## Basic Information

- **Project Name**: lukee-reader
- **Description**: idea小说阅读插件
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-22
- **Last Updated**: 2026-01-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Novel Reader - IDEA 小说阅读插件

一个可以在 IntelliJ IDEA 中阅读小说的插件，拥有隐蔽的阅读体验和极佳的交互设计。

## 主要功能

### ✨ 核心特性

- **隐蔽阅读**: 小说内容显示在左下角状态栏，不易被发现
- **书架管理**: 支持导入多本小说，轻松管理你的小说收藏
- **智能目录**: 自动识别章节结构，支持多种小说格式
- **书签功能**: 随时添加书签，方便回到感兴趣的位置
- **快捷操作**: 支持自定义快捷键，翻页、切换章节一键搞定
- **老板键**: 一键隐藏小说内容，安全隐秘

### 📚 使用流程

1. **安装插件**: 在 IDEA 插件市场搜索 "Novel Reader" 并安装
2. **配置目录**: Settings -> Tools -> Novel Reader -> 选择小说文件夹
3. **导入小说**: 将 TXT 格式的小说文件放到配置的目录中
4. **开始阅读**: 
   - 打开右侧的 "Novel Reader" 工具窗口
   - 在"书架"标签页双击选择小说
   - 在"目录"标签页双击选择章节
   - 左下角状态栏即可显示小说内容

### ⌨️ 默认快捷键

| 功能 | 快捷键 | 说明 |
|------|--------|------|
| 上一页 | `Alt + ←` | 翻到上一页 |
| 下一页 | `Alt + →` | 翻到下一页 |
| 上一章 | `Alt + ↑` | 切换到上一章 |
| 下一章 | `Alt + ↓` | 切换到下一章 |
| 隐藏/显示 | `Alt + H` | 老板键，快速隐藏内容 |
| 添加书签 | `Alt + B` | 在当前位置添加书签 |

**注意**: 所有快捷键都可以在 `Settings -> Keymap -> Plugins -> Novel Reader` 中自定义。

### 🔖 书签管理

- **添加书签**: 
  - 使用快捷键 `Alt + B`
  - 或在工具窗口的"书签"标签页点击"添加"按钮
- **删除书签**: 在"书签"标签页选中书签，点击"删除"按钮
- **跳转书签**: 在"书签"标签页双击书签即可跳转

### ⚙️ 设置选项

在 `Settings -> Tools -> Novel Reader` 中可以配置：

- **小说文件夹**: 选择存放小说文件的目录
- **每页字数**: 调整每页显示的字数（500-5000字）
- **字体大小**: 调整显示字体大小（10-24号）

## 支持的小说格式

插件会自动识别以下章节标题格式：

- `第一章 标题`、`第1章 标题`
- `Chapter 1 标题`
- `1. 标题`、`1、标题`
- `[第一章] 标题`、`【第一章】标题`
- `序章`、`楔子`、`引子`、`尾声`、`后记`、`番外`

如果小说文件没有明确的章节标题，将作为整本书显示。

## 项目结构

```
NovelReader/
├── src/main/
│   ├── kotlin/com/novelreader/
│   │   ├── actions/          # 快捷键操作
│   │   ├── model/            # 数据模型
│   │   ├── service/          # 业务逻辑
│   │   ├── settings/         # 设置页面
│   │   └── ui/               # UI组件
│   └── resources/
│       ├── META-INF/
│       │   └── plugin.xml    # 插件配置
│       └── icons/            # 图标资源
├── build.gradle.kts          # 构建配置
└── README.md                 # 说明文档
```

## 开发说明

### 构建插件

```bash
./gradlew buildPlugin
```

构建完成后，插件文件位于 `build/distributions/` 目录。

### 运行开发环境

```bash
./gradlew runIde
```

这将启动一个带有插件的 IDEA 实例用于测试。

### 发布插件

1. 在 [JetBrains Plugin Repository](https://plugins.jetbrains.com/) 注册账号
2. 获取 API Token
3. 配置环境变量 `PUBLISH_TOKEN`
4. 运行发布命令：

```bash
./gradlew publishPlugin
```

## 技术栈

- **语言**: Kotlin
- **构建工具**: Gradle
- **框架**: IntelliJ Platform SDK
- **UI**: Swing

## 常见问题

### Q: 为什么看不到小说内容？

A: 请确保：
1. 已经在设置中配置了小说文件夹
2. 小说文件是 UTF-8 编码的 TXT 格式
3. 在工具窗口中双击选择了小说和章节
4. 状态栏没有被隐藏（双击右下角">>"切换显示）

### Q: 快捷键不生效？

A: 请检查：
1. 快捷键是否与其他插件冲突
2. 是否有打开的项目
3. 可以在 Keymap 设置中重新配置快捷键

### Q: 章节识别不准确？

A: 插件使用正则表达式识别章节，可能不适配某些特殊格式。建议：
1. 检查小说文件的章节标题格式
2. 可以手动编辑小说文件，统一章节标题格式

### Q: 如何导入新小说？

A: 
1. 将 TXT 格式的小说文件复制到配置的小说文件夹
2. 在工具窗口的"书架"标签页点击"刷新"按钮
3. 新小说即会出现在列表中

## 许可证

MIT License

## 贡献

欢迎提交 Issue 和 Pull Request！

## 致谢

感谢所有为这个项目做出贡献的开发者！