You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Reduced length of features section, linked to wiki
- Link to wiki to get started
- Rewording
- Emojis for major sections, should help distinguish them more
Use powerful localization for your commands and replies.
114
+
115
+
### Other utilities
116
+
117
+
* A PostgreSQL (and H2) [database abstraction](https://bc.freya02.dev/3.X/using-botcommands/database/), with logged queries
118
+
* A smart [event waiter](https://docs.bc.freya02.dev/BotCommands-core/io.github.freya022.botcommands.api.core.waiter/-event-waiter/index.html) with (multiple) preconditions, timeouts and consumers for every completion state
119
+
*[Message parsers](https://docs.bc.freya02.dev/BotCommands-core/io.github.freya022.botcommands.api.utils/-rich-text-finder/index.html) and [emoji resolvers](https://docs.bc.freya02.dev/BotCommands-core/io.github.freya022.botcommands.api.utils/-emoji-utils/index.html) (turning `:joy:` into 😂)
120
+
*[Paginators and menus](https://docs.bc.freya02.dev/BotCommands-core/io.github.freya022.botcommands.api.pagination/-paginators/index.html) of different types (using components!)
121
+
122
+
Amongst others!
123
+
124
+
## 🏃♂️ Getting Started
129
125
You are strongly recommended to have some experience with Kotlin (or Java),
130
126
OOP, [JDA](https://github.com/discord-jda/JDA) and Dependency Injection basics before you start using this library.
131
127
132
-
### Prerequisites
133
-
* An [OpenJDK 17+](https://adoptium.net/temurin/releases/?version=21) installation
134
-
* For languages other than Kotlin, enable method parameters names, please refer to the [wiki page](https://bc.freya02.dev/3.X/using-botcommands/parameter-names/)
135
-
136
-
Head over to [the wiki](https://bc.freya02.dev/3.X/setup/getting-started/) to get started,
137
-
you can also check out the [examples](src/examples).
128
+
Head over to [the wiki](https://bc.freya02.dev/3.X/setup/getting-started/) to get started.
138
129
139
-
## Installation
130
+
## 🔬 Installation
140
131
After [adding JDA](https://github.com/discord-jda/JDA?tab=readme-ov-file#-installation):
141
132
142
133
[![BotCommands on maven central][bc-maven-central-shield]][bc-maven-central-link]
@@ -166,7 +157,7 @@ dependencies {
166
157
167
158
To use the latest, unreleased changes, see [SNAPSHOTS.md](SNAPSHOTS.md).
168
159
169
-
## Modules
160
+
## 🧩 Modules
170
161
The base `BotCommands` artifact will include modules often used, while others are optional.
171
162
172
163
### Default modules
@@ -176,10 +167,10 @@ The base `BotCommands` artifact will include modules often used, while others ar
176
167
-[`BotCommands-jda-ktx`](./BotCommands-jda-ktx): provides a set of Kotlin extensions and top-level functions, similar to [jda-ktx](https://github.com/MinnDevelopment/jda-ktx).
177
168
-[`BotCommands-spring`](./BotCommands-spring): Support for Spring Boot
178
169
-[`BotCommands-typesafe-messages`](./BotCommands-typesafe-messages): Allows defining functions to retrieve text content from your bundles, providing better ergonomics and safety with load-time validation
179
-
-[`BotCommands-method-accessors-classfile`](./BotCommands-method-accessors): Improved alternative for this framework to call your functions
170
+
-[`BotCommands-method-accessors-classfile`](./BotCommands-method-accessors): An alternative to reflective calls, leading to cleaner exceptions and faster calls
180
171
-[`BotCommands-restarter`](./BotCommands-restarter): Automatically restarts of your bot as your code changes
181
172
182
-
## Sample usage
173
+
## 💡 Sample usage
183
174
Here is how you would create a slash command that sends a message in a specified channel.
184
175
<details>
185
176
<summary>Kotlin</summary>
@@ -307,7 +298,7 @@ public class SlashSay {
307
298
```
308
299
</details>
309
300
310
-
## Live templates
301
+
## 💪 Live templates
311
302
312
303
IntelliJ IDEA users can use [live templates](https://www.jetbrains.com/help/idea/using-live-templates.html) provided in [this zip file](BotCommands%203.X%20Live%20Templates.zip),
313
304
helping you make commands and other handlers with predefined templates, for both Kotlin and Java,
@@ -321,22 +312,22 @@ in the `BotCommands 3.X - [Language]` group.
321
312
322
313
For an installation guide, you can follow [this guide from JetBrains](https://www.jetbrains.com/help/idea/sharing-live-templates.html#import).
323
314
324
-
## Support
315
+
## 🧑💻 Support
325
316
326
317
Don't hesitate to join [the support server](https://discord.gg/frpCcQfvTz) if you have any question!
327
318
328
-
## Breaking changes
319
+
## 🚨 Breaking changes
329
320
330
321
Due to the nature of JDA (and the Discord API), and to always improve the developer experience,
331
322
the library could introduce breaking changes to allow quick adoption of newer features and better practices.
332
323
333
324
While attempting to reduce breaking changes by using deprecation mechanisms,
334
325
it is not always possible or practical to use deprecations.
335
326
336
-
Small breaking/deprecating changes should be noticed via an increase of the **minor** version (`3.0.0` -> `3.1.0`),
327
+
Small breaking/deprecating changes should be noticed via an increase of the **minor** version (`3.0.Z` -> `3.1.0`),
337
328
while larger breaking changes should be seing an increase of the **major** version (`3.Y.Z` -> `4.0.0`).
338
329
339
-
## Contributing
330
+
## 🛠️ Contributing
340
331
If you want to contribute, make sure to base your branch on `3.X`, and create your PR from it.
341
332
342
333
It would be appreciated to focus on improving the documentation,
0 commit comments