https://github.com/simple-robot/simbot-component-discord

Kotlin coroutines based Discord bot API/SDK multi-platform library, is also a Simple Robot Component library. 🚀🚀🌋
https://github.com/simple-robot/simbot-component-discord

discord discord-bot discord-bot-api discord-bots kotlin kotlin-coroutines kotlin-multiplatform simbot simbot-component simbot4

Last synced: 26 days ago
JSON representation

Kotlin coroutines based Discord bot API/SDK multi-platform library, is also a Simple Robot Component library. 🚀🚀🌋

• Host: GitHub
• URL: https://github.com/simple-robot/simbot-component-discord
• Owner: simple-robot
• License: lgpl-3.0
• Created: 2024-02-15T20:09:31.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-03-23T16:27:20.000Z (10 months ago)
• Last Synced: 2024-03-23T17:31:40.754Z (10 months ago)
• Topics: discord, discord-bot, discord-bot-api, discord-bots, kotlin, kotlin-coroutines, kotlin-multiplatform, simbot, simbot-component, simbot4
• Language: Kotlin
• Homepage:
• Size: 222 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: COPYING

Awesome Lists containing this project

README

        



  

  

  



    ~ Simple Robot ~ 
 Discord Component







  

   


   

   

   

   

   

   

   

   




[中文](README_CN.md) | _English_

> [!caution]

> WIP

> This content is machine-translated.

This is a subproject of  

[**Simple Robot v4**][simbot4 gh] (simbot),

which is a simbot component library implementation for 

[**Discord Bot**][discord bot doc].

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`](https://kotlinlang.org/) and [KMP][KMP], and provide friendly Java API.

- Based on [`Kotlin coroutines`](https://github.com/Kotlin/kotlinx.coroutines) and [`Ktor`](https://ktor.io/) provides efficient and easy to use API;

## Documentation

- **Discord Component** Reference Manual: (to be built)

- Learn about simbot: [**The Simple Robot Reference Manual**][simbot doc]

- **API Documentation**: [**The KDoc of Discord Component**](https://docs.simbot.forte.love/components/discord) in the [**document guide site**](https://docs.simbot.forte.love). 

- [**Communities**](https://simbot.forte.love/communities.html): Have fun interacting with us and other developers!

## Modules

### API module

Based on `Ktor`'s [KMP][KMP] implementation for [Discord API][discord bot doc],

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](simbot-component-discord-api) to learn more.

### Stdlib module

Based on [API module](simbot-component-discord-api), 

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](simbot-component-discord-stdlib) to learn more.

### Core Component module

A component implementation of the [simbot4 core library][simbot4 gh] based on [standard library module](simbot-component-discord-stdlib).

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](simbot-component-discord-core) to learn more.

## CONTRIBUTING

See [CONTRIBUTING.md](docs/CONTRIBUTING.md) for more information! 

We welcome you and look forward to it

[feed back](https://github.com/simple-robot/simbot-component-discord/issues)

or

[pull request](https://github.com/simple-robot/simbot-component-discord/pulls),

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 .

```

[simbot4 gh]: https://github.com/simple-robot/simpler-robot/tree/v4-dev

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

[discord bot doc]: https://discord.com/developers/docs/intro

[KMP]: https://kotlinlang.org/docs/multiplatform.html