# Developer API

HoloDisplays provides a public Java API for other mods to create and manage holograms and displays programmatically. The API is accessible via [`HoloDisplaysAPI`](https://github.com/Furq07/HoloDisplays/blob/main/src/main/java/dev/furq/holodisplays/api/HoloDisplaysAPI.java). All API-registered content is managed in-memory (not saved to config files) and cleared on reload/shutdown.

## Getting Started

### Add Dependency

**1. Add Modrinth Maven**

Add the repository and dependency to your `build.gradle` (Groovy) or `build.gradle.kts` (Kotlin).

**Groovy DSL**:

```groovy
repositories {
    maven {
        name = "Modrinth"
        url = "https://api.modrinth.com/maven"
    }
}

dependencies {
    modImplementation "maven.modrinth:holodisplays:<version>"
}
```

**Kotlin DSL**:

```kotlin
repositories {
    maven("https://api.modrinth.com/maven")
}

dependencies {
    modImplementation("maven.modrinth:holodisplays:<version>")
}
```

> **Note**: Replace `<version>` with the specific version tag (e.g., `0.4.7-1.20.6`). See [Modrinth Versions](https://modrinth.com/mod/holodisplays/versions) for available versions.

> **Important**: Use `modImplementation` (not `include`). HoloDisplays must be installed separately by users \* do not bundle it with your mod.

**2. Add to fabric.mod.json**

```json
"depends": {
  "holodisplays": "*"
}
```

### Use the API

Access the API with your mod ID:

```java
import dev.furq.holodisplays.api.HoloDisplaysAPI;

HoloDisplaysAPI api = HoloDisplaysAPI.get("mymod");
```

**Important Rules**:

* Provide your mod ID when getting the API instance.
* Use simple IDs like `"my_hologram"` - your mod ID is prepended automatically.
* Do not use `"minecraft"` as your mod ID.
* Displays referenced in holograms must exist (via config or API registration).
* Use `api.unregisterAllHolograms()` when unloading your mod.

## API Overview

The API supports:

* Creating displays (text, item, block, entity) with builders.
* Building and registering holograms.
* Managing (update, unregister, query) holograms and displays.

For details on data structures, see the Kotlin sources: `HologramData.kt`, `DisplayData.kt`.

See subsections for specific topics:

* Creating Displays
* Creating Holograms
* Managing Displays and Holograms

## Limitations & Notes

* Animations: Not yet API-exposed (planned).
* Validation: API validates IDs and references; errors print to console.
* Performance: Limit displays per hologram; use viewRange wisely.
* Compatibility: Requires Fabric 1.20.5+, Placeholder API optional for conditions.

Source: [GitHub](https://github.com/Furq07/HoloDisplays).


---

# Agent Instructions: 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:

```
GET https://holodisplays.furq.dev/developer-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.