[MD] # TMBot OneBot标准的TMBot插件加载框架（WebsocketClient） 推荐使用go-cqhttp配合使用 <!-- PROJECT SHIELDS --> [![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] <!-- PROJECT LOGO --> <br/> <p align="center"> <h3 align="center">OneBot标准的TMBot插件加载框架</h3> <p align="center"> 使用它去创造你的第一个机器人插件！ <br /> </a> <br /> <br /> <a href="[URL='https://github.com/shaojintian/Best_README_template']https://github.com/TMBotDev/TMBot[/URL]">查看仓库</a> · <a href="[URL='https://github.com/shaojintian/Best_README_template/issues']https://github.com/TMBotDev/TMBot/issues[/URL]">报告Bug</a> · <a href="[URL='https://github.com/shaojintian/Best_README_template/issues']https://github.com/TMBotDev/TMBot/issues[/URL]">提出新特性</a> </p> </p> ## 目录 - [上手指南](#上手指南) - [开发前的配置要求](#开发前的配置要求) - [安装步骤](#安装步骤) - [配置文件示例](#配置文件示例) - [文件目录说明](#文件目录说明) - [部署](#部署) - [使用到的框架](#使用到的框架) - [贡献者](#贡献者) - [如何参与开源项目](#如何参与开源项目) - [开发注意事项](#开发注意事项) - [版本控制](#版本控制) - [作者](#作者) - [鸣谢](#鸣谢) ### 上手指南 1. 前往Releases页面下载最新的TMBot正式版 2. 安装go-cqhttp或其他OneBot标准的机器人后端,设置为正向ws连接(go-cqhttp链接：[URL]https://github.com/Mrs4s/go-cqhttp[/URL]) 2. 启动start.bat(Linux使用start.sh)安装所需依赖 3. 启动框架，在/config/文件夹找到config.json,写入配置 4. 修改配置文件后，启动机器人 5. Enjoy it ;) #### 配置文件示例 ``` { "机器人一号": { // 节点名字，可自定义 "Websocket": "ws://11.451.419.198:10", // 填写你在机器人后端设置的正向ws地址和端口 "ReConnectCount": -1, // 重连次数限制，-1为无限重连 "ReConnectTime": 2 // 重连时间间隔 不可为-1 } } ``` #### 开发前的配置要求 1. 安装node.js(Linux上还要安装npm) 2. 使用start脚本安装框架所需依赖 3. 您还需要go-cqhttp或其他OntBot协议的机器人作为后端(go-cqhttp链接：[URL]https://github.com/Mrs4s/go-cqhttp[/URL]) #### **安装步骤** 1. 克隆这个仓库 ```sh git clone [URL]https://github.com/TMBotDev/TMBot/.git[/URL] ``` 2. 启动框架 ```sh ./start.sh //Windows为start.bat ``` 更详细的步骤请见[上手指南](#上手指南) ### 文件目录说明 ``` FileTree: ├── /config/ // TMBot总配置目录(不要往这里操作任何东西!) ├── LICENSE.txt // 这个项目的许可证 ├── README.md // 您正在阅读的这个文件 ├── modules // TMBot框架模块 ├── /plugins/ // TMBot插件加载目录(在这里创建插件) │ ├── /Data/ // TMBot插件数据目录 │ ├── xxx // 插件数据(最好每个创建都独立在Data目录创建一个文件夹，不要随意乱放) └── /tools/ //TMBot用到的小工具 ``` ### 部署 见[上手指南](#上手指南) ### 使用到的框架 暂无 ### 贡献者 请阅读**CONTRIBUTING.md** (现在没有) 查阅为该项目做出贡献的开发者。 #### 如何参与开源项目 贡献使开源社区成为一个学习、激励和创造的绝佳场所。你所作的任何贡献都是**非常感谢**的。 1. Fork 这个项目 2. 创建你的"Feature Branch",例如 (`git checkout -b feature/AmazingFeature`) 3. Commit你的更改 (`git commit -m 'Add some AmazingFeature'`) 4. 将更改推到你的分支上 (`git push origin feature/AmazingFeature`) 5. 开始PR #### 开发注意事项 此框架可以运行于LiteLoaderBDS与NodeJS上 #### 但是请要注意，在```NodeJS环境上运行```，根目录是直接作用于```项目目录的``` #### 而在```LiteLoaderBDS```上，根目录是作用于```BDS根目录```上的！ #### 所以可以使用 ```[FileClass.getStandardPath(<相对目录>)]``` 来获取作用于项目路径的绝对路径来避免此类BUG出现 #### ```TIPS: TMBot的基础接口实现已经全部使用了上述方法，所以可以直接传入作用于项目的相对路径``` ### 您还需要注意的是 1. TMBot已经为你写好了一些基础接口实现， 例如: ```tools/data: JsonConfigFileClass,IniConfigFileClass, tools/file: FileClass.readFrom, writeLine, createDir, delete, exists, copy, move, rename, getFileSize, checkIsDir, getFilesList, tools/logger: Logger ``` 2. TMBot是先登录完成所有配置的WS连接然后再加载插件的 3. TMBot已经实现了OneBot标准的连接，你可以使用 modules/BotDockingMgr 的 BotDockingMgr.getBot 来获取已连接实例 4. TMBot框架会自动为插件安装依赖,可以直接将没有node_modules的插件放入plugins运行 5. TMBot会自行检索插件的package.json所规定的依赖是否在插件目录是否完整 6. TMBot插件发行形式必须以Node包的形式发布!不要包含TMBot的任何东西!不要修改源代码!必须可以直接解压至plugins目录运行! 7. TMBot框架的插件是以Node包形式存在， 所以你可以在你的项目里随意引用所有模块 (请不要随意"使用"内部功能实现的模块) 如：```OneBotDocking， PluginLoader，Websocket```。 虽然不可以使用，但是可以引用它内部的方法作为参数类型 ### 版本控制 该项目使用Git进行版本管理。您可以在repository参看当前可用版本。 ### 作者 Timiya MineBBS:提米吖   qq:284696890 *您也可以在贡献者名单(暂时没有)中参看所有参与该项目的开发者。* ### 版权说明 该项目使用 GPL-V3 授权许可，详情请参阅 [LICENSE](https://github.com/TMBotDev/TMBot/blob/master/LICENSE) ### 鸣谢 <!-- 暂时没用> - [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) - [Img Shields](https://shields.io) - [Choose an Open Source License](https://choosealicense.com) - [GitHub Pages](https://pages.github.com) - [Animate.css](https://daneden.github.io/animate.css) - [xxxxxxxxxxxxxx](https://connoratherton.com/loaders) <!-- links --> [contributors-shield]: [URL]https://img.shields.io/github/contributors/TMBotDev/TMBot.svg?style=flat-square[/URL] [contributors-url]: [URL]https://github.com/TMBotDev/TMBot/graphs/contributors[/URL] [forks-shield]: [URL]https://img.shields.io/github/forks/TMBotDev/TMBot.svg?style=flat-square[/URL] [forks-url]: [URL]https://github.com/TMBotDev/TMBot/network/members[/URL] [stars-shield]: [URL]https://img.shields.io/github/stars/TMBotDev/TMBot.svg?style=flat-square[/URL] [stars-url]: [URL]https://github.com/TMBotDev/TMBot/stargazers[/URL] [issues-shield]: [URL]https://img.shields.io/github/issues/TMBotDev/TMBot.svg?style=flat-square[/URL] [issues-url]: [URL]https://img.shields.io/github/issues/TMBotDev/TMBot.svg[/URL] [license-shield]: [URL]https://img.shields.io/github/license/TMBotDev/TMBot.svg?style=flat-square[/URL] [license-url]: [URL]https://github.com/TMBotDev/TMBot/blob/master/LICENSE[/URL] [/MD]
