weather

README

MiraiGo-module-weather

ID: com.aimerneige.weather

Module for MiraiGo-Template

功能

• 在群聊或私聊接收到「实时天气」时查询实时天气情况
• 在群聊或私聊接收到「出门建议」时查询当前天气是否适合出门
• 在群聊或私聊接收到「今天天气」时查询今天天气情况
• 在群聊或私聊接收到「明天天气」时查询明天天气情况
• 根据配置文件，定时在指定群聊发送今日/明日天气信息

管理员指令

• .weather.clear.times <uin> 清空用户调用次数
• .weather.blacklist.add <uin> 添加用户到黑名单
• .weather.blacklist.remove <uin> 从黑名单移除用户
• .weather.whitelist.add <uin> 添加用户到白名单
• .weather.whitelist.remove <uin> 从白名单移除用户
• .weather.allowed 添加群到许可名单
• .weather.disallowed 将群移除许可名单

使用方法

在适当位置引用本包

package example

imports (
    // ...

    _ "github.com/yukichan-bot-module/MiraiGo-module-weather"

    // ...
)

// ...

在你的 application.yaml 里填入配置：

aimerneige:
  weather:
    path: "./weather.yaml" # 配置文件路径，未设置默认为 `./weather.yaml`

编辑你的配置文件：

key: TAkhjf8d1nlSlspN # api key
limit: 10 # 每人每天访问次数上限
admin:
  - 1227427929 # 管理员帐号
allowed: # 群白名单，在允许列表里才会提供服务
  - 1149558764
  - 857066811
blacklist: # 黑名单用户（不提供服务）
  - 1781924496
whitelist: # 白名单用户（不受调用限制）
  - 1227427929
db:
  type: sqlite # mysql | sqlite
  mysql:
    username: root
    password: password
    host: localhost
    port: 3306
    database: example
    charset: utf8mb4
  sqlite:
    path: "./db/weather.db"
daily:
  - group: 857066811 # 群
    longitude: 116.407526 # 经度
    latitude: 39.90403 # 纬度
    time: 00:00 # 时间 (UTC 时区)
    type: today # today | tomorrow
    notify: "早上好啊！北京市今天天气：" # 提示语
  - group: 857066811
    longitude: 116.407526
    latitude: 39.90403
    time: 13:00
    type: tomorrow
    notify: "晚上好啊！北京市明天天气："

LICENSE

本项目使用 AGPLv3 协议开源，您可以在 GitHub 获取本项目源代码。为了整个社区的良性发展，我们强烈建议您做到以下几点：

• 间接接触（包括但不限于使用 Http API 或 跨进程技术）到本项目的软件使用 AGPLv3 开源
• 不鼓励，不支持一切商业使用

Documentation

Index

• Constants
• type Config

Constants

const DatabaseErrorMessage string = "数据库错误，请联系开发者修 bug。开源地址：https://github.com/yukichan-bot-module/MiraiGo-module-weather"

DatabaseErrorMessage 数据库错误信息

Types

type Config

type Config struct {
	Key       string  `yaml:"key"`
	Limit     int     `yaml:"limit"`
	Admin     []int64 `yaml:"admin"`
	Allowed   []int64 `yaml:"allowed"`
	BlackList []int64 `yaml:"blacklist"`
	WhiteList []int64 `yaml:"whitelist"`
	DB        struct {
		Type  string `yaml:"type"`
		MySQL struct {
			Username string `yaml:"username"`
			Password string `yaml:"password"`
			Host     string `yaml:"host"`
			Port     string `yaml:"port"`
			Database string `yaml:"database"`
			Charset  string `yaml:"charset"`
		} `yaml:"mysql"`
		SQLite struct {
			Path string `yaml:"path"`
		} `yaml:"sqlite"`
	} `yaml:"db"`
	Daily []struct {
		GroupCode int64   `yaml:"group"`
		Longitude float64 `yaml:"longitude"`
		Latitude  float64 `yaml:"latitude"`
		Time      string  `yaml:"time"`
		Type      string  `yaml:"type"`
		Notify    string  `yaml:"notify"`
	} `yaml:"daily"`
}

Config 模块配置