Skip to content

Commit 25107be

Browse files
authored
Update README.md
1 parent 5dda152 commit 25107be

File tree

1 file changed

+67
-47
lines changed

1 file changed

+67
-47
lines changed

README.md

Lines changed: 67 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,97 @@
1-
# AxTBot-v2
2-
3-
4-
## 许可 | LICENSE
51

6-
> "本代码采用AGPLv3授权。**禁止任何企业直接使用此代码于商业产品/服务**
7-
> 但欢迎开发者:
8-
> - ✅ 学习代码思路
9-
> - ✅ 用独立代码实现类似功能(无论是否开源)
10-
> - ✅ 非商业场景下使用/修改本代码
11-
> 企业需商业使用?请联系作者获取例外许可。"
2+
# AxTBot-v2
123

13-
*注意:独立实现指未引用本项目中任何源代码,且未侵犯著作权的新创作。*
4+
一个基于 Python 的可扩展 Bot 框架。
5+
📖 完整文档请访问:[AxTBot-v2 | AxT Docs](https://docs.axtn.net/AxTBot-v2/)
146

15-
<br />
7+
---
168

17-
## 使用文档 | Usage
18-
- [AxTBot-v2 | AxT Docs](https://docs.axtn.net/AxTBot-v2/)
9+
## 📜 许可 | License
1910

20-
## Hypixel查询注意事项:
21-
Hypixel查询是基于 **[Spelako](https://github.com/Spelako)** 项目修改而来<br>
22-
此存库**只提供用于启动PHP服务器API接口的代码**,其他代码请到原存库进行获取<br>
11+
> 本项目采用 **AGPLv3** 协议授权。
12+
> **禁止任何企业直接将本代码用于商业产品或服务。**
13+
> 但欢迎以下行为:
14+
>
15+
> * ✅ 学习代码思路
16+
> * ✅ 独立实现类似功能(无论是否开源)
17+
> * ✅ 在非商业场景下使用或修改本项目
18+
>
19+
> 若企业希望商业使用,请联系作者获取**例外许可**
20+
>
21+
> *注:独立实现指未引用本项目任何源代码,且未侵犯著作权的新创作品。*
2322
24-
### API使用方法:<br>
25-
1.``SpelakoCore`` 文件夹和 ``index.php`` 放在同目录下<br>
26-
2. 使用 ``start.bat`` 启动即可(Linux自行编写启动脚本)
27-
3. 默认启动在 ``0.0.0.0:30001`` ,如果端口被占用,请修改启动脚本中的端口号<br>
23+
---
2824

29-
<br />
25+
## ⚡ 快速开始 | Quick Start
3026

31-
## 快速开始 | Quick Start
27+
### 1️⃣ 下载源码
3228

33-
1. 下载源码
29+
```bash
30+
git clone https://github.com/AxT-Team/AxTBot.git
31+
```
3432

35-
2. 创建虚拟环境(可选)
33+
### 2️⃣ 创建虚拟环境(可选)
3634

37-
在控制台中输入如下命令创建venv虚拟环境
3835
```bash
39-
D:\AxTBot> py -m venv <文件夹名>
36+
py -m venv .venv
37+
.venv\Scripts\Activate
4038
```
4139

42-
3. 安装依赖
40+
### 3️⃣ 安装依赖
4341

44-
如果你使用venv虚拟环境,那么在venv虚拟环境中安装依赖
4542
```bash
46-
D:\AxTBot> <虚拟环境文件夹>\Scripts\Activate
47-
(venv) D:\AxTBot> pip install -r requirements.txt
43+
pip install -r requirements.txt
4844
```
4945

50-
4. 配置
46+
### 4️⃣ 配置环境变量
47+
48+
`.env.example` 重命名为 `.env`,并填写你的机器人配置。
5149

52-
`.env.example`文件重命名为`.env` 并填入机器人相关信息
50+
### 5️⃣ 启动 Bot
5351

54-
5. 运行
5552
```bash
56-
(venv) D:\AxTBot> py main.py
53+
py main.py
5754
```
5855

59-
## 注意事项 | Attention
60-
1. 日志并非即时更改,所以框架刚开机时日志文件为空,将在后续版本中解决该问题
56+
---
57+
58+
## 🔧 快速开发 | Developer Guide
59+
60+
> 没错!现在你可以为你的 Bot 自行开发插件 ✨
61+
62+
开发指南请访问:[快速开发 - AxTBot-v2 | AxT Docs](https://docs.axtn.net/AxTBot-v2/Developer/)
63+
64+
---
65+
66+
## ⚠ 注意事项 | Attention
67+
68+
1. 当前日志模块并非实时记录,首次启动时日志文件可能为空。该问题将在未来版本修复。
69+
2. 目前每次接收消息都会重新加载插件,可能带来性能负担,未来版本将优化此行为。
70+
71+
---
72+
73+
## 🏷️ 其他版本迁移
74+
75+
* 旧版本(基于 `qq-botpy` + WebSocket):
76+
77+
* [https://github.com/AxT-Team/AxTBot/blob/AxTBot-v1](https://github.com/AxT-Team/AxTBot/blob/AxTBot-v1)
78+
79+
* Mirai & CQ 版(已存档的上古时期ATBot仓库):
80+
81+
* [https://github.com/XiaoXianHW/ATBot](https://github.com/XiaoXianHW/ATBot)
82+
* [https://github.com/AxT-Team/Ebackup](https://github.com/AxT-Team/Ebackup)
6183

62-
2. 由于设定问题,目前每次接收消息后均会reload一次插件,可能导致不必要的性能开销,将在未来的版本中解决该问题
84+
---
6385

64-
## 快速开发 | Develop
86+
## [扩展] Hypixel 查询模块 (原仓库目前已关闭,暂不提供支持)
6587

66-
本节详阅[快速开发 - AxTBot-v2 | AxT Docs](https://docs.axtn.net/AxTBot-v2/Developer/)
88+
本项目中的 Hypixel 查询功能基于 [Spelako](https://github.com/Spelako) 项目进行修改。
89+
**本仓库仅提供用于启动 PHP 服务器 API 接口的相关代码,其他功能请前往原仓库查看。**
6790

68-
*你没看错,新框架允许你自己开发插件供你自己机器人使用了(*
91+
### 🚀 启动 API 的方法:
6992

70-
<hr>
93+
1.`SpelakoCore` 文件夹与 `index.php` 放置在同一目录中
94+
2. 运行 `start.bat` 启动服务(Linux 用户请自行编写启动脚本)
95+
3. 默认监听地址为 `0.0.0.0:30001`,如端口被占用请修改启动脚本中的端口设置
7196

72-
## Mirai&CQ版本已转移到以下存库(内部号)
73-
- https://github.com/XiaoXianHW/ATBot
74-
- https://github.com/AxT-Team/Ebackup
7597

76-
## 旧版本(基于qq-botpy + Websocket所写的)
77-
- https://github.com/AxT-Team/AxTBot/blob/AxTBot-v1

0 commit comments

Comments
 (0)