nonebot-plugin-what2eat 0.3.6
Ask bot for what to eat or what to drink!
License: MIT
Requires Python: >=3.8,<4.0
Keywords: nonebot2,nonebot-plugin,What2eat,What2drink,MinatoAquaCrews

<div align="center">
    <img width="200" src="starving_logo.gif" alt="logo">

# What to Eat/Drink

_🧃🧋🍔🌮🍜🍮🍣🍻🍩 今天吃/喝什么 🍩🍻🍣🍮🍜🌮🍔🧋🧃_

</div>

<p align="center">

  <a href="https://github.com/MinatoAquaCrews/nonebot_plugin_what2eat/blob/master/LICENSE">
    <img src="https://img.shields.io/github/license/MinatoAquaCrews/nonebot_plugin_what2eat?color=blue">
  </a>

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

  <a href="https://github.com/MinatoAquaCrews/nonebot_plugin_what2eat/releases/tag/v0.3.6">
    <img src="https://img.shields.io/github/v/release/MinatoAquaCrews/nonebot_plugin_what2eat?color=orange">
  </a>

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

  <a href="https://github.com/MinatoAquaCrews/nonebot_plugin_what2eat">
    <img src="https://img.shields.io/pypi/dm/nonebot_plugin_what2eat">
  </a>

  <a href="https://results.pre-commit.ci/latest/github/MinatoAquaCrews/nonebot_plugin_what2eat/master">
	<img src="https://results.pre-commit.ci/badge/github/MinatoAquaCrews/nonebot_plugin_what2eat/master.svg" alt="pre-commit.ci status">
  </a>

</p>

## 版本

[v0.3.6](https://github.com/MinatoAquaCrews/nonebot_plugin_what2eat/releases/tag/v0.3.6)

⚠ 适配nonebot2-2.0.0rc1+

##

1. 通过 `pip` 或 `nb` 安装；

2. 数据默认位于插件的 `./resource` 下 `eating.json`、`drinks.json` 与 `greetings.json`，菜品的附图储存于`./resource/img`下。可通过设置 `env` 下 `WHAT2EAT_PATH` 更改资源的路径：

   ```python
   WHAT2EAT_PATH="your-path-to-resource"
   ```

## 功能

1. 🔥 选择恐惧症？让Bot建议你今天吃/喝什么！

   👉 新增**鸳央咖啡**菜单！

2. **插件配置**

   ```python
   WHAT2EAT_PATH="your-path-to-resource"           # 资源路径
   EATING_LIMIT=5                                  # 每个时段吃/喝什么次数上限，默认5次；每日6点、11点、17点、22点自动刷新
   GREETING_GROUPS_ID=["123456789", "987654321"]   # 默认开启小助手的群组，或{"123456789", "987654321"}
   WHAT2EAT_AUTO_UPDATE=false                      # 启动时是否自动更新文本资源，默认关闭
   ```

3. 群管理可自行添加或移除群特色菜单（位于 `eating.json` 下 `[group_food][group_id]` ）；超管可添加或移除基础菜单（ `[basic_food]` ）；

   - 菜品**文字与配图一一对应**才视为相同的菜品，例如：文字相同而配图不同、文字与文字+配图、或文字不同而配图相同，这几种均视为不同菜品

   - 当移除的菜品包含配图时，会一并移除相同配图的其他菜品

   - 各群特色菜单相互独立；各群每个时间段询问Bot建议次数独立；Bot会综合各群菜单+基础菜单给出建议；

4. 吃饭小助手：每天7、12、15、18、22点群发问候语提醒群友吃饭/摸鱼/下班，`GREETING_GROUPS_ID` 以设置常开的群号列表，形如：

   ```python
   GREETING_GROUPS_ID=["123456789", "987654321"]	# 名字长防止与其他插件配置名相同
   ```

   ⚠ 群吃饭小助手启用配置存于 `greetings.json` 的 `groups_id` 字段

5. `WHAT2EAT_AUTO_UPDATE` 默认关闭，若开启，则插件在启动时自动更新文本资源，并尝试从仓库中下载 `eating.json`、`drinks.json`，并与本地对应的文本资源**合并**（若本地不存在，则保存至本地）。

   ```python
   WHAT2EAT_AUTO_UPDATE=false
   ```

   ⚠ 使用 `raw.fgit.ml` 进行下载，不确保次次成功

## 命令

1. 吃什么：今天吃什么、中午吃啥、今晚吃啥、中午吃什么、晚上吃啥、晚上吃什么、夜宵吃啥……

2. 🔥 喝什么：今天喝什么、中午喝啥、今晚喝啥、中午喝什么、晚上喝啥、晚上喝什么、夜宵喝啥……

   ⚠ 与吃什么共用 `EATING_LIMIT` 次数

3. [管理员或超管] 添加或移除群菜名：[添加/移除 菜名]；

   💥 添加菜品与加菜可以附配图啦！

4. 查看群菜单：[菜单/群菜单/查看菜单]；

5. [超管] 添加至基础菜单：[加菜 菜名]；

6. 查看基础菜单：[基础菜单]；

7. [管理员或超管] 开启/关闭吃饭小助手：[开启/启用/关闭/禁用小助手]；

8. [管理员或超管] 添加/删除吃饭小助手问候语：[添加/删除/移除问候 时段 问候语]；

   ⚠ 添加/移除问候操作可一步步进行，或一次性输入两或三个命令；可中途取消操作

## 效果

1. 示例1

   Q：今晚吃什么

   A：建议肯德基

   Q：今晚喝啥

   A：不如来杯 茶颜悦色 的 幽兰拿铁 吧！

   Q：今晚吃什么

   A：你今天已经吃得够多了！

   Q：群菜单

   A：

   ---群特色菜单---

   alpha

   beta

   gamma

2. 示例2

   [群管] Q：添加 派蒙

   A：派蒙 已加入群特色菜单~

   [超管] Q：加菜 东方馅挂炒饭

   A：东方馅挂炒饭 已加入基础菜单~

   [群管] Q：移除 东方馅挂炒饭

   A：东方馅挂炒饭 在基础菜单中，非超管不可操作哦~

3. 示例3

   [群管] Q：添加问候

   A：请输入添加问候语的时段，可选：早餐/午餐/摸鱼/晚餐/夜宵，输入取消以取消操作

   [群管] Q：摸鱼

   A：请输入添加的问候语，输入取消以取消操作

   [群管] Q：你好

   A：你好 已加入 摸鱼问候~

## 本插件改自

[HoshinoBot-whattoeat](https://github.com/pcrbot/whattoeat)

部分菜名参考[程序员做饭指南](https://github.com/Anduin2017/HowToCook)