> For the complete documentation index, see [llms.txt](https://wiki.helpch.at/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.helpch.at/helpchat-plugins/chatchat/api/getting-started.md).

# Getting Started

### Declare the ChatChat API repository and dependency in your build files

#### Maven

```xml
<repositories>
    <repository>
        <url>https://repo.helpch.at/snapshots/</url>
    </repository>
</repositories>
<dependencies>
    <dependency>
        <groupId>at.helpch</groupId>
        <artifactId>chat-chat-api</artifactId>
        <version>1.0.0-SNAPSHOT</version>
        <scope>provided</scope>
    </dependency>
</dependencies>
```

#### Gradle

```kotlin
repositories {
    maven("https://repo.helpch.at/snapshots/")
}
dependencies {
    compileOnly("at.helpch:chat-chat-api:1.0.0-SNAPSHOT")
}
```

## Get an instance of the ChatChatAPI

The ChatChatAPI interface is how you can access and modify most functionalities of ChatChat.

```java
package at.helpch.example;

import at.helpch.chatchat.api.ChatChatAPI;
import org.bukkit.plugin.RegisteredServiceProvider;
import org.bukkit.plugin.java.JavaPlugin;
import org.jetbrains.annotations.NotNull;

public class ExamplePlugin extends JavaPlugin {

    private ChatChatAPI chatChatAPI;

    @Override
    public void onEnable() {
        if (!getServer().getPluginManager().isPluginEnabled("ChatChat")) {
            getLogger().severe("Could not find ChatChat! Disabling plugin...");
            getServer().getPluginManager().disablePlugin(this);
            return;
        }

        RegisteredServiceProvider<ChatChatAPI> registeredServiceProvider = getServer().getServicesManager().getRegistration(ChatChatAPI.class);
        if (registeredServiceProvider == null) {
            getLogger().severe("Could not find the ChatChatAPI! Disabling plugin...");
            getServer().getPluginManager().disablePlugin(this);
            return;
        }

        chatChatAPI = registeredServiceProvider.getProvider();
    }

    @Override
    public void onDisable() {
        getLogger().info("Disabling plugin...");
        chatChatAPI = null;
    }

    public @NotNull ChatChatAPI getChatChatAPI() {
        return chatChatAPI;
    }
}

```


---

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

```
GET https://wiki.helpch.at/helpchat-plugins/chatchat/api/getting-started.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.