Merge upstream

.dockerignore

@@ -0,0 +1,2 @@
+*.pyc
+__pycache__

.github/workflows/image.yml

@@ -0,0 +1,50 @@
+name: Docker Image
+
+on:
+  push:
+    paths:
+      - ".github/workflows/image.yml"
+      - "docker/Dockerfile"
+      - "chatbridge/**"
+      - "lang/**"
+      - "__main__.py"
+      - "LICENSE"
+      - "mcdreforged.plugin.json"
+      - "**/requirements.txt"
+
+jobs:
+  image:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: fallenbreath
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            fallenbreath/chatbridge
+          tags: |
+            type=ref,event=branch
+            type=semver,pattern={{version}}
+
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          platforms: 'linux/amd64'
+          file: ./docker/Dockerfile
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/package.yml

@@ -0,0 +1,43 @@
+name: CI for MCDR Plugin
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  package:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Setup python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.9
+
+    - uses: actions/cache@v4
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+
+    - name: Pack Plugin
+      run: |
+        python -m mcdreforged pack -o ./package
+
+    - uses: actions/upload-artifact@v4
+      with:
+        name: Chatbridge distribution for ${{ github.sha }}
+        path: package/
+
+    - name: Publish distribution to release
+      if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+      uses: softprops/action-gh-release@v2
+      with:
+        files: package/*.pyz

.gitignore

@@ -4,11 +4,13 @@
 test.py
 *.log
 *.pyc
-/__pycache__
+__pycache__
 StatsHelper.py
 /stats_helper
 /more_apis
 *.zip
 *.mcdr
 *.pyz
+*.bat
+*.sh
 ChatBridge_*.json

README.md

@@ -4,7 +4,22 @@
 
 See [here](https://github.com/TISUnion/ChatBridge/tree/v1) for chatbridge v1. **NOT compatible with Chatbridge v1**
 
-![topomap](https://raw.githubusercontent.com/TISUnion/ChatBridge/master/topomap.png)
+```mermaid
+flowchart LR
+    subgraph Minecraft Host
+    mcdr1("ChatBridge Client (MCDR plugin)")<--MCDR-->smp[Minecraft Surival Server]
+    mcdr2("ChatBridge Client (MCDR plugin)")<--MCDR-->cmp[Minecraft Creative Server]
+    mcdr3("ChatBridge Client (MCDR plugin)")<--MCDR-->smpc[Minecraft Mirror Server]
+    online("ChatBridge Online Command Client")<--RCON-->bc[Bungeecord Server]
+    end
+
+    server(["ChatBridge Server"])
+    server<-->mcdr1 & mcdr2 & mcdr3 & online
+    server<-->cli_client("CLI Client")<-.->user[/User/]
+    server<-->cq_client("ChatBridge CQHttp Client")<-->cqhttp[CQ Http bot]-.-QQ
+    server<-->khl_client("ChatBridge Khl Client")<-->khl["Kaiheila (Kook)"]
+    server<-->discord_client("ChatBridge Discord Client")<-->Discord
+```
 
 ## Disclaimer
 
@@ -14,11 +29,12 @@ ChatBridge is mainly for custom use of TIS server, especially the bot/command co
 - Discord client
 - Kaiheila client
 - Online command client
+- ...
 
-Therefore for these bot and related clients:
+Therefore, for these bot and related clients:
 
 - Expect hardcoded constants in codes and lack of document/usage/support
-- PRs for features will not be accepted, related issues will probably be ignored
+- PRs for features will not be accepted, issues complaining something don't work will probably be ignored. No after-sales support
 - If you want more features, fork this repository and implement them yourself
 
 But the basic chatbridge components are within the support range, including:
@@ -27,12 +43,51 @@ But the basic chatbridge components are within the support range, including:
 - CLI server
 - MCDR plugin 
 
+## 免责声明
+
+ChatBridge 是一个为 TIS 服务器定制使用的工具，尤其是 bot/指令相关的组件：
+
+- CQHttp 客户端
+- Discord 客户端
+- Kaiheila 客户端
+- Online 指令客户端
+- ...
+
+因此，对于这些 bot 及相关的客户端：
+
+- 代码中将会包含若干硬编码常量，缺乏相关的文档/用法等支持
+- 功能方面的 PR 不会被接受，相关的 issue 大概率会被忽略，没有售后
+- 如果你想要更多的功能，建议你去 fork 这个仓库，然后自己实现
+
+但基本的 ChatBridge 组件都是在支持范围内，这包括：
+
+- CLI 客户端
+- CLI 服务端
+- MCDR 插件 
+
 ## Usage
 
 Enter `python ChatBridge.pyz` in command line to see possible helps
 
 At launch, if the configure file is missing, chatbridge will automatically generate a default one and exit
 
+## Docker Image
+
+[![Docker](https://img.shields.io/docker/v/fallenbreath/chatbridge/latest)](https://hub.docker.com/r/fallenbreath/chatbridge)
+
+Docker Hub image: [`fallenbreath/chatbridge`](https://hub.docker.com/r/fallenbreath/chatbridge)
+
+Image name examples:
+
+- `fallenbreath/chatbridge:latest`
+- `fallenbreath/chatbridge:v2.5.3`
+
+Working directory: `/app`
+
+Example usages: `docker run --rm fallenbreath/chatbridge:latest server`
+
+See the [./docker](docker) directory in the repository for more details and docker compose example
+
 ## Requirement
 
 Python 3.6+ required
@@ -94,6 +149,7 @@ Just put the `.pyz` file into the plugin folder
 Extra configure fields (compared to [CLI client](#cli-client))
 
 ```json5
+    "enable": true,  // for switching the functionality of the chatbridge plugin
     "debug": false,  // for switching debug logging on
 ```
 
@@ -104,7 +160,7 @@ Extra configure fields (compared to [CLI client](#cli-client))
 Extra requirements (also listed in `/chatbridge/impl/discord/requirements.txt`):
 
 ```
-discord.py
+discord.py>=2.0.0
 ```
 
 Extra configure fields (compared to [CLI client](#cli-client))
@@ -136,7 +192,6 @@ python ChatBridge.pyz cqhttp_bot
 Extra requirements (also listed in `/chatbridge/impl/cqhttp/requirements.txt`):
 
 ```
-websocket>=0.2.1
 websocket-client>=1.2.1
 ```
 
@@ -163,21 +218,47 @@ Extra configure fields (compared to [CLI client](#cli-client))
     "server_display_name": "TIS"  // The name of the server, used for display in some places
 ```
 
+## Client as a Satori client
+
+```
+python ChatBridge.pyz cqhttp_bot
+```
+
+Extra requirements (also listed in `/chatbridge/impl/satori/requirements.txt`):
+
+```
+satori-python>=0.11
+```
+
+Just like the CoolqHttp client, but it uses satori protocol
+
+Extra configure fields (compared to [CLI client](#cli-client))
+
+```json5
+    "ws_address": "127.0.0.1",  // satori server address
+    "ws_port": 5500,            // satori server port
+    "ws_path": "",              // satori server optional path prefix
+    "satori_token": "xxxxx",    // satori access token
+    "react_channel_id": 12345,  // the target channel id (for QQ, it's the group id)
+    "chatbridge_message_prefix": "!!qq",
+    "client_to_query_stats": "MyClient1",  // it should be a client as an MCDR plugin, with stats_helper plugin installed in the MCDR
+    "client_to_query_online": "MyClient2",  // a client described in the following section "Client to respond online command"
+    "server_display_name": "TIS"  // The name of the server, used for display in some places
+```
+
 ## Kaiheila bot client
 
-`python ChatBridge.pyz kaiheila_bot`
+`python ChatBridge.pyz satori_bot`
 
 Extra requirements (also listed in `/chatbridge/impl/kaiheila/requirements.txt`):
 
 ```
-khl.py==0.0.10
+khl.py~=0.3.17
 ```
 
 Extra configure fields (compared to [CLI client](#cli-client))
 
 ```json5
-    "client_id": "",  // kaiheila client id
-    "client_secret": "",  // kaiheila client secret
     "token": "",  // kaiheila token
     "channels_for_command": [  // a list of channels, public commands can be used here. use string
         "123400000000000000",

chatbridge/cli_entry.py

@@ -25,6 +25,11 @@ def cqhttp_bot():
 	entry.main()
 
 
+def satori_bot():
+	from chatbridge.impl.satori import entry
+	entry.main()
+
+
 def online_command():
 	from chatbridge.impl.online import entry
 	entry.main()
@@ -49,6 +54,7 @@ def main():
 		print('{} server: Start the ChatBridge server'.format(prefix))
 		print('{} discord_bot: Start a Discord bot as client'.format(prefix))
 		print('{} cqhttp_bot: Start a CQ-Http bot as client'.format(prefix))
+		print('{} satori_bot: Start a Satori bot as client'.format(prefix))
 		print('{} kaiheila_bot: Start a Kaiheila bot as client'.format(prefix))
-		print('{} online_command: Start a CQ-Http bot as client'.format(prefix))
+		print('{} online_command: Start a OnlineCommand bot as client'.format(prefix))
 

chatbridge/common/serializer.py

@@ -1,10 +1,15 @@
+from typing import TypeVar, Type
+
 from mcdreforged.api.utils.serializer import Serializable
 
+Self = TypeVar('Self', bound='NoMissingFieldSerializable')
+
 
 class NoMissingFieldSerializable(Serializable):
 	@classmethod
-	def deserialize(cls, data: dict, **kwargs):
+	def deserialize(cls: Type[Self], data: dict, **kwargs) -> Self:
 		kwargs.setdefault('error_at_missing', True)
+		# noinspection PyTypeChecker
 		return super().deserialize(data, **kwargs)
 
 	@classmethod