Annihilation Docs

Interactive documentation site for the Annihilation Minecraft plugin — a multi-server team PvP game built on Spigot 1.20.4 with Redis, MongoDB, and BungeeCord.

Overview

Annihilation Docs is a single-page application that serves as the complete technical reference for developers working on the Annihilation plugin suite. It covers architecture, Java class APIs, game mechanics, commands, events, i18n, and configuration — all in one searchable, translatable interface.

Stack: React 19 · TypeScript · Vite · Tailwind CSS v4
Languages: English · Español · Português
Pages: 22 routes
Classes documented: 21 player classes · 42+ Java classes

Features

| Feature | Description | |---|---| | SPA routing | useState<PageId> routing — no URL changes, instant navigation | | Global search | Full-text search across all pages with Cmd+K / Ctrl+K shortcut | | Sticky TOC | Floating Table of Contents with IntersectionObserver active-section tracking | | i18n (EN/ES/PT) | Full UI translation via I18nProvider + useT() hook, persisted in localStorage | | Class detail | Individual page per class with abilities, pro tips, counters, and same-role links | | Class comparison | Side-by-side table of all 21 classes with role filter and sort | | Dependency graph | Interactive CSS module graph — click a node to see dependencies and key exports | | Changelog | Timeline view with versioned release notes and badge types (feat, fix, perf, …) | | Related pages | Context-aware "See also" section at the bottom of every page | | Back to top | Smooth-scroll button that appears after 320 px of scroll | | Copy code | Shared CodeBlock component with clipboard copy and translated feedback | | Mobile sidebar | Responsive drawer with overlay and hamburger toggle |

Pages

Home

| Route | Description | |---|---| | overview | Project banner, stats (316 classes · 4 modules · 21 kits · 3 languages), quick navigation | | architecture | System diagram: BungeeCord → Lobby → Game → Commons, Redis/MongoDB | | dependency-graph | Interactive graph of inter-module dependencies |

Modules

| Route | Description | |---|---| | module-bungee | annihilation-bungee — proxy plugin, player transfer, Redis bridge | | module-commons | annihilation-commons — shared library: MessageBus, TranslationService, MatchmakingQueue | | module-game | annihilation-game — arena engine, NexusManager, CombatTagService, class system | | module-lobby | annihilation-lobby — matchmaking processor, shop, cosmetics, leaderboard |

Game Mechanics

| Route | Description | |---|---| | classes | Grid of all 21 player classes with role filter, search, and click-through to detail | | class-detail | Per-class page: ability, kit, pro tips, strong-against / weak-against | | class-compare | Comparison table — sort by cooldown, role, trigger; filter by role | | phases | Arena phase state machine (WAITING → PHASE I–VI → ENDING) | | nexus | Nexus damage flow, NexusManager API, i18n keys, /score output | | matchmaking | Matchmaking flow diagram, QUICK_JOIN vs SPECIFIC_ARENA, key classes |

Commands & Events

| Route | Description | |---|---| | commands | Tabbed reference: Game Player · Game Admin · Lobby Player · Lobby Admin | | events | Filterable Bukkit event listener table (27 entries, 6 categories) |

Reference

| Route | Description | |---|---| | i18n | Language resolution pipeline, Common/Lobby/Game message keys, PlaceholderResolver | | configuration | GameConfig, RedisCredentials, MongoCredentials, YAML repositories | | setup | Step-by-step installation guide with copy-to-clipboard code blocks | | changelog | Versioned release timeline |

Player Classes

21 classes across 7 roles:

| Role | Classes | |---|---| | Warrior | Knight, Tank, Swordsman, Destroyer | | Assassin | Assassin, Vampire, Acrobat | | Mage | Wizard, Necromancer, Alchemist | | Support | Healer, Paladin | | Utility | Builder, Engineer, Miner, Trapper | | Ranger | Ranger, Sniper, Archer | | Special | Scout, Speedster |

Project Structure

annihilation-web/
├── public/
│   ├── Annihilation-Banner.png   # Hero banner
│   ├── favicon.svg               # Crossed-swords icon
│   └── icons.svg
├── src/
│   ├── App.tsx                   # Root: routing state, Cmd+K shortcut, layout
│   ├── components/
│   │   ├── ApiClassCard.tsx      # Java class detail card
│   │   ├── BackToTop.tsx         # Scroll-to-top button
│   │   ├── CodeBlock.tsx         # Copy-to-clipboard code block
│   │   ├── RelatedPages.tsx      # "See also" section
│   │   ├── Sidebar.tsx           # Navigation drawer + in-sidebar search
│   │   ├── TableOfContents.tsx   # Sticky floating TOC
│   │   └── Topbar.tsx            # Top bar with search input and language switcher
│   ├── data/
│   │   ├── classes.ts            # 21 player class definitions
│   │   ├── commands.ts           # 39 command entries across 4 tabs
│   │   ├── navigation.ts         # PageId, NAV_SECTIONS, breadcrumbs, TOC, RELATED_PAGES
│   │   └── modules/
│   │       ├── commons-api.ts    # annihilation-commons Java API surface
│   │       ├── game-api.ts       # annihilation-game Java API surface
│   │       └── lobby-api.ts      # annihilation-lobby Java API surface
│   ├── i18n/
│   │   ├── context.tsx           # I18nProvider + useT() hook
│   │   ├── types.ts              # Translations interface (strict key typing)
│   │   ├── en.ts                 # English strings
│   │   ├── es.ts                 # Spanish strings
│   │   └── pt.ts                 # Portuguese strings
│   └── pages/
│       ├── Overview.tsx
│       ├── Architecture.tsx
│       ├── DependencyGraph.tsx
│       ├── ModuleDetail.tsx
│       ├── Classes.tsx
│       ├── ClassDetail.tsx
│       ├── ClassCompare.tsx
│       ├── Phases.tsx
│       ├── Nexus.tsx
│       ├── Matchmaking.tsx
│       ├── Commands.tsx
│       ├── Events.tsx
│       ├── I18n.tsx
│       ├── Configuration.tsx
│       ├── Setup.tsx
│       ├── Changelog.tsx
│       └── SearchResults.tsx
├── index.html
├── package.json
├── tsconfig.json
└── vite.config.ts

Getting Started

Prerequisites

Node.js 18+
npm 9+

Install & run

git clone https://github.com/alexissdev/annihilation-web.git
cd annihilation-web
npm install
npm run dev

Open http://localhost:5173.

Build for production

npm run build       # outputs to dist/
npm run preview     # serves the built output locally

Lint

npm run lint

Keyboard Shortcuts

| Shortcut | Action | |---|---| | Cmd+K / Ctrl+K | Focus global search input |

Internationalization

The UI is fully translated in three languages. Switch via the language selector in the top bar.

| Code | Language | |---|---| | EN | English (default) | | ES | Español | | PT | Português |

The selected language is persisted in localStorage under the key anni-lang. To add a new language:

Create src/i18n/xx.ts implementing the Translations interface from types.ts.
Register it in src/i18n/context.tsx alongside en, es, and pt.
Add the language option to the switcher in Topbar.tsx.

Tech Stack

| Tool | Version | Role | |---|---|---| | React | 19 | UI library | | TypeScript | 6 | Type safety | | Vite | 8 | Build tool + dev server | | Tailwind CSS | 4 | Styling | | ESLint | 10 | Linting |

No runtime dependencies beyond React and React DOM. Zero external UI component libraries.

License

MIT — see LICENSE.