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

# Developer API ( Premium Only )

By default, PaperX allows you to have 3 currencies.

The PaperX **API** extends this functionality by letting developers register and manage custom currencies directly from their own plugins.

This guide will walk you through:

* Installing the jar with maven
* Setting up the PaperX dependency in a pom.xml
* Registering basic commands
* Adding a custom currency

Before getting started, make sure you have downloaded the PaperX jar, as this is needed for compiling.


---

# 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://warmania.gitbook.io/paperx-documentation/api-reference/readme.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.