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

# Mod installation

## Mod installation

The Downloads menu can browse rule sources and manage local imports.

### Modrinth

Modrinth searches do not require a private API key.

* [ClientModGate on Modrinth](https://modrinth.com/plugin/clientmodgate)

### CurseForge

CurseForge access uses an environment variable:

```bash
CLIENTMODGATE_CURSEFORGE_API_KEY=your_raw_api_key
```

Restart Paper after changing the environment variable. The API key is not stored in the YAML configuration.

### Local files

Administrators can inspect local JAR or ZIP archives without executing them.

{% hint style="warning" %}
A listed mod is not automatically convertible. ClientModGate refuses archives that cannot produce a dependable rule instead of installing an ineffective profile.
{% endhint %}

Selecting an already-installed rule removes it after confirmation.


---

# 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://clientmodgate.gitbook.io/clientmodgate/administration/mod-installation.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.