# mrcatoff/amxmodx-vs-extension architecture

> Architecture diagram of the GitHub repository mrcatoff/amxmodx-vs-extension, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mrcatoff/amxmodx-vs-extension
- Repository: https://github.com/mrcatoff/amxmodx-vs-extension

## Overview

AmxModX Language is a VS Code Pawn extension. A user edits a Pawn document; the language server parses it, resolves includes and provides editor assistance such as diagnostics, completion, navigation, hover, and symbols. Separately, the user can invoke compilation, which prepares compiler settings and paths, runs amxxpc, and routes compiler output and diagnostics back into VS Code. The README documents the broader feature set; some server registrations and provider implementations were not excerpted, so those relationships are cited to the README or server source index rather than inferred from folder structure.

Main entry points: [`src/server/server.ts`](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/server.ts) (Language Server), [`src/client/compiler/commands.ts`](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/client/compiler/commands.ts) (Compile Commands), [`src/server/features/completion.ts`](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/features/completion.ts) (Completions), [`src/shared/project.ts`](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/shared/project.ts) (Project Resolution)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["VS Code Client"]
  node_extension["Extension Activation<br/>[extension.ts]"]
  node_compile["Compile Commands<br/>[commands.ts]"]
  node_compiler["Compiler Discovery<br/>[executable.ts]"]
  node_run["Compiler Process<br/>[process.ts]"]
  node_output["Compiler Output<br/>[output.ts]"]
  node_settings["Compiler Settings<br/>[settings.ts]"]
end

subgraph group_language["Language Service"]
  node_server["Language Server<br/>[server.ts]"]
  node_parser["Pawn Parser<br/>[parser.ts]"]
  node_tokenizer["Pawn Tokenizer<br/>[tokenizer.ts]"]
  node_completion["Completions<br/>[completion.ts]"]
  node_cursor["Cursor Analysis<br/>[cursor.ts]"]
  node_navigation["Navigation<br/>[definition.ts]"]
  node_hover["Hover Help<br/>[hover.ts]"]
  node_signature["Signature Help<br/>[signature.ts]"]
  node_symbols["Document Symbols"]
  node_folding["Code Folding<br/>[folding.ts]"]
  node_links["Include Links<br/>[document-links.ts]"]
end

subgraph group_workspace["Workspace Analysis"]
  node_resolver["Include Resolver"]
  node_dependencies["Dependency Tracking"]
  node_collector["Symbol Collection"]
  node_project["Project Resolution<br/>[project.ts]"]
  node_amxxpack["Amxxpack Config<br/>[amxxpack.ts]"]
end

subgraph group_shared["Shared Support"]
  node_pathvars["Path Variables<br/>[path-variables.ts]"]
  node_sharedsettings["Shared Settings<br/>[settings.ts]"]
  node_strings["String Utilities<br/>[strings.ts]"]
  node_localization["Localization<br/>[l10n.ts]"]
end

node_user(("Pawn Developer"))
node_vscode["VS Code Editor"]
node_pawn["Pawn Document"]
node_amxxpc["amxxpc"]

node_user -->|"edits and invokes"| node_vscode
node_vscode -->|"activates"| node_extension
node_vscode -->|"opens"| node_pawn
node_extension -->|"registers commands"| node_compile
node_extension -.->|"starts language service"| node_server
node_pawn -->|"sends document changes"| node_server
node_server -->|"parses documents"| node_parser
node_parser -->|"tokenizes input"| node_tokenizer
node_server -->|"resolves include paths"| node_resolver
node_server -->|"tracks included files"| node_dependencies
node_server -->|"collects symbols"| node_collector
node_server -->|"provides completion"| node_completion
node_completion -->|"reads parse results"| node_parser
node_completion -->|"uses cursor analysis"| node_cursor
node_server -->|"provides definitions"| node_navigation
node_server -->|"provides hover"| node_hover
node_server -->|"provides signatures"| node_signature
node_server -->|"provides outline"| node_symbols
node_server -->|"provides folding"| node_folding
node_server -->|"provides include links"| node_links
node_server -->|"resolves workspace project"| node_project
node_project -->|"loads project config"| node_amxxpack
node_completion -->|"collects candidates"| node_collector
node_completion -->|"queries dependencies"| node_dependencies
node_navigation -->|"uses symbols"| node_collector
node_hover -->|"uses symbols"| node_collector
node_signature -->|"finds active parameter"| node_cursor
node_cursor -->|"uses character helpers"| node_strings
node_project -->|"expands configured paths"| node_pathvars
node_compile -->|"reads compiler settings"| node_settings
node_compile -->|"expands compiler paths"| node_pathvars
node_compile -->|"resolves project includes"| node_project
node_compile -->|"checks executable"| node_compiler
node_compile -->|"runs compiler"| node_run
node_run -->|"invokes"| node_amxxpc
node_run -->|"routes compiler output"| node_output
node_compile -->|"reports problems"| node_vscode
node_server -->|"translates messages"| node_localization
node_compile -->|"translates output"| node_localization

click node_extension "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/client/extension.ts"
click node_compile "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/client/compiler/commands.ts"
click node_compiler "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/client/compiler/executable.ts"
click node_run "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/client/compiler/process.ts"
click node_output "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/client/compiler/output.ts"
click node_settings "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/client/compiler/settings.ts"
click node_server "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/server.ts"
click node_parser "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/parser/parser.ts"
click node_tokenizer "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/parser/tokenizer.ts"
click node_completion "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/features/completion.ts"
click node_cursor "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/features/cursor.ts"
click node_navigation "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/features/definition.ts"
click node_hover "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/features/hover.ts"
click node_signature "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/features/signature.ts"
click node_symbols "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/features/document-symbols.ts"
click node_folding "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/features/folding.ts"
click node_links "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/features/document-links.ts"
click node_resolver "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/workspace/include-resolver.ts"
click node_dependencies "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/workspace/dependency-manager.ts"
click node_collector "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/workspace/symbol-collector.ts"
click node_project "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/shared/project.ts"
click node_amxxpack "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/shared/amxxpack.ts"
click node_pathvars "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/shared/path-variables.ts"
click node_sharedsettings "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/shared/settings.ts"
click node_strings "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/shared/strings.ts"
click node_localization "https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/shared/l10n.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_extension,node_compile,node_compiler,node_run,node_output,node_settings toneBlue
class node_server,node_parser,node_tokenizer,node_completion,node_cursor,node_navigation,node_hover,node_signature,node_symbols,node_folding,node_links toneAmber
class node_resolver,node_dependencies,node_collector,node_project,node_amxxpack toneMint
class node_pathvars,node_sharedsettings,node_strings,node_localization toneRose
class node_user,node_vscode,node_pawn,node_amxxpc toneIndigo
```

## Components

### VS Code Client

- [Extension Activation](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/client/extension.ts): `src/client/extension.ts`
- [Compile Commands](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/client/compiler/commands.ts): `src/client/compiler/commands.ts`
- [Compiler Discovery](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/client/compiler/executable.ts): `src/client/compiler/executable.ts`
- [Compiler Process](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/client/compiler/process.ts): `src/client/compiler/process.ts`
- [Compiler Output](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/client/compiler/output.ts): `src/client/compiler/output.ts`
- [Compiler Settings](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/client/compiler/settings.ts): `src/client/compiler/settings.ts`

### Language Service

- [Language Server](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/server.ts): `src/server/server.ts`
- [Pawn Parser](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/parser/parser.ts): `src/server/parser/parser.ts`
- [Pawn Tokenizer](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/parser/tokenizer.ts): `src/server/parser/tokenizer.ts`
- [Completions](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/features/completion.ts): `src/server/features/completion.ts`
- [Cursor Analysis](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/features/cursor.ts): `src/server/features/cursor.ts`
- [Navigation](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/features/definition.ts): `src/server/features/definition.ts`
- [Hover Help](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/features/hover.ts): `src/server/features/hover.ts`
- [Signature Help](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/features/signature.ts): `src/server/features/signature.ts`
- [Document Symbols](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/features/document-symbols.ts): `src/server/features/document-symbols.ts`
- [Code Folding](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/features/folding.ts): `src/server/features/folding.ts`
- [Include Links](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/features/document-links.ts): `src/server/features/document-links.ts`

### Workspace Analysis

- [Include Resolver](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/workspace/include-resolver.ts): `src/server/workspace/include-resolver.ts`
- [Dependency Tracking](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/workspace/dependency-manager.ts): `src/server/workspace/dependency-manager.ts`
- [Symbol Collection](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/server/workspace/symbol-collector.ts): `src/server/workspace/symbol-collector.ts`
- [Project Resolution](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/shared/project.ts): `src/shared/project.ts`
- [Amxxpack Config](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/shared/amxxpack.ts): `src/shared/amxxpack.ts`

### Shared Support

- [Path Variables](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/shared/path-variables.ts): `src/shared/path-variables.ts`
- [Shared Settings](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/shared/settings.ts): `src/shared/settings.ts`
- [String Utilities](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/shared/strings.ts): `src/shared/strings.ts`
- [Localization](https://github.com/mrcatoff/amxmodx-vs-extension/blob/main/src/shared/l10n.ts): `src/shared/l10n.ts`

### Other components

- **Pawn Developer**
- **VS Code Editor**
- **Pawn Document**
- **amxxpc**

## Connections

- Pawn Developer → VS Code Editor: edits and invokes (evidence: `README.md`)
- VS Code Editor → Extension Activation: activates (evidence: `README.md`)
- VS Code Editor → Pawn Document: opens (evidence: `README.md`)
- Extension Activation → Compile Commands: registers commands (evidence: `src/client/extension.ts`)
- Extension Activation → Language Server: starts language service
- Pawn Document → Language Server: sends document changes (evidence: `README.md`)
- Language Server → Pawn Parser: parses documents (evidence: `src/server/server.ts`)
- Pawn Parser → Pawn Tokenizer: tokenizes input (evidence: `src/server/parser/parser.ts`)
- Language Server → Include Resolver: resolves include paths (evidence: `src/server/server.ts`)
- Language Server → Dependency Tracking: tracks included files (evidence: `src/server/server.ts`)
- Language Server → Symbol Collection: collects symbols (evidence: `src/server/server.ts`)
- Language Server → Completions: provides completion (evidence: `src/server/features/completion.ts`)
- Completions → Pawn Parser: reads parse results (evidence: `src/server/features/completion.ts`)
- Completions → Cursor Analysis: uses cursor analysis (evidence: `src/server/features/completion.ts`)
- Language Server → Navigation: provides definitions (evidence: `src/server/features/definition.ts`)
- Language Server → Hover Help: provides hover (evidence: `src/server/server.ts`)
- Language Server → Signature Help: provides signatures (evidence: `src/server/server.ts`)
- Language Server → Document Symbols: provides outline (evidence: `src/server/server.ts`)
- Language Server → Code Folding: provides folding (evidence: `src/server/server.ts`)
- Language Server → Include Links: provides include links (evidence: `src/server/server.ts`)
- Language Server → Project Resolution: resolves workspace project (evidence: `src/server/server.ts`)
- Project Resolution → Amxxpack Config: loads project config (evidence: `src/shared/project.ts`)
- Completions → Symbol Collection: collects candidates (evidence: `src/server/features/completion.ts`)
- Completions → Dependency Tracking: queries dependencies (evidence: `src/server/features/completion.ts`)
- Navigation → Symbol Collection: uses symbols (evidence: `src/server/features/definition.ts`)
- Hover Help → Symbol Collection: uses symbols (evidence: `src/server/features/hover.ts`)
- Signature Help → Cursor Analysis: finds active parameter (evidence: `src/server/features/signature.ts`)
- Cursor Analysis → String Utilities: uses character helpers (evidence: `src/server/features/cursor.ts`)
- Project Resolution → Path Variables: expands configured paths (evidence: `src/shared/project.ts`)
- Compile Commands → Compiler Settings: reads compiler settings (evidence: `src/client/compiler/commands.ts`)
- Compile Commands → Path Variables: expands compiler paths (evidence: `src/client/compiler/commands.ts`)
- Compile Commands → Project Resolution: resolves project includes (evidence: `src/client/compiler/commands.ts`)
- Compile Commands → Compiler Discovery: checks executable (evidence: `src/client/compiler/commands.ts`)
- Compile Commands → Compiler Process: runs compiler (evidence: `src/client/compiler/commands.ts`)
- Compiler Process → amxxpc: invokes (evidence: `README.md`)
- Compiler Process → Compiler Output: routes compiler output (evidence: `src/client/compiler/commands.ts`)
- Compile Commands → VS Code Editor: reports problems (evidence: `README.md`)
- Language Server → Localization: translates messages (evidence: `src/server/server.ts`)
- Compile Commands → Localization: translates output (evidence: `src/client/compiler/commands.ts`)
