Skip to content

Commit

Permalink
Clean up README
Browse files Browse the repository at this point in the history
  • Loading branch information
Revxrsal authored Dec 13, 2022
1 parent dfbad7e commit 3cb2dd0
Showing 1 changed file with 30 additions and 25 deletions.
55 changes: 30 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,12 @@ Glad you asked!
- **[Built-in command cooldown handler](common/src/main/java/revxrsal/commands/annotation/Cooldown.java)**

## Getting Started
Now, for the good part.

First, you'll need to add the JitPack repository, and then you're going to select which part of Lamp you're going to use.

If you for some reason want to use the whole project as dependency, you can use "com.github.Revxrsal" as the groupId (or group on Gradle), and only the name "Lamp" as the artifactId (or name on Gradle).
But if you chose to use only one module or two, you have to use "com.github.Revxrsal.Lamp" as the groupId and "[the module that you want]" as the artifactId. Bellow, there are examples about Maven and Gradle that will help you get started.
See available versions and modules below.

### Maven
<details>
<summary>pom.xml</summary>

**pom.xml**

``` xml
<repositories>
Expand All @@ -67,38 +63,37 @@ But if you chose to use only one module or two, you have to use "com.github.Revx
</repositories>

<dependencies>
<!-- For the common module -->
<!-- Required for all platforms -->
<dependency>
<groupId>com.github.Revxrsal.Lamp</groupId>
<artifactId>common</artifactId>
<version>[version]</version>
</dependency>

<!-- For the bukkit module -->
<!-- Add your specific platform module here -->
<dependency>
<groupId>com.github.Revxrsal.Lamp</groupId>
<artifactId>bukkit</artifactId>
<artifactId>[module]</artifactId>
<version>[version]</version>
</dependency>
</dependencies>
```
</details>

### Gradle
<details>
<summary>build.gradle (Groovy)</summary>

**build.gradle (Groovy)**

```groovy
repositories {
maven { url = 'https://jitpack.io' }
}
dependencies {
// For the common module
// Required for all platforms
implementation 'com.github.Revxrsal.Lamp:common:[version]'
// For the bukkit module
implementation 'com.github.Revxrsal.Lamp:bukkit:[version]'
// Add your specific platform module here
implementation 'com.github.Revxrsal.Lamp:[module]:[version]'
}
compileJava { // Preserve parameter names in the bytecode
Expand All @@ -111,23 +106,20 @@ compileKotlin { // optional: if you're using Kotlin
kotlinOptions.javaParameters = true
}
```
</details>


<details>
<summary>build.gradle.kts (Kotlin DSL)</summary>
**build.gradle.kts (Kotlin DSL)**

```kotlin
repositories {
maven(url = "https://jitpack.io")
}

dependencies {
// For the common project
// Required for all platforms
implementation("com.github.Revxrsal.Lamp:common:[version]")

// For the bukkit module
implementation("com.github.Revxrsal.Lamp:bukkit:[verison]")
// Add your specific platform module here
implementation("com.github.Revxrsal.Lamp:[module]:[verison]")
}

compileJava { // Preserve parameter names in the bytecode
Expand All @@ -142,6 +134,19 @@ compileKotlin { // optional: if you're using Kotlin
```
</details>

**Latest stable version**

[![JitPack](https://jitpack.io/v/Revxrsal/Lamp.svg)](https://jitpack.io/#Revxrsal/Lamp)

**Available modules**:
- `bukkit` for Bukkit/Spigot/Paper
- `velocity` for [VelocityPowered](https://velocitypowered.com/)
- `sponge` for [SpongePowered](https://spongepowered.org/)
- `bungee` for [BungeeCord](https://www.spigotmc.org/wiki/bungeecord/)
- `jda` for [Java Discord API (JDA)](https://github.com/DV8FromTheWorld/JDA)
- `brigadier` for [Mojang Brigadier](https://github.com/Mojang/brigadier)
- `cli` for building console applications

## Examples

**`/epicbans ban <player> <days> <reason>`**
Expand Down Expand Up @@ -204,7 +209,7 @@ Add `-silent` to make the ban silent
**Terminate all nearby entities command**

```java
@Command("killall")
@Command("terminate")
public void terminate(BukkitCommandActor sender, @Range(min = 1) int radius) {
int killCount = 0;
for (Entity target : sender.requirePlayer().getNearbyEntities(radius, radius, radius)) {
Expand Down

0 comments on commit 3cb2dd0

Please sign in to comment.