Skip to main content

Develop

Documentation for developers working with the Lasers-Enigma codebase. Pick the section that matches what you want to do — the other sections are useful background but not required reading.

I want to contribute to Lasers-Enigma

Bug fixes, new features, refactors, documentation. Start here.

  • Setup development environment — clone, IDE, Gradle properties, AI assistant configuration.
  • Development process — branch naming (Conventional Commits), version bump, CHANGELOG, MR workflow, release/tag procedure, marketplaces.
  • AI Prompts and Skills — the multi-step workflows (/dev-issue, /review, /fix-mr-comments, /release, /design, /deliver, /finalize-series, /epic), the reusable fragments they compose, and the atomic skills that automate the most repetitive operations. Used by Claude Code.
  • Debug — local-server debugging, log levels, common diagnostic recipes.
  • Tests — test scenarios, non-regression puzzles, manual validation conventions.
  • Bug report and Feature request — issue-template guidelines.
  • Other ways to contribute — translations, level design, beta testing, supporting the project.

I want to integrate my plugin with Lasers-Enigma

Build a companion plugin that reads Lasers-Enigma state, reacts to puzzle events, or drives the editor.

  • Use-API — overview of the public integration surface (see the pages below).
  • Direct call — when to call services directly and how to declare the dependency.
  • Events — custom Bukkit events (ABeforeActionEvent cancellable / AAfterActionEvent informational) for decoupled reactions.
  • Sample API usage — reference companion project demonstrating each integration pattern.

I want to understand the code

Mandatory background for either of the two paths above. Recommended reading order:

  1. Architecture — layered call stack, packages, key classes.
  2. Area lifecycle — load/unload + activate/deactivate axes; the rule every per-area singleton must follow to avoid leaks.
  3. Component registration — the five-file checklist for adding a new puzzle component.
  4. Database migrations — schema versioning, SQLite + MySQL portability.
  5. Translations — language-file structure, 25-language completeness, staging workflow.
  6. Wiki update matrix — which wiki page to update for which type of code change.
  7. Sound effects and CI/CD — narrower-scope references, consult on demand.

🤖 AI assistants (Claude Code) read AGENTS.md at the project root as their canonical rule source. It points back to the pages above for deep-dives. CLAUDE.md is a thin pointer to AGENTS.md.