# simpler-robot

**Repository Path**: LeftJson/simpler-robot

## Basic Information

- **Project Name**: simpler-robot
- **Description**: 一个基于Kotlin协程的bot风格Kotlin多平台事件调度框架，异步高效、Java友好♥
- **Primary Language**: Kotlin
- **License**: GPL-3.0
- **Default Branch**: v4-dev
- **Homepage**: https://simbot.forte.love
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 7
- **Created**: 2024-08-14
- **Last Updated**: 2024-08-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!--suppress HtmlDeprecatedAttribute -->
<div align="center">
<a href="https://simbot.forte.love/">
<picture>
  <source media="(prefers-color-scheme: dark)" srcset=".simbot/logo-dark.svg">
  <source media="(prefers-color-scheme: light)" srcset=".simbot/logo.svg">
  <img alt="simbot logo" src=".simbot/logo.svg" width="260" />
</picture>
</a>
<h2>
    - Simple Robot -
</h2>
<small>
    ~ simbot v4 ~      
</small>
<br>
    <span>
        <a href="https://github.com/simple-robot/simpler-robot" target="_blank">GitHub</a>
    </span> 
    &nbsp;&nbsp; | &nbsp;&nbsp;
    <span>
        <a href="https://gitee.com/simple-robot/simpler-robot" target="_blank">Gitee</a>
    </span> <br />
    <small> &gt; 感谢 <a href="https://github.com/ForteScarlet/CatCode" target="_blank">CatCode</a> 开发团队成员制作的simbot logo &lt; </small>
    <br>
    <small> &gt; 走过路过，不要忘记点亮一颗⭐喔~ &lt; </small> 
    <br>
   <a href="https://github.com/simple-robot/simpler-robot/releases/latest"><img alt="release" src="https://img.shields.io/github/v/release/simple-robot/simpler-robot" /></a>
<a href="https://repo1.maven.org/maven2/love/forte/simbot/simbot-api/" target="_blank">
  <img alt="release" src="https://img.shields.io/maven-central/v/love.forte.simbot/simbot-api" /></a>
<a href="https://simbot.forte.love" target="_blank">
  <img alt="doc" src="https://img.shields.io/badge/doc-simbot-brightgreen" /></a>
<a href="https://qodana.cloud/projects/p9mmM/reports/79Xen" target="_blank">
  <img alt="Qodana" src="https://github.com/simple-robot/simpler-robot/actions/workflows/qodana_code_quality.yml/badge.svg" /></a>
   <hr>
   <img alt="stars" src="https://img.shields.io/github/stars/simple-robot/simpler-robot" />
   <img alt="forks" src="https://img.shields.io/github/forks/simple-robot/simpler-robot" />
   <img alt="watchers" src="https://img.shields.io/github/watchers/simple-robot/simpler-robot" />
   <img alt="repo-size" src="https://img.shields.io/github/repo-size/simple-robot/simpler-robot" />
   <img alt="code-size" src="https://img.shields.io/github/languages/code-size/simple-robot/simpler-robot" />
   
   <img alt="issues" src="https://img.shields.io/github/issues-closed/simple-robot/simpler-robot?color=green" />
   <img alt="last-commit" src="https://img.shields.io/github/last-commit/simple-robot/simpler-robot" />
   <img alt="search-hit" src="https://img.shields.io/github/search/simple-robot/simpler-robot/simbot" />
   <img alt="top-language" src="https://img.shields.io/github/languages/top/simple-robot/simpler-robot" />
<a href="./COPYING"><img alt="copying" src="https://img.shields.io/github/license/simple-robot/simpler-robot" /></a>

<br>

</div>

[中文](README.md) | English

## Summary

**`Simple Robot`** v4 is a multi-platform Bot-style high-
performance asynchronous event scheduling framework based on 
**KMP** (hereafter referred to as simbot).
It provides a unified asynchronous API and easy-to-use style design, 
which can help you write bot-style event scheduling applications 
more quickly and efficiently.

Currently, it is mainly used to interface with various types of 
bot application platforms/frameworks and provides part of 
the component library implementation.

**`simbot4`** Developed via [Kotlin](https://kotlinlang.org/) language,
Based on [KMP](https://kotlinlang.org/docs/multiplatform.html) for 
multi-platform support, and compatible with Java (**jdk11+**) and 
other JVM platform languages.

And provides a lot of Java-friendly API and Spring Boot starter, 
to help you quickly develop .

This repository is the repository for simbot v3 and v4, containing 
the definition of the simbot standard API, the implementation of 
the simbot core libraries, and the implementation of the Spring Boot starter 
and other core and basic content.

> [!tip]
> Visit the [GitHub Organisation Home](https://github.com/simple-robot/) 
> to learn more about the components, documentation, community and more!

## 文档

simbot4 reference documentation: [simbot.forte.love][doc-homepage]

> [!note]
> Also includes document address guides for previous versions

Documentation Bootstrap & API Doc: [docs.simbot.forte.love](https://docs.simbot.forte.love)

## V3

Branch to [v3-dev](https://github.com/simple-robot/simpler-robot/tree/v3-dev) 
to see the development branch of simbot3.

## 协助我们
Lighting up a **✨star🌟** for us is the greatest motivation and support we can give to keep going!

- Go to [CONTRIBUTING](docs/CONTRIBUTING.md) for more information!
- You can contribute to the project code via [**Pull Request**][pr].
- You can make a suggestion or give feedback on an issue via [**Issues**][issues].
- You can communicate with other people or the simbot development team via [**Discussions**][discussions].
- If you create a cool open source project through this project, 
  you are welcome to leave your open source project information through [**Issues**][issues], [**Discussions**][discussions] and so on.
  etc. Leave your open source project information and show your cool project in the work display area.

## Contact us
- To give feedback on an issue, make a suggestion, or ask a question, please go to [**ISSUES**][issues].
- To talk to the development team, to talk to other developers, go to [**DISCUSSIONS**][discussions].
- More **Community Information** can be found in the [GitHub Organisation Home](https://github.com/simple-robot/).

[pr]: https://github.com/simple-robot/simpler-robot/pulls
[issues]: https://github.com/simple-robot/simpler-robot/issues
[discussions]: https://github.com/orgs/simple-robot/discussions


## Special thanks

<a href="https://www.jetbrains.com/?from=simpler-robot">
<img src=".simbot/jetbrains.svg" width="200" alt="jetbrains" />
</a>

[jetbrains]: https://www.jetbrains.com/?from=simpler-robot

## Star!

[![Star History Chart](https://api.star-history.com/svg?repos=simple-robot/simpler-robot&type=Date)](https://star-history.com/#simple-robot/simpler-robot&Date)

> powered by [Star History](https://star-history.com)

## License

Simple Robot is open source under the [LGPLv3](https://www.gnu.org/licenses/#LGPL) license.

```
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by 
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Lesser GNU General Public License for more details.

You should have received a copy of the Lesser GNU General Public License 
along with this program.  If not, see <https://www.gnu.org/licenses/>.
```

[doc-homepage]: https://simbot.forte.love/