Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wuqinqiang/helloword
Make learning English words more enjoyable, and make the world full of love 😊
https://github.com/wuqinqiang/helloword
Last synced: 2 months ago
JSON representation
Make learning English words more enjoyable, and make the world full of love 😊
- Host: GitHub
- URL: https://github.com/wuqinqiang/helloword
- Owner: wuqinqiang
- License: mit
- Created: 2023-02-06T13:35:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-03-08T12:50:43.000Z (over 1 year ago)
- Last Synced: 2024-06-20T00:32:23.462Z (4 months ago)
- Language: Go
- Homepage:
- Size: 999 KB
- Stars: 73
- Watchers: 2
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome - wuqinqiang/helloword - 03 star:0.1k fork:0.0k Make learning English words more enjoyable, and make the world full of love 😊 (Go)
README
# hello word
### 背景
Hello
Word是我在背单词的过程中想到的一个想法。在学习英语时，词汇量是非常重要的。仅仅死记硬背单词，没有语境感，效率是很低的。虽然一些应用程序可以根据单词的多个词义为单词组成一小段句子，稍微增强语境感。但是单词仍然过于零散。因此，我们是否可以将每天背诵的多个单词组合成一段小短文，以便复习这一批单词呢？这就是Hello
Word的初衷。当然，ChatGPT API是实现这个想法的工具。
除此之外，还配套了几个周边小游戏。
### 初始化
#### 环境变量
```shell
HELLO_WORD_PATH # 默认不配置在 ~/.helloword
```
#### 配置文件
配置文件在conf/conf.yml里。
```yaml
gptToken: "xx" #要使用短语推送功能这个是必须的！！！可以先注册openai,然后到platform.openai.com平台申请key
collector:
bbdc: # 不背单词cookie，配置了可以同步不背单词的生词表。
cookie:
# --------------------- Notification Configuration ---------------------
notify: # 通知配置，目前支持telegram，dingtalk，lark可以全配，那么所有平台都会推送一遍
# telegram:
# token: xxxxxxx # Bot Token
# chat_id: -123456789 # Channel / Group ID
# dingtalk:
# webhook: "https://oapi.dingtalk.com/robot/send?access_token=xxxx"
# secret: "" # sign secret if set
lark:
webhook: "xx"
```
#### 代理
由于众所周知的原因，所以你可能需要代理，
环境变量:
```dotenv
# socks5或者http
# etc.
PROXY_URI=socks5://ip:port
```
### 单词短语推送器
指定单词数量，随机选择单词，生成一段小短文，推送到用户指定平台。
```shell
./helloword daemon --files="CET4.txt,CET6.txt" --spec="@every 10s" --word-number=8 --c=conf.yml
```
**参数说明**
这个程序有以下可选项：
- files：默认导入 CET4.txt 单词文件，你可以通过逗号同时导入多个单词文件，它们都存储在 library 文件夹下。
- spec：表示推送频率设置，默认为每小时生成一个新的短语，具体时间规则使用的是 [robif/cron](https://github.com/robfig/cron)
库，请参考该库的文档自行设置。
- word-number：表示生成一次短语使用的单词数量，默认为 5 个，最多不超过 10 个
- strategy: 单词选择策略,默认随机random,还可选择 leastRecentlyUsed,最近最少被使用的单词
- conf: 可选，配置文件。具体配置信息如上
**单词选择规则**
- 默认:随机 (done)
- 最近最少推送(done)
### 指定单词，直接生成短语
```shell
./helloword phrase "approach,proportion,academy,weapon"
```
### 单词游戏
#### 单词接龙
**游戏规则**
这是一个单词接龙游戏，游戏开始时系统会随机选择一个单词。玩家需要以该单词的最后一个字母为开头输入一个新单词，接着程序又以玩家输入单词的最后一个字母为开头输出新单词。游戏会持续进行，直到有一方出现错误。在一局游戏中，每个单词只能被使用一次。
使用
```shell
./helloword games chain --files="CET4.txt,CET6.txt"
```
**参数说明**
- files 可选，如上
- timeout 可选，每一轮超过时间未答题游戏会结束，超时时间默认十秒
**后续规划**
- 单词正确性校验，是否是合法的英语单词(todo)
- 超时控制，用户每个回合指定时间内未输出，游戏结束(done)
#### 单词拼写(todo)
#### 单词填空(todo)