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

# Introduction to Mineject

***

### What is Mineject?

Mineject is a framework designed to simplify the creation of projects for platforms like Spigot, BungeeCord, and others. The project that particularly inspired me was [EternalCore](https://github.com/EternalCodeTeam) by [EternalCodeTeam](https://github.com/EternalCodeTeam/EternalCore), which implemented the technique of dependency injection. This is my first project of this kind, so I realize it may not be flawless, but I'm very satisfied with the final result.

Additionally, Mineject allows developers to use it without the need to code specifically for a given platform, such as Spigot or BungeeCord.

***

### How do I implement it to my project?

{% tabs %}
{% tab title="Gradle (Kotlin)" %}
{% code overflow="wrap" lineNumbers="true" %}

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

dependencies {
    implementation("com.github.failutee.Mineject:mineject-core:{TAG}")
}
```

{% endcode %}
{% endtab %}

{% tab title="Gradle" %}
{% code overflow="wrap" lineNumbers="true" %}

```gradle
repositories {
    mavenCentral()
    maven {
        url 'https://jitpack.io'
    }
}

dependencies {
    implementation 'com.github.failutee.Mineject:mineject-core:{TAG}'
}
```

{% endcode %}
{% endtab %}

{% tab title="Maven" %}

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

<dependency>
   <groupId>com.github.failutee.Mineject</groupId>
   <artifactId>mineject-core</artifactId>
   <version>{TAG}</version>
</dependency>
```

{% endtab %}
{% endtabs %}

**Remember to replace `{TAG}` with the tag version from GitHub. In the example below, the Tag will be&#x20;*****1.0.0***

<figure><picture><source srcset="/files/hIcO2hr8OTUxbzl3tw1f" media="(prefers-color-scheme: dark)"><img src="/files/2J46YPtxRwyKbVhc7XzJ" alt=""></picture><figcaption><p><a href="https://github.com/failutee/Mineject/releases">https://github.com/failutee/Mineject/releases</a></p></figcaption></figure>