https://github.com/koooooo-7/k-bot
:robot: A Quantum Discord Bot in SpringBoot.
https://github.com/koooooo-7/k-bot
discord discord-bot java springboot
Last synced: 12 months ago
JSON representation
:robot: A Quantum Discord Bot in SpringBoot.
- Host: GitHub
- URL: https://github.com/koooooo-7/k-bot
- Owner: Koooooo-7
- License: mit
- Created: 2020-06-04T13:57:23.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-01T15:20:03.000Z (over 2 years ago)
- Last Synced: 2025-05-07T23:39:57.019Z (about 1 year ago)
- Topics: discord, discord-bot, java, springboot
- Language: Java
- Homepage: https://github.com/Koooooo-7/K-Bot
- Size: 120 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Kbot, a Quantum Discord bot in SpringBoot.
### [Intruduction](#Intruduction) · [Usage](#bookusage) · [Plugins](#wrenchplugins) · [Contributing](#Contributing) · [Statement](#-statement )
---
## 📣Introduction
> A DIY bot that you can be the designer of your own **`K-bot`** !:fire:
**`K-bot`** is a Quantum [Discord](discord.com) bot, which means she can do everything, if she has enough plugins. :rocket:
It is **NOT** the specific bot which is just for importing to your Discord server( absolutely, she can do that ! :wink: ).
**`K-bot`** is developed in `SpringBoot` and makes all the plugins as plugins/configurations. hence you can chose what skills you want for `K-bot` via setting the configuration files to summon the abilities, and you can add and register your own plugins in **`K-bot`** easily. :cowboy_hat_face:
---
## :book:Usage
> IF YOU WANNA USE IT.
Set those configurations to `application.yml`(more details in `application-example.yml`).
**Get your bot**
```yaml
k-bot:
# your bot token
token: "your bot token"
# the command you wanna call your bot
cmd: "!koy"
```
**Summon Plugin**
the plugins you want add to your bot and then , it will only create those plugin instances.
```yaml
# register plugins
plugins:
- player
- time
- joker
```
> IF YOU WANNA CREATE IT !
**Create Plugin**
- Implementation interface.
the parser will give the arguments to your plugin if it matched.
```java
public interface IPlugin {
void handle(String[] args);
@Deprecated
String command();
}
```
- Define command
We use the annotation `@Plugin` to define the plugin meta data.
```java
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface Plugin {
// the plugin name
String name() default "";
// how to call the plugin normally
String call();
// fast commands
String[] fastCommand() default {};
}
```
- Configure the condition
We won't create the plugin instance when it does not be called, so we should set the conditional configuration.
```java
@Bean
@ConditionalOnSummoned(name = "k-bot.plugins", havingValue = "player")
public AudioPlayer audioPlayer(){
return new AudioPlayer();
}
```
**Example**
the example of how to create the plugin `joker`.
- create `joker`
```java
@Plugin(name = "joker", call = "joker", fastCommand = {"j", "jk"})
public class Joker implements IPlugin {
...
}
```
- set bean condition
```java
@Bean
@ConditionalOnSummoned(name = "k-bot.plugins", havingValue = "joker")
public Joker joker() {
return new Joker();
}
```
it is so easy to add an new plugin to `K-bot`, isn't it ! :tada:
---
## :wrench:Plugins
> NOTE: **Command** doesn't contain the command/name calling the bot. :pencil:
| Plugin | Description | Command | Example |
| ------- | ------------------------------------------------------------ | ------------------ | --------------- |
| Player | A audio player based on [lavaplayer](https://github.com/sedmelluq/lavaplayer). | play [- u ] | play hello |
| Joke | Send a joke randomly. | joke | joke |
| time | Report the current time of the city. | time [cityname] | time Tokyo |
| weather | Report the current weather details of the city. | weather [cityname] | weather Beijing |
| | | | |
| ... | waiting for your ideas !:rocket: | | |
**Help**
`help` is an embed command that it can help a lot about the commands, such as recommending the similar commands when you called a non exist command.
---
## :rocket:Contributing
**Folk it !**
- fix bugs： send a PR here !
- feature：it is better to have an `feature request` issue first and then, working on it !
---
## 📃 Statement
The API of bot are all getting from the open resources, if there has any problem, leaving an issues please.
[MIT](LICENSE) @Koy