Shared technical documentation and development guidelines for OKOCRAFT projects.
| Area | Guide | Scope |
|---|---|---|
| Project and build | Java Project, Gradle, and CI Guidelines | Project structure, build systems, dependencies, CI, shared workflows, and Renovate |
| Testing | Testing Guidelines | Test design, test scope, mocking, platform boundaries, and behavioral verification |
| Scheduling and threading | Paper and Folia Scheduling and Threading Guidelines | Paper/Folia scheduler ownership, async boundaries, cross-region work, and Folia safety |
| Lifecycle | Plugin Lifecycle and Resource Ownership Guidelines | Plugin lifecycle, resource ownership, cleanup, replacement, and failure handling |
| Configuration | Configuration and Reload Guidelines | Configurate, typed configuration, validation, publication, reload, and migration |
| Message writing | Message Formatting Guidelines | User-facing wording, message keys, MiniMessage, placeholders, English, and Japanese |
| Message implementation | Java Message Definitions and Localization | Java message declarations, mcmsgdef, translations, runtime language files, and Adventure registration |
AGENTS.md provides the organization-wide baseline instructions for coding agents working across OKOCRAFT repositories. It is intentionally concise: it routes agents to the relevant canonical guideline, defines only cross-cutting invariants, and is intended to be referenced or adopted by individual repositories.
Repository-specific instructions may add stricter or more detailed rules for local architecture, build, platform, or release requirements. The documents in this repository remain the canonical detailed guidance.
This project is under the Apache License version 2.0. Please read LICENSE for more info.
Copyright © 2026, OKOCRAFT and Siroshun09