Limework/RedisBungee
2
0
Fork 0
mirror of https://github.com/proxiodev/RedisBungee.git synced 2024-11-22 20:28:00 +00:00
Code Releases Activity

Update README.md

Browse Source
This commit is contained in:
mohammed Alteniji 2023-04-16 22:58:41 +04:00 committed by GitHub
parent 4f43c98c87
commit d9e5a21c14
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 33 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -40,7 +40,8 @@ RedisBungee is distributed as a [Gradle](https://gradle.org/) project.
By using jitpack [![](https://jitpack.io/v/ProxioDev/redisbungee.svg)](https://jitpack.io/#ProxioDev/redisbungee) By using jitpack [![](https://jitpack.io/v/ProxioDev/redisbungee.svg)](https://jitpack.io/#ProxioDev/redisbungee)
## Setup jitpack repository # Setup jitpack repository
## maven
```xml ```xml
<repositories> <repositories>
<repository> <repository>
@ -49,16 +50,32 @@ By using jitpack [![](https://jitpack.io/v/ProxioDev/redisbungee.svg)](https://j
</repository> </repository>
</repositories> </repositories>
``` ```
## [BungeeCord](https://github.com/SpigotMC/BungeeCord) ## gradle (kotlin dsl)
```kotlin
maven("https://jitpack.io/")
```
# [BungeeCord](https://github.com/SpigotMC/BungeeCord)
add this in your project dependencies add this in your project dependencies
## maven
```xml ```xml
<dependency> <dependency>
<groupId>com.github.proxiodev.redisbungee</groupId> <groupId>com.github.proxiodev.redisbungee</groupId>
<artifactId>RedisBungee-Bungee</artifactId> <artifactId>RedisBungee-Bungee</artifactId>
<version>VERSION</version> <version>VERSION</version>
<scope>provided</scope> <scope>provided</scope>
<!-- <classifier>all</classifier> USE THIS IF YOU WANT TO USE INCLUDED JEDIS LIB BECAUSE OF RELOCATION -->
</dependency> </dependency>
```
## gradle (kotlin dsl)
```
implementation("com.github.ProxioDev.redisbungee:RedisBungee-Bungee:0.11.0")
// USE THIS IF YOU WANT TO USE INCLUDED JEDIS LIB BECAUSE OF RELOACTION AND REMOVE THE ABOVE STATEMENT
implementation("com.github.ProxioDev.redisbungee:RedisBungee-Bungee:0.11.0:all") {
exclude("redis.clients", "jedis")
}
``` ```
then in your project plugin.yml add `RedisBungee` to `depends` like this then in your project plugin.yml add `RedisBungee` to `depends` like this
```yaml ```yaml
@ -71,14 +88,26 @@ depends: [ RedisBungee ]
## [Velocity](https://github.com/PaperMC/Velocity) ## [Velocity](https://github.com/PaperMC/Velocity)
## maven
```xml ```xml
<dependency> <dependency>
<groupId>com.github.proxiodev.redisbungee</groupId> <groupId>com.github.proxiodev.redisbungee</groupId>
<artifactId>RedisBungee-Velocity</artifactId> <artifactId>RedisBungee-Velocity</artifactId>
<version>VERSION</version> <version>VERSION</version>
<scope>provided</scope> <scope>provided</scope>
<!-- <classifier>all</classifier> USE THIS IF YOU WANT TO USE INCLUDED JEDIS LIB BECAUSE OF RELOCATION -->
</dependency> </dependency>
``` ```
## gradle (kotlin dsl)
```
implementation("com.github.ProxioDev.redisbungee:RedisBungee-Velocity:0.11.0")
// USE THIS IF YOU WANT TO USE INCLUDED JEDIS LIB BECAUSE OF RELOACTION AND REMOVE THE ABOVE STATEMENT
implementation("com.github.ProxioDev.redisbungee:RedisBungee-Velocity:0.11.0:all") {
exclude("redis.clients", "jedis")
}
```
then to make your plugin depends on RedisBungee, make sure your plugin class Annotation have `@Dependency(id = "redisbungee")` like this then to make your plugin depends on RedisBungee, make sure your plugin class Annotation have `@Dependency(id = "redisbungee")` like this
```java ```java
@Plugin( @Plugin(
@ -108,6 +137,7 @@ then use any of these in your project.
<artifactId>RedisBungee-Bungee</artifactId> <artifactId>RedisBungee-Bungee</artifactId>
<version>VERSION</version> <version>VERSION</version>
<scope>provided</scope> <scope>provided</scope>
<!-- <classifier>all</classifier> USE THIS IF YOU WANT TO USE INCLUDED JEDIS LIB BECAUSE OF RELOCATION -->
</dependency> </dependency>
``` ```
```xml ```xml
@ -116,6 +146,7 @@ then use any of these in your project.
<artifactId>RedisBungee-Velocity</artifactId> <artifactId>RedisBungee-Velocity</artifactId>
<version>VERSION</version> <version>VERSION</version>
<scope>provided</scope> <scope>provided</scope>
<!-- <classifier>all</classifier> USE THIS IF YOU WANT TO USE INCLUDED JEDIS LIB BECAUSE OF RELOCATION -->
</dependency> </dependency>
``` ```
## Javadocs ## Javadocs