PHPackages                             kj415j45/kjbot - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. kj415j45/kjbot

AbandonedArchivedProject[Framework](/categories/framework)

kj415j45/kjbot
==============

kjBot Framework and Modules

2.7.1(7y ago)36764[6 issues](https://github.com/kj415j45/kjBot/issues)[1 PRs](https://github.com/kj415j45/kjBot/pulls)(MIT and AGPL-3.0-or-later)PHPPHP ^7.2

Since Jun 14Pushed 6y ago6 watchersCompare

[ Source](https://github.com/kj415j45/kjBot)[ Packagist](https://packagist.org/packages/kj415j45/kjbot)[ RSS](/packages/kj415j45-kjbot/feed)WikiDiscussions master Synced today

READMEChangelog (10)Dependencies (8)Versions (35)Used By (0)

kjBot [![Maintainability](https://camo.githubusercontent.com/dea132f7adf6a7e3f1ff414f76b5b2104394a89d872103a5f679234375a20d09/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f34623164393264613739346133353533383831322f6d61696e7461696e6162696c697479)](https://codeclimate.com/github/kj415j45/kjBot/maintainability) [![Latest Stable Version](https://camo.githubusercontent.com/052b8f4216347ae499837ed17e22aa25b1b404bbcd16edd9e5e97939df1f18fd/68747470733a2f2f706f7365722e707567782e6f72672f6b6a3431356a34352f6b6a626f742f762f737461626c65)](https://packagist.org/packages/kj415j45/kjbot) [![Total Downloads](https://camo.githubusercontent.com/8cf8555d4b9e4211043604cd07cb2b22954251bea02f07b2628c3d9599ccd8b5/68747470733a2f2f706f7365722e707567782e6f72672f6b6a3431356a34352f6b6a626f742f646f776e6c6f616473)](https://packagist.org/packages/kj415j45/kjbot) [![License](https://camo.githubusercontent.com/03e9dcf02c0beb2de1f7a63c1c69f4e06e7399a5bbf17ac9b2ddeea29701a1c5/68747470733a2f2f706f7365722e707567782e6f72672f6b6a3431356a34352f6b6a626f742f6c6963656e7365)](https://packagist.org/packages/kj415j45/kjbot) [![kjBot Dev 群](https://camo.githubusercontent.com/75b53e353bb9e5064662e185a6d39f4bb88c4e45bd3a1240ddf599525edb6afa/68747470733a2f2f7075622e69647171696d672e636f6d2f7770612f696d616765732f67726f75702e706e67)](https://jq.qq.com/?_wv=1027&k=5ZDksTi) [![开始与 kjBot 聊天](https://camo.githubusercontent.com/32ecd6532d8cf0d84b9f6eba2f7bb4e368314086b16ca6be6518cac31acd89f2/687474703a2f2f7770612e71712e636f6d2f70613f703d323a323833393039383839363a3431)](http://wpa.qq.com/msgrd?v=3&uin=2839098896&site=qq&menu=yes)
==========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================

[](#kjbot------)

kjBot 是一个轻量级多功能的酷Q机器人框架。

**警告：本项目面向过程编写。**

项目已重构， [点击查看](https://github.com/kjBot-Dev/framework)
-----------------------------------------------------

[](#项目已重构-点击查看)

框架结构
----

[](#框架结构)

```
/
|--SDK/ #kjBot\SDK
|--public/
    |--tools/ #各类开放函数的文件
    |--index.php #入口文件
    |--init.php #初始化用
    |......
|--vendor/ #包目录
|--storage/ #请确保运行 PHP 的用户具有这个文件夹的写权限
    |--data/ #数据文件夹
        |--error.log #如果出现异常未捕获则会在此存放日志
        |......
    |--cache/ #缓存文件夹
|--middleWare/ #中间件，用于处理非命令
    |--Chain.php #中间件链，用于调整中间件顺序以及启用状态
    |--......
|--module/ #在这里开始编写你的模块吧 :)
    |--......
|--config.ini.example #配置文件样例，本地部署时请复制为 config.ini 并根据实际情况调整
|--build.sh #进行环境配置
|--run.sh #一键部署（大概 :v

```

上手
--

[](#上手)

### 快速安装

[](#快速安装)

如果你安装有 composer

```
mkdir kjBot/
composer create-project --no-dev kj415j45/kjbot ./kjBot
cd kjBot/
php build.php
```

如果没有

```
git clone https://github.com/kj415j45/kjBot.git
cd kjBot/
php build.php
```

打开 `config.ini`，根据你的实际情况修改。

如果你需要试用 kjBot 的全部功能，请继续运行 `php composer.phar install`

仅作为框架使用时，在确保 module 与 middleWare 文件夹下没有你的文件后：`composer run-script framework-only`

### 入门

[](#入门)

`public/init.php` 中存在一个全局变量区供编写模块的程序员使用，约定本框架产生的全局变量均为大写字母开头。
`public/tools/` 下的文件将为框架扩展各类方法，请仔细阅读。

### 编写第一个模块

[](#编写第一个模块)

假定该模块为 `hello/main.php` ，向 bot 发送 `!hello` 即可触发该模块。

```