~ Simple Robot ~
Discord Component

---

中文 | English

Caution

WIP

This content is machine-translated.

This is a subproject of
Simple Robot v4 (simbot), which is a simbot component library implementation for Discord Bot. This includes the implementation of the API, the implementation of events and the bots listening and interaction with events.

The Discord Component can be used as a low-level API dependency, The lightweight Discord event scheduling framework uses, It is also possible to quickly develop a powerful Discord Bot based on the simbot core library!

• Based on Kotlin and KMP, and provide friendly Java API.
• Based on Kotlin coroutines and Ktor provides efficient and easy to use API;

Documentation

• Discord Component Reference Manual: (to be built)
• Learn about simbot: The Simple Robot Reference Manual
• API Documentation: The KDoc of Discord Component in the document guide site.
• Communities: Have fun interacting with us and other developers!

Modules

API module

Based on Ktor's KMP implementation for Discord API, is a simple, efficient and lightweight API implementation module.

This module provides very little extra implementation. The goal is to preserve the feel of the original API as much as possible without overwrapping it.

👉 Go to Modules to learn more.

Stdlib module

Based on API module, for the implementation of authentication, subscription events and other related functions in bot.

This module provides an implementation of event-related functionality based on the API module, including the ability to subscribe to events.

Again, the goal is to provide as much of the feel of the original API as possible without overwrapping it.

👉 Go to Modules to learn more.

Core Component module

A component implementation of the simbot4 core library based on standard library module.

Is a relatively highly encapsulated module that provides most of the capabilities of simbot4, including event listeners, multi-component coordination, Spring Boot starter, and more.

👉 Go to Modules to learn more.

CONTRIBUTING

See CONTRIBUTING.md for more information!

We welcome you and look forward to it feed back or pull request, Thank you for your contribution and support!

License

simbot-component-discord is open source under the LGPLv3 licence。

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 GNU Lesser General Public License for more 
details.

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