# Word

**Repository Path**: AnNight/word

## Basic Information

- **Project Name**: Word
- **Description**: 背单词小工具
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-12-30
- **Last Updated**: 2024-10-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Javafx

## README

# Word

![IDEA](https://img.shields.io/badge/IntelliJ_IDEA-blue?logo=intellijidea)
![Maven](https://img.shields.io/badge/Maven-red?logo=apachemaven)
![Java](https://img.shields.io/badge/Java-21-orange)
![JavaFX](https://img.shields.io/badge/JavaFX-22-orange)

**本项目已暂停后续开发！（练手结束qwq）**

## 简介

**本软件仅用于学习交流！**

背单词小工具，具有以下功能：
1. 不同账户的词库、背诵数据完全分离；具有注册、删除、登录、退出、修改头像、修改密码功能；
2. 背诵新单词、复习单词功能；
3. 用户可随意操作自己的词库；具有词库信息、添加单词、删除单词、导入词库、导出词库、下载离线数据、删除所有背诵数据功能；
4. 搜索单词功能。
5. 发音功能；英音和美音（包含 `-` 的单词除外，部分生僻单词可能没有音频资源）。
6. 默认提供浅色皮肤和深色皮肤，并且可以加载存放在 _“安装路径/style/”_ 文件夹内的自定义 .css 样式。

## 注意事项

### 【 提 示 】
* 注册时，单击名字上方的图片即可设置头像。
* 登录后，单击头像即可弹出账户管理窗口。

### 【 安 装 方 法 】
使用 **安装程序** 安装，下载 [Word-x.x.exe](https://gitee.com/AnNight/word/releases) 安装程序，执行即可。 但需要注意如下事项：
1. _**不要**将 Word 安装至默认路径！否则，在以非管理员模式运行 Word 时，程序将因没有权限创建/修改文件而无法正常运行。_
2. _运行 Word 时，如果出现 "Failed to launch JVM" 报错，或其他打不开软件的情况，请尝试在卸载后，重新安装至其他磁盘（例如更换安装位置到 D 盘或者 E 盘）。_

### 【 更 新 方 法 】
1. 在旧版本的安装目录中找到 **data 文件夹**、**style 文件夹**和 **voice 文件夹**，将它们复制到安装目录以外的任意位置；
2. 下载新版本的 [Word-x.x.exe](https://gitee.com/AnNight/word/releases) 安装程序，并执行；
3. 安装后，将 (1.) 中复制到的文件夹，移动回新版本的安装目录中。
> _此问题的原因是：由于安装程序会自动卸载旧版本，且卸载时不保留用户数据，故而需使用上述步骤以保留用户数据。_

## 演示
| 演示窗口   | 演示场景    | 截图                              |
|--------|---------|---------------------------------|
| 主窗口    | 登录      | ![](imgs/SignIn.png)            |
| 主窗口    | 注册      | ![](imgs/CreateAnAccount.png)   |
| 主窗口    | 欢迎      | ![](imgs/Main-HelloWord.png)    |
| 主窗口    | 学习      | ![](imgs/Main-Study.png)        |
| 主窗口    | 复习-输入   | ![](imgs/Main-Review-Input.png) |
| 主窗口    | 复习-正确   | ![](imgs/Main-Review-Green.png) |
| 主窗口    | 复习-错误   | ![](imgs/Main-Review-Red.png)   |
| 搜索窗口   | 搜索      | ![](imgs/Search.png)            |
| 账户管理窗口 | 修改头像选项卡 | ![](imgs/User.png)              |
| 词库管理窗口 | 信息选项卡   | ![](imgs/Dictionary.png)        |

## 未来
* 多个单词本功能（目前是一个账号一个单词本）。
* 收藏/取消收藏功能。

## 鸣谢
- 翻译数据提供者：`https://dict.youdao.com(网易有道)`
- 音频数据提供者：`https://ssl.gstatic.com(谷歌)`
- UI界面：`org.openjfx/javafx-controls(JavaFX)`
- 词库数据和用户数据管理：`org.xerial/sqlite-jdbc(SQLite)`
- HTML字符实体解析：`org.apache.commons/commons-text`
- 单词数据序列化/反序列化：`com.alibaba.fastjson2/fastjson2(FastJSON2)`
- 图片保存：`org.openjfx/javafx-swing/SwingFXUtils`
- 音频：`org.openjfx/javafx-media/MediaPlayer`
- 日志：
  - `org.apache.logging.log4j/log4j-api(Log4j2)`
  - `org.apache.logging.log4j/log4j-core(Log4j2)`
  - `org.projectlombok/lombok(Lombok)`
- 配置：
  - `org.dom4j/dom4j`
  - `priv.liaohaolong/sxml`
- 辅助注解：`org.jetbrains/annotations`

## 关于
作者：廖浩龙（Liao Haolong）  
邮箱：An_Night@qq.com
***
Copyright (C) 2021 Liao Haolong.