> For the complete documentation index, see [llms.txt](https://eplugins.gitbook.io/eglow/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://eplugins.gitbook.io/eglow/developer-api/getting-started.md).

# Getting started

We're proud to announce that we finally have the eGlow API available again!

We do want to mention that this is a stripped down version of eGlow removing all the logic and only leaving the API part available. If you feel like something is missing you can always request something to be added.

## Setting up the dependency

### Gradle

#### Groovy

```groovy
repositories {
    maven { url 'https://jitpack.io' }
}

dependencies {
    compileOnly 'com.github.SlyOtters:EGlow-API:v1.0'
}
```

#### Kotlin

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

dependencies {
    compileOnly("com.github.SlyOtters", "EGlow-API", "v1.0")
}
```

### Maven

```xml
<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>

<dependency>
    <groupId>com.github.SlyOtters</groupId>
    <artifactId>EGlow-API</artifactId>
    <version>v1.0</version>
    <scope>provided</scope>
</dependency>
```

WARNING: Do NOT shade the API into your jar and do NOT relocate the API from it's original package!\
\
If you do the API will not behave as intended! for Gradle make sure it's on `compileOnly` and for maven `<scope>provided<scope>`.