diff --git a/README.md b/README.md index aa9d0cb8e4..bf2e514509 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,31 @@ -[maven-central]: https://img.shields.io/maven-central/v/net.dv8tion/JDA -[jitpack]: https://img.shields.io/jitpack/v/github/DV8FromTheWorld/JDA?label=Snapshots +[maven-central]: https://img.shields.io/maven-central/v/net.dv8tion/JDA?color=blue +[jitpack]: https://img.shields.io/jitpack/v/github/DV8FromTheWorld/JDA?label=Snapshots&color=blue [download]: #download [discord-invite]: https://discord.gg/0hMr4ce0tIl3SLv5 [migration]: https://github.com/DV8FromTheWorld/JDA/wiki/0\)-Migrating-to-V4 -[jenkins]: https://ci.dv8tion.net/job/JDA +[jenkins]: https://ci.dv8tion.net/job/JDA5 [license]: https://github.com/DV8FromTheWorld/JDA/tree/master/LICENSE [faq]: https://github.com/DV8FromTheWorld/JDA/wiki/10\)-FAQ [troubleshooting]: https://github.com/DV8FromTheWorld/JDA/wiki/19\)-Troubleshooting [discord-shield]: https://discord.com/api/guilds/125227483518861312/widget.png [faq-shield]: https://img.shields.io/badge/Wiki-FAQ-blue.svg -[troubleshooting-shield]: https://img.shields.io/badge/Wiki-Troubleshooting-red.svg -[jenkins-shield]: https://img.shields.io/badge/Download-Jenkins-brightgreen.svg -[license-shield]: https://img.shields.io/badge/License-Apache%202.0-lightgrey.svg -[migration-shield]: https://img.shields.io/badge/Wiki-Migrating%20from%20V3-green.svg +[troubleshooting-shield]: https://img.shields.io/badge/Wiki-Troubleshooting-darkgreen.svg +[jenkins-shield]: https://img.shields.io/badge/Download-Jenkins-purple.svg +[license-shield]: https://img.shields.io/badge/License-Apache%202.0-white.svg +[migration-shield]: https://img.shields.io/badge/Wiki-Migrating%20from%20V3-darkgreen.svg + + + [ ![maven-central][] ][download] [ ![jitpack][] ](https://jitpack.io/#DV8FromtheWorld/JDA) [ ![jenkins-shield][] ][jenkins] [ ![license-shield][] ][license] + [ ![discord-shield][] ][discord-invite] [ ![faq-shield] ][faq] [ ![troubleshooting-shield] ][troubleshooting] [ ![migration-shield][] ][migration] - # JDA (Java Discord API) @@ -94,8 +97,8 @@ public static void main(String[] args) { } ``` -> See [JDABuilder](https://ci.dv8tion.net/job/JDA/javadoc/net/dv8tion/jda/api/JDABuilder.html) - and [DefaultShardManagerBuilder](https://ci.dv8tion.net/job/JDA/javadoc/net/dv8tion/jda/api/sharding/DefaultShardManagerBuilder.html) +> See [JDABuilder](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/JDABuilder.html) + and [DefaultShardManagerBuilder](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/sharding/DefaultShardManagerBuilder.html) You can configure the memory usage by changing enabled `CacheFlags` on the `JDABuilder`. Additionally, you can change the handling of member/user cache by setting either a `ChunkingFilter`, disabling **intents**, or changing the **member cache policy**. @@ -267,22 +270,22 @@ public class Bot extends ListenerAdapter ### RestAction -Through [RestAction](https://ci.dv8tion.net/job/JDA/javadoc/net/dv8tion/jda/api/requests/RestAction.html) we provide request handling with +Through [RestAction](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/requests/RestAction.html) we provide request handling with - - [callbacks](https://ci.dv8tion.net/job/JDA/javadoc/net/dv8tion/jda/api/requests/RestAction.html#queue%28java.util.function.Consumer%29) - - [promises](https://ci.dv8tion.net/job/JDA/javadoc/net/dv8tion/jda/api/requests/RestAction.html#submit%28%29) - - and [sync](https://ci.dv8tion.net/job/JDA/javadoc/net/dv8tion/jda/api/requests/RestAction.html#complete%28%29) + - [callbacks](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/requests/RestAction.html#queue%28java.util.function.Consumer%29) + - [promises](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/requests/RestAction.html#submit%28%29) + - and [sync](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/requests/RestAction.html#complete%28%29) and it is up to the user to decide which pattern to utilize. It can be combined with reactive libraries such as [reactor-core](https://github.com/reactor/reactor-core) due to being lazy. The RestAction interface also supports a number of operators to avoid callback hell: -- [`map`](https://ci.dv8tion.net/job/JDA/javadoc/net/dv8tion/jda/api/requests/RestAction.html#map%28java.util.function.Function%29) +- [`map`](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/requests/RestAction.html#map%28java.util.function.Function%29) Convert the result of the `RestAction` to a different value -- [`flatMap`](https://ci.dv8tion.net/job/JDA/javadoc/net/dv8tion/jda/api/requests/RestAction.html#flatMap%28java.util.function.Function%29) +- [`flatMap`](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/requests/RestAction.html#flatMap%28java.util.function.Function%29) Chain another `RestAction` on the result -- [`delay`](https://ci.dv8tion.net/job/JDA/javadoc/net/dv8tion/jda/api/requests/RestAction.html#delay%28java.time.Duration%29) +- [`delay`](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/requests/RestAction.html#delay%28java.time.Duration%29) Delay the element of the previous step **Example**: @@ -319,7 +322,7 @@ To use sharding in JDA you will need to use `JDABuilder.useSharding(int shardId, has the ID 0. The **shardTotal** is the total amount of shards (not 0-based) which can be seen similar to the length of an array, the last shard has the ID of `shardTotal - 1`. -The [`SessionController`](https://ci.dv8tion.net/job/JDA/javadoc/net/dv8tion/jda/api/utils/SessionController.html) is a tool of the JDABuilder +The [`SessionController`](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/utils/SessionController.html) is a tool of the JDABuilder that allows to control state and behaviour between shards (sessions). When using multiple builders to build shards you have to create one instance of this controller and add the same instance to each builder: `builder.setSessionController(controller)` @@ -509,7 +512,7 @@ The most popular implementations are [Log4j 2](https://logging.apache.org/log4j/ ## Documentation -Docs can be found on the [Jenkins][jenkins] or directly [here](https://ci.dv8tion.net/job/JDA/javadoc/) +Docs can be found on the [Jenkins][jenkins] or directly [here](https://ci.dv8tion.net/job/JDA5/javadoc/)
A simple Wiki can also be found in this repository's [Wiki section](https://github.com/DV8FromTheWorld/JDA/wiki) ### Annotations