Code Monkey home page Code Monkey logo

kjbot's Introduction

kjBot Maintainability Latest Stable Version Total Downloads License kjBot Dev 群 开始与 kjBot 聊天

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

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

项目已重构, 点击查看

框架结构

/
|--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 即可触发该模块。

<?php

global $Queue; //从全局变量区中导入 $Queue 数组,该数组提供消息队列的功能

if(!fromGroup()){ //如果消息不是来自群聊
    $Queue[]= sendBack('Hello, world!'); //向消息队列尾插入一句 'Hello, world!',在哪收到就发到哪,此处只会在私聊中发送
}else{
    leave(); //从模块中退出,不再执行下面的语句
}

?>

编写更多模块

参考 module/ 文件夹下的其他模块

参与开发

感谢

LICENSE

kjBot 框架及 SDK 均为 MIT 协议。但是模块与中间件均为 AGPL 协议,如果您希望闭源开发,请不要使用该项目提供的模块和中间件。

kjbot's People

Contributors

baka-d avatar kj415j45 avatar lovelya72 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

kjbot's Issues

改正

创建者:734857163

复读几率太小

[From Bot]

该 Issue 由 Bot 通过 API 生成,创建者:1983879784

睿智

创建者:2387150649

🏇

创建者:1181948577

🐴

在框架中嵌入使用情况记录

创建者:919815238

通过记录用户的使用情况并进行分析,有助于开发者向用户提供更好的服务。
记录使用情况需要用户同意,用户如果同意才能收集相关信息,不同意时则只能记录到总计数器。
该功能将默认关闭并认为所有用户默认不同意

{操我}

创建者:1872671875

[雌和雄的机器人能生出机器人宝宝吗?]

[From Bot] 测试

该 Issue 由 Bot 通过 API 生成,创建者:919815238

knplabs/github-api测试

{卫修}

创建者:2087311304

[全群首富]

你好

创建者:2162266536

今天放假

[From Bot] 测试

该 Issue 由 Bot 通过 API 生成,创建者:919815238

knplabs/github-api测试

typo in filename

module/osu/templete.png 应为 module/osu/template.png .

google translate:
template 的翻译
名词
--
  | 模板 | template, templet, mouldboard
  | 型板 | template

{标题}

创建者:2833852702

[雌和雄的机器人能生出机器人宝宝吗?]

[From Bot]

该 Issue 由 Bot 通过 API 生成,创建者:1208674283

**死了

创建者:943898118

**死了

music

创建者:2111043373

获取群成员列表

创建者:1063614727

$CQ->getGroupMemberList 这个加群之后,必须要重启一下酷Q才能有效执行,否则获取不到,会导致整个功能崩溃

abc

创建者:2392158249

我想听歌

创建者:748108853

不能听歌了,显示无法打开谱面

{小涛}

创建者:2257953560

AD DELETED

改正

创建者:2831684695

复读几率太小

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.