日麻寄分器(NoneBot插件)
Project description
<!-- markdownlint-disable MD033 MD036 MD041 -->
<p align="center">
<a href="https://v2.nonebot.dev/"><img src="https://v2.nonebot.dev/logo.png" width="200" height="200" alt="nonebot"></a>
</p>
<div align="center">
nonebot-plugin-mahjong-scoreboard
============
_✨ NoneBot 日麻记分器插件 ✨_
</div>
<p align="center">
<a href="https://raw.githubusercontent.com/ssttkkl/nonebot-plugin-sqlalchemy/master/LICENSE">
<img src="https://img.shields.io/github/license/ssttkkl/nonebot-plugin-sqlalchemy.svg" alt="license">
</a>
<a href="https://pypi.python.org/pypi/nonebot-plugin-mahjong-scoreboard">
<img src="https://img.shields.io/pypi/v/nonebot-plugin-mahjong-scoreboard.svg" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.9+-blue.svg" alt="python">
</p>
支持适配器:[OneBot V11](https://onebot.adapters.nonebot.dev/)
支持驱动器:[FastAPI](https://v2.nonebot.dev/docs/tutorial/choose-driver)
## 功能
为群友提供日麻对局分数记录。根据马点进行PT精算,统计PT增减,支持对局与榜单查询与导出。
PT精算算法为(点数-返点+马点)/1000,返点和马点在创建赛季时进行设置。
## 指令
### 对局
- `/新建对局 [四人南|四人东]`
- 别名:`/新对局`
- `/结算对局 <成绩> [对局<编号>] [@<用户>] [<自风>]`
- 别名:`/结算`
- `/撤销结算对局 [对局<编号>] [@<用户>]`
- 别名:`/撤销结算`
- `/设置对局PT <PT> [对局<编号>] [@<用户>]`
- 别名:`/对局PT`
- `/删除对局 [对局<编号>]`
- `/设置对局进度 <进度> [对局<编号>]`
- 别名:`/对局进度`
- `/设置对局备注 [对局<编号>] <对局备注>`
- 别名:`/对局备注`
与对局相关的指令可以省略对局编号,省略时默认对最近新建的对局进行操作。也可以通过回复Bot发出的对局消息来代替指定对局编号。
对局相关指令在对局完成超过24小时后需要拥有群主或管理员身份才能使用。(`/删除对局`除外,该指令需要拥有群主或管理员身份才能使用)
未完成且未设置进度的对局会在创建24小时后自动删除。赛季结束后,未完成对局会自动删除,所有已完成对局均无法再进行修改。
### 对局查询
- `/查询对局 [<编号>]`
- 别名:`/对局`
- `/个人最近对局 [@<用户>]`
- 别名:`/最近对局`
- `/群最近对局`
- `/个人未完成对局 [@<用户>]`
- 别名:`/未完成对局`
- `/群未完成对局`
- `/导出赛季对局 [<代号>]`
- 别名:`/导出对局`
- `/导出所有对局`
### 赛季
- `/查询赛季 [<代号>]`
- 别名:`/赛季`,`/当前赛季`
- `/查询所有赛季`
- 别名:`/所有赛季`
- `/新建赛季`
- 别名:`/新赛季`
- `/开启赛季 [<代号>]`
- `/结束赛季`
- `/删除赛季 [<代号>]`
### 赛季PT
- `/设置赛季PT <PT> [@<用户>]`
- 别名:`/设置PT`,`/设置赛季pt`,`/设置pt`
- `/查询PT [@<用户>]`
- 别名:`/PT`
- `/查询榜单`
- 别名:`/榜单`
- `/导出榜单`
与赛季/赛季PT相关的指令均可通过私聊/群聊两种方式使用。当未指定参数时进入问答模式,回复`/q`可退出问答模式。
与赛季/赛季PT相关的指令(查询、导出除外)需要拥有群主或管理员身份才能使用。
## 配置
### mahjong_scoreboard_database_conn_url
数据库连接URL,必须使用异步SQLAlchemy驱动器。
默认值:sqlite+aiosqlite:///mahjong_scoreboard.db
### mahjong_scoreboard_callback_host
回调HOST,若为非容器环境部署(go-cqhttp与nonebot均运行在同一环境)则保持默认值。若为Docker环境部署则设置为Docker容器名。用于上传文件时让go-cqhttp下载本机文件。
默认值:127.0.0.1
### mahjong_scoreboard_callback_port
回调端口,保持默认值即可。
默认值:与PORT保持一致即可
## LICENSE
> MIT License
>
> Copyright (c) 2022 ssttkkl
>
> Permission is hereby granted, free of charge, to any person obtaining a copy
> of this software and associated documentation files (the "Software"), to deal
> in the Software without restriction, including without limitation the rights
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
> copies of the Software, and to permit persons to whom the Software is
> furnished to do so, subject to the following conditions:
>
> The above copyright notice and this permission notice shall be included in all
> copies or substantial portions of the Software.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
> SOFTWARE.
>
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for nonebot_plugin_mahjong_scoreboard-0.1.7.post1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 44ff14aa6523530105cc329e74e6ed53156fdff82a8cca4c63bc217f6bd29d9b |
|
MD5 | 89f82123fa3ecaa6774bf094abf6e599 |
|
BLAKE2b-256 | 157ee338f371c25ac5d5b1ed51cb8135c3d5d7495e8c8ae9b9f0e01ffd32b48a |
Close
Hashes for nonebot_plugin_mahjong_scoreboard-0.1.7.post1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b75fa0c0c144d68f92d8fd6918d6be9bb1b3da2d5e368b1e6663fa53147197fd |
|
MD5 | 1a82daa7ef29a24eae6bf5abdbb172a3 |
|
BLAKE2b-256 | 7f0e5dfc4b64b3585eeb48deb44eae3e74103489383c1feb66ad03611402af8c |