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

# Contributing to WUtils

Module by module, package by package: internal structure, invariants, sharp edges and source citations for people changing WUtils itself.

WUtils is a multi-module collection of independently versioned and independently published Java/Kotlin libraries for Bukkit/Paper 1.16.5 plugins. Each module is its own Maven Central artifact, and consumers pull only the modules they need.

This section documents WUtils at the level of detail someone **changing the code** needs: internal structure, invariants, sharp edges, and `path/to/File.java:<line>` citations back into the repository. It covers the `animation`, `common`, `commonKt`, `config`, `configurables`, `i18n`, `i18nKt`, `jdbc`, `json`, and `structure` modules. The deprecated `log` module is excluded from the build and is not documented.

{% hint style="warning" %}
These pages describe internals and are deliberately prose-only — they are not an API contract. If you want to *use* WUtils in a plugin rather than work on it, read the [Documentation](https://github.com/Wyne10/WUtils/tree/master/documentation/README.md) section instead.
{% endhint %}

## Module map

| Module                                                                  | Artifact               | What lives there                                                                      |
| ----------------------------------------------------------------------- | ---------------------- | ------------------------------------------------------------------------------------- |
| [common](/wyne-docs/contributing/common/common.md)                      | `wutils-common`        | Events, scheduler, promises, terminables, game-object helpers — the shared foundation |
| [commonKt](/wyne-docs/contributing/common/commonkt.md)                  | `wutils-common-kotlin` | Kotlin extensions over `common`                                                       |
| [config](/wyne-docs/contributing/config/config.md)                      | `wutils-config`        | Annotation-driven YAML config generation and reading                                  |
| [configurables](/wyne-docs/contributing/configurables/configurables.md) | `wutils-configurables` | Config-driven items, GUIs, animations, interactions                                   |
| [i18n](/wyne-docs/contributing/i18n/i18n.md)                            | `wutils-i18n`          | Languages, interpreters, replacements, localized values                               |
| [i18nKt](/wyne-docs/contributing/i18n/i18nkt.md)                        | `wutils-i18n-kotlin`   | Kotlin extensions over `i18n`                                                         |
| [animation](/wyne-docs/contributing/animation/animation.md)             | `wutils-animation`     | Step scheduling and runnables                                                         |
| [structure](/wyne-docs/contributing/structure/structure.md)             | `wutils-structure`     | Schemes, regions, modifiers, persistence                                              |
| [jdbc](/wyne-docs/contributing/storage/jdbc.md)                         | `wutils-jdbc`          | Pooled connections and runtime driver loading                                         |
| [json](/wyne-docs/contributing/storage/json.md)                         | `wutils-json`          | Annotation-driven JSON field storage                                                  |

## Documentation conventions

* Contributor pages are **prose-only**. Only ` ```mermaid ` diagrams are allowed; pages that genuinely need code opt out with an `allow-code-fences` HTML comment.
* Source is cited as `path/to/File.java:<line>`, repo-relative. Citations are checked against the working tree, including line ranges.
* Both wikis are validated by `python3 .claude/validate-docs.py`, which verifies the `AGENTS.md` indexes and `SUMMARY.md` tables of contents match what is on disk, and that every link and citation resolves.


---

# 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://wyne.gitbook.io/wyne-docs/contributing/readme.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.