> 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>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://failutee.gitbook.io/mineject/introduction-to-mineject.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.