Skip to content

Commit

Permalink
Merge pull request #5 from MinatoAquaCrews/dev-v0.3.x
Browse files Browse the repository at this point in the history 
v0.3.0
  • Loading branch information
@KafCoppelia
KafCoppelia authored Aug 30, 2022
2 parents 67cede8 + 764a65f commit 2806306
Show file tree
Hide file tree
Showing 10 changed files with 1,543 additions and 966 deletions.
184 changes: 117 additions & 67 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,63 +10,113 @@ _🌈 おはよう！ 🌈_
</div>
<p align="center">

<a href="https://github.com/KafCoppelia/nonebot_plugin_morning/blob/beta/LICENSE">
<img src="https://img.shields.io/badge/license-MIT-informational">
<a href="https://github.com/MinatoAquaCrews/nonebot_plugin_morning/blob/beta/LICENSE">
<img src="https://img.shields.io/github/license/MinatoAquaCrews/nonebot_plugin_morning?color=blue">
</a>

<a href="https://github.com/nonebot/nonebot2">
<img src="https://img.shields.io/badge/nonebot2-2.0.0beta.2-green">
<img src="https://img.shields.io/badge/nonebot2-2.0.0b3+-green">
</a>

<a href="">
<img src="https://img.shields.io/badge/release-v0.2.2-orange">
<a href="https://github.com/MinatoAquaCrews/nonebot_plugin_morning/releases/tag/v0.3.0">
<img src="https://img.shields.io/github/v/release/MinatoAquaCrews/nonebot_plugin_morning?color=orange&include_prereleases">
</a>

</p>

<a href="https://www.codefactor.io/repository/github/MinatoAquaCrews/nonebot_plugin_morning">
<img src="https://img.shields.io/codefactor/grade/github/MinatoAquaCrews/nonebot_plugin_morning/main?color=red">
</a>

</p>

## 版本

v0.2.2
v0.3.0

⚠ 适配nonebot2-2.0.0beta.2；
⚠ 适配nonebot2-2.0.0beta.3+

👉 适配alpha.16版本参见[alpha.16分支](https://github.com/KafCoppelia/nonebot_plugin_morning/tree/alpha.16)

[更新日志](https://github.com/KafCoppelia/nonebot_plugin_morning/releases/tag/v0.2.2)
[更新日志](https://github.com/MinatoAquaCrews/nonebot_plugin_morning/releases/tag/v0.3.0)

## 安装

1. 通过`pip`或`nb`安装，版本指定`0.2.2`；
1. 通过`pip`或`nb`安装；

2. 用户数据`data.json`及早晚安配置文件`config.json`位于`./resource`下，可在`env`内设置`MORNING_PATH`更改：

```python
MORNING_PATH="your-path-to-resource"
``` python
MORNING_PATH="path-to-your-resource" # For example: ./my_data/morning_resource/
```

## 功能

1. 和Bot说早晚安，记录睡眠时间，培养良好作息；

2. 群管及超管可设置早安时限、晚安时限、优质睡眠、深度睡眠等；
2. 群管及超管可设置早安时限、晚安时限、优质睡眠、深度睡眠等，参见规则配置；

3. 🔥 **重磅更新** 分群管理群友作息，群友的早晚安数据会记录至`morning.json`内，形如：

``` python
{
"123456789": { # 群号
"group_count": { # 群统计
"daily": {
"good_morning": 1, # 群每日早安人数
"good_night": 1 # 群每日晚安人数
},
"weekly": {
"sleeping_king": "123456" # 群上周睡觉大王
}
},
# 群友个人作息统计
"123456": { # 群友QQ号
"daily": {
"morning_time": "2022-01-01 07:08:09", # 每日早安时间
"night_time": "2022-01-01 22:33:44" # 每日晚安时间
},
"weekly": {
"weekly_morning_count": 1, # 周早安天数
"weekly_night_count": 1, # 周晚安天数
"weekly_sleep": [0, 7, 8, 9], # 周睡眠时长，列表形式：天/时/分/秒，例如0天7时8分9秒
"lastweek_morning_count": 1, # 上周早安天数（暂存）
"lastweek_night_count": 1, # 上周晚安天数（暂存）
"lastweek_sleep": [0, 7, 8, 9], # 上周睡眠时长（暂存）
"lastweek_earliest_morning_time": 0, # 上周早安最早的时间（暂存）
"lastweek_latest_night_time": 0 # 上周晚安最晚的时间（暂存）
},
"total": {
"morning_count": 1, # 总早安次数
"night_count": 1, # 总晚安次数
"total_sleep": [0, 7, 8, 9] # 总睡眠时间
}
}
}
}
```

👉 说明：

1. 个人信息字段的`daily`储存每日作息数据；`weekly`储存每周作息数据，`lastweek_`前缀的数据为上周的“每周作息数据”，即暂存上周作息数据；`total`为总作息数据；

2. 在**每周一的最晚早安时间**定时更新，在周一且当天**最晚早安时间**后，`群友作息`与`我的作息`将增加有关上周作息数据的信息（包括`lastweek_`前缀的数据与群信息字段中的`weekly`数据，目前仅有上周睡觉大王）；

4. **新增** 将自动更新`v0.2.x`的数据文件`data.json`为新版`morning.json`；将自动更新`v0.2.x`的配置文件`config.json`部分键值。在插件初始化时，若不存在新版数据文件且存在旧版数据文件`data.json`，则更新数据字段、保留原始数据，否则创建空的新版数据文件。

⚠ 若存在新版数据文件`morning.json`，则不会重复更新

3. 分群管理群友作息；
⚠ 自动检测配置文件`config.json`的部分键值是否为旧版并自动更新，后续版本将弃用该部分兼容

4. おはよう！🌈
5. おはよう！🌈

## 命令

1. 早晚安：早安/晚安，记录睡眠时间；
1. 早晚安：[早安/晚安]，记录睡眠时间；

2. 查看我的作息：我的作息；
2. **新增** 查看我的作息：[我的作息]：每周一新增显示上周睡眠信息统计，其他时间显示本周信息；

3. 查看群友作息：群友作息，看看今天几个人睡觉或起床了；
3. **新增** 查看群友作息：[群友作息]，看看今天几个群友睡觉或起床了，每周一新增显示上周睡觉王；

4. 查看配置当前安晚安规则：早晚安设置；
4. 查看当前安早晚安配置（规则）：[早晚安设置]；

5. [群管或群主或超管] 设置命令
5. [管理员或超管] 设置命令

- 开启/关闭某个配置：早安/晚安开启/关闭某项功能；

Expand All @@ -76,87 +126,87 @@ v0.2.2

## 规则配置

`confg.json`文件已默认写入下述配置，当其不存在时则默认下载仓库的预置配置文件：
`confg.json`文件已默认写入下述配置，会自动检测旧版配置文件并自动更新，当其不存在时则创建并写入下述**初始值**：

```python
``` python
{
"morning": {
"get_up_intime": { # 是否只能在规定时间起床
"enable": true, # 默认开启，若关闭则下面两项无效
"early_time": 6, # 允许的最早的起床时间，默认早上6点
"late_time": 12 # 允许的最晚的起床时间，默认中午12点
"morning_intime": { # 是否只能在规定时间起床
"enable": true, # 默认开启，若关闭则下面两项无效
"early_time": 6, # 允许的最早的起床时间，默认早上6点
"late_time": 12 # 允许的最晚的起床时间，默认中午12点
},
"multi_get_up": { # 是否允许多次起床
"enable": false, # 默认不允许，若允许则下面一项无效
"interval": 6 # 两次起床间隔的时间，小于这个时间就不允许起床
"multi_get_up": { # 是否允许多次起床
"enable": false, # 默认不允许，若允许则下面一项无效
"interval": 6 # 两次起床间隔的时间，小于这个时间就不允许起床
},
"super_get_up": { # 是否允许超级亢奋
"enable": false, # 默认不允许，若允许则下面一项无效
"interval": 3 # 这次起床和上一次睡觉的时间间隔，小于这个时间就不允许起床，不怕猝死？给我睡！
"super_get_up": { # 是否允许超级亢奋，即睡眠时长很短
"enable": false, # 默认不允许，若允许则下面一项无效
"interval": 3 # 这次起床和上一次睡觉的时间间隔，小于这个时间就不允许起床，不怕猝死？给我睡！
}
},
"night": {
"sleep_intime": { # 是否只能在规定时间睡觉
"enable": true, # 默认开启，若关闭则下面两项无效
"early_time": 21, # 允许的最早的睡觉时间，默认晚上21点
"late_time": 6 # 允许的最晚的睡觉时间，默认次日早上6点
"night_intime": { # 是否只能在规定时间睡觉
"enable": true, # 默认开启，若关闭则下面两项无效
"early_time": 21, # 允许的最早的睡觉时间，默认晚上21点
"late_time": 6 # 允许的最晚的睡觉时间，默认次日早上6点
},
"good_sleep": { # 是否开启优质睡眠
"enable": true, # 默认开启，若关闭则下面一项无效
"interval": 6 # 两次睡觉间隔的时间，小于这个时间就不允许睡觉
"good_sleep": { # 是否开启优质睡眠
"enable": true, # 默认开启，若关闭则下面一项无效
"interval": 6 # 两次睡觉间隔的时间，小于这个时间就不允许睡觉
},
"deep_sleep": { # 是否允许深度睡眠
"enable": false, # 默认不允许，若允许则下面一项无效
"interval": 3 # 这次睡觉和上一次起床的时间间隔，小于这个时间就不允许睡觉，睡个锤子，快起床！
"deep_sleep": { # 是否允许深度睡眠，即清醒时长很短
"enable": false, # 默认不允许，若允许则下面一项无效
"interval": 3 # 这次睡觉和上一次起床的时间间隔，小于这个时间就不允许睡觉，睡个锤子，快起床！
}
}
}
```
```

1. 默认配置（如上）

- 早安：

是否要求规定时间内起床：是
是否要求规定时间内起床：是

是否允许连续多次起床：否
是否允许连续多次起床：否

是否允许超级亢奋(即睡眠时长很短)：否
是否允许超级亢奋(即睡眠时长很短)：否

- 晚安：

是否要求规定时间内睡觉：是
是否要求规定时间内睡觉：是

是否开启优质睡眠：是
是否开启优质睡眠：是
是否允许深度睡眠(即清醒时长很短)：否
是否允许深度睡眠(即清醒时长很短)：否

2. 早安配置

- [早安开启 xx] 开启某个配置选项，xx可选值目前有 [时限 / 多重起床 / 超级亢奋]；
- [早安开启 xx] 开启某个配置选项，配置项有：时限/多重起床/超级亢奋；例如，[早安开启 多重起床]；

- [早安关闭 xx] 关闭某个配置选项，xx可选值目前有 [时限 / 多重起床 / 超级亢奋]；
- [早安关闭 xx] 关闭某个配置选项，配置项有：时限/多重起床/超级亢奋；例如，[早安关闭 时限]；

- [早安设置 xx x] 设置某个配置的参数，xx可选值目前有 [时限 / 多重起床 / 超级亢奋]，x可选值为0到24的整数；
- [早安设置 xx x] 设置某个配置的参数，配置项有：时限/多重起床/超级亢奋；（x可选值为0到24的整数）

※ 当设置时限时需要两个参数，命令为：[早安设置 时限 x y]，当不是时限时只需一个参数，命令为：[早安设置 xx x]
⚠ 配置参数时，可一次性输入规定的参数，也可通过引导一步步设置
⚠ 当**设置时限**时需要两个参数，命令为：[早安设置 时限 x y]，其余只需一个参数，例如，[早安设置 超级亢奋 5]

⚠ 配置项具体含义参见上述规则配置
⚠ 当配置某个选项时，会自动启用该选项

3. 晚安配置

- [晚安开启 xx] 开启某个配置选项，xx可选值目前有 [时限 / 优质睡眠 / 深度睡眠]；
- [晚安开启 xx] 开启某个配置选项，配置项有：时限/优质睡眠/深度睡眠；例如，[晚安开启 优质睡眠]；

- [晚安关闭 xx] 关闭某个配置选项，xx可选值目前有 [时限 / 优质睡眠 / 深度睡眠]；
- [晚安关闭 xx] 关闭某个配置选项，配置项有：时限/优质睡眠/深度睡眠；例如，[晚安关闭 深度睡眠]；

- [晚安设置 xx x] 设置某个配置的参数，xx可选值目前有 [时限 / 优质睡眠 / 深度睡眠]，x可选值为0到24的整数；
- [晚安设置 xx x] 设置某个配置的参数，配置项有：时限/优质睡眠/深度睡眠；（x可选值为0到24的整数）

※ 当设置时限时需要两个参数，命令为：[晚安设置 时限 x y]，当不是时限时只需一个参数，命令为：[晚安设置 xx x]
⚠ 注意事项参考早安配置

## 本插件改自

[hoshinobot-good_morning](https://github.com/azmiao/good_morning)

1. 修改代码结构；

2. 修改部分配置名称、功能，修改群组数据储存格式；

3. 参考并修改配置部分README；
[hoshinobot-good_morning](https://github.com/azmiao/good_morning)
Loading

0 comments on commit 2806306

Please sign in to comment.