# chrisherkins/archipelago_terraria_client architecture

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

- Interactive diagram: https://gitdiagram.com/chrisherkins/archipelago_terraria_client
- Repository: https://github.com/chrisherkins/archipelago_terraria_client

## Overview

This repository pairs a Terraria tModLoader client with an Archipelago Terraria world implementation. Players configure and connect the mod to a multiworld session; Terraria boss/event progress becomes location checks, while received items and flags alter the world and unlock progression. The separate APWorld defines checks, options, regions, rules, and rewards. Edges are limited to explicit README statements and sampled/indexed references; some runtime dispatch details are not visible in the excerpts.

Main entry points: [`Systems/ArchipelagoSystem.cs`](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/Systems/ArchipelagoSystem.cs) (Session Runtime), [`SeldomArchipelago.cs`](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/SeldomArchipelago.cs) (Mod Entry), [`TerrariaAPWorld/__init__.py`](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/TerrariaAPWorld/__init__.py) (World Definition), [`UI/CollectionButton.cs`](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/UI/CollectionButton.cs) (Collection UI)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Terraria Client"]
  node_config["Connection Config<br/>[Config.cs]"]
  node_modentry["Mod Entry"]
  node_apruntime["Session Runtime"]
  node_commands["AP Commands"]
  node_playerstate["Player State"]
  node_flagstarter["Flag Starters<br/>[FlagStarter.cs]"]
end

subgraph group_world["Archipelago World"]
  node_apworld["World Definition<br/>[__init__.py]"]
  node_checks["Check Catalog<br/>[Checks.py]"]
  node_options["World Options<br/>[Options.py]"]
  node_entities["Entity Data<br/>[Entities.py]"]
  node_dataloader["Data Loader<br/>[DataLoader.py]"]
  node_items["Item Definitions<br/>[Items.py]"]
  node_resources["World Resources<br/>[Resources.py]"]
  node_logic["Progression Rules<br/>[__init__.py]"]
end

subgraph group_presentation["Player Interface"]
  node_collectionui["Collection UI"]
  node_collectionnpc["Collection NPC<br/>[CollectionNPC.cs]"]
end

subgraph group_integration["Game Integration"]
  node_ghostnpc["Ghost NPCs<br/>[GhostNPC.cs]"]
  node_globalnpc["NPC Checks"]
  node_calamity["Calamity Hooks<br/>[CalamitySystem.cs]"]
  node_tilehooks["Tile Hooks"]
end

node_player(("Terraria Player"))
node_apserver{{"Archipelago Server"}}

node_player -->|"configures"| node_config
node_player -->|"uses"| node_commands
node_modentry -->|"uses"| node_apruntime
node_config -->|"configures"| node_apruntime
node_commands -->|"invokes"| node_apruntime
node_apruntime -->|"connects"| node_apserver
node_apruntime -->|"updates"| node_playerstate
node_flagstarter -->|"checks flags"| node_apruntime
node_collectionui -->|"spawns"| node_collectionnpc
node_collectionui -->|"reads rewards"| node_apruntime
node_modentry -->|"uses"| node_collectionui
node_modentry -->|"uses"| node_ghostnpc
node_modentry -->|"uses"| node_calamity
node_modentry -->|"registers"| node_globalnpc
node_modentry -->|"registers"| node_tilehooks
node_calamity -->|"reports progress"| node_apruntime
node_apworld -->|"loads"| node_checks
node_apworld -->|"uses"| node_options
node_apworld -->|"uses"| node_resources
node_checks -->|"referenced by"| node_items
node_dataloader -->|"loads"| node_entities
node_apworld -->|"defines rules"| node_logic
node_apworld -->|"runs within"| node_apserver
node_playerstate -->|"sends deathlink"| node_apruntime
node_apruntime -->|"grants flags"| node_flagstarter

click node_config "https://github.com/chrisherkins/archipelago_terraria_client/blob/main/Config/Config.cs"
click node_modentry "https://github.com/chrisherkins/archipelago_terraria_client/blob/main/SeldomArchipelago.cs"
click node_apruntime "https://github.com/chrisherkins/archipelago_terraria_client/blob/main/Systems/ArchipelagoSystem.cs"
click node_commands "https://github.com/chrisherkins/archipelago_terraria_client/tree/main/Command"
click node_playerstate "https://github.com/chrisherkins/archipelago_terraria_client/blob/main/Players/ArchipelagoPlayer.cs"
click node_flagstarter "https://github.com/chrisherkins/archipelago_terraria_client/blob/main/FlagItem/FlagStarter.cs"
click node_collectionui "https://github.com/chrisherkins/archipelago_terraria_client/blob/main/UI/CollectionButton.cs"
click node_collectionnpc "https://github.com/chrisherkins/archipelago_terraria_client/blob/main/NPCs/CollectionNPC.cs"
click node_ghostnpc "https://github.com/chrisherkins/archipelago_terraria_client/blob/main/NPCs/GhostNPC.cs"
click node_globalnpc "https://github.com/chrisherkins/archipelago_terraria_client/blob/main/NPCs/ArchipelagoGlobalNPC.cs"
click node_calamity "https://github.com/chrisherkins/archipelago_terraria_client/blob/main/Systems/CalamitySystem.cs"
click node_tilehooks "https://github.com/chrisherkins/archipelago_terraria_client/blob/main/Tile/ArchipelagoGlobalTile.cs"
click node_apworld "https://github.com/chrisherkins/archipelago_terraria_client/blob/main/TerrariaAPWorld/__init__.py"
click node_checks "https://github.com/chrisherkins/archipelago_terraria_client/blob/main/TerrariaAPWorld/Checks.py"
click node_options "https://github.com/chrisherkins/archipelago_terraria_client/blob/main/TerrariaAPWorld/Options.py"
click node_entities "https://github.com/chrisherkins/archipelago_terraria_client/blob/main/TerrariaAPWorld/Entities.py"
click node_dataloader "https://github.com/chrisherkins/archipelago_terraria_client/blob/main/TerrariaAPWorld/DataLoader.py"
click node_items "https://github.com/chrisherkins/archipelago_terraria_client/blob/main/TerrariaAPWorld/Items.py"
click node_resources "https://github.com/chrisherkins/archipelago_terraria_client/blob/main/TerrariaAPWorld/Resources.py"
click node_logic "https://github.com/chrisherkins/archipelago_terraria_client/blob/main/TerrariaAPWorld/__init__.py"

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_config,node_modentry,node_apruntime,node_commands,node_playerstate,node_flagstarter toneBlue
class node_apworld,node_checks,node_options,node_entities,node_dataloader,node_items,node_resources,node_logic toneAmber
class node_collectionui,node_collectionnpc,node_apserver toneMint
class node_ghostnpc,node_globalnpc,node_calamity,node_tilehooks toneRose
class node_player toneIndigo
```

## Components

### Terraria Client

- [Connection Config](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/Config/Config.cs): `Config/Config.cs`
- [Mod Entry](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/SeldomArchipelago.cs): `SeldomArchipelago.cs`
- [Session Runtime](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/Systems/ArchipelagoSystem.cs): `Systems/ArchipelagoSystem.cs`
- [AP Commands](https://github.com/chrisherkins/archipelago_terraria_client/tree/main/Command): `Command`
- [Player State](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/Players/ArchipelagoPlayer.cs): `Players/ArchipelagoPlayer.cs`
- [Flag Starters](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/FlagItem/FlagStarter.cs): `FlagItem/FlagStarter.cs`

### Archipelago World

- [World Definition](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/TerrariaAPWorld/__init__.py): `TerrariaAPWorld/__init__.py`
- [Check Catalog](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/TerrariaAPWorld/Checks.py): `TerrariaAPWorld/Checks.py`
- [World Options](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/TerrariaAPWorld/Options.py): `TerrariaAPWorld/Options.py`
- [Entity Data](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/TerrariaAPWorld/Entities.py): `TerrariaAPWorld/Entities.py`
- [Data Loader](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/TerrariaAPWorld/DataLoader.py): `TerrariaAPWorld/DataLoader.py`
- [Item Definitions](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/TerrariaAPWorld/Items.py): `TerrariaAPWorld/Items.py`
- [World Resources](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/TerrariaAPWorld/Resources.py): `TerrariaAPWorld/Resources.py`
- [Progression Rules](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/TerrariaAPWorld/__init__.py): `TerrariaAPWorld/__init__.py`

### Player Interface

- [Collection UI](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/UI/CollectionButton.cs): `UI/CollectionButton.cs`
- [Collection NPC](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/NPCs/CollectionNPC.cs): `NPCs/CollectionNPC.cs`

### Game Integration

- [Ghost NPCs](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/NPCs/GhostNPC.cs): `NPCs/GhostNPC.cs`
- [NPC Checks](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/NPCs/ArchipelagoGlobalNPC.cs): `NPCs/ArchipelagoGlobalNPC.cs`
- [Calamity Hooks](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/Systems/CalamitySystem.cs): `Systems/CalamitySystem.cs`
- [Tile Hooks](https://github.com/chrisherkins/archipelago_terraria_client/blob/main/Tile/ArchipelagoGlobalTile.cs): `Tile/ArchipelagoGlobalTile.cs`

### Other components

- **Terraria Player**
- **Archipelago Server**

## Connections

- Terraria Player → Connection Config: configures (evidence: `README.md`)
- Terraria Player → AP Commands: uses (evidence: `README.md`)
- Mod Entry → Session Runtime: uses (evidence: `SeldomArchipelago.cs`)
- Connection Config → Session Runtime: configures (evidence: `Config/Config.cs`)
- AP Commands → Session Runtime: invokes (evidence: `Command/ApCommand.cs`)
- Session Runtime → Archipelago Server: connects (evidence: `README.md`)
- Session Runtime → Player State: updates (evidence: `Systems/ArchipelagoSystem.cs`)
- Flag Starters → Session Runtime: checks flags (evidence: `FlagItem/FlagStarter.cs`)
- Collection UI → Collection NPC: spawns (evidence: `UI/CollectionButton.cs`)
- Collection UI → Session Runtime: reads rewards (evidence: `UI/CollectionButton.cs`)
- Mod Entry → Collection UI: uses (evidence: `SeldomArchipelago.cs`)
- Mod Entry → Ghost NPCs: uses (evidence: `SeldomArchipelago.cs`)
- Mod Entry → Calamity Hooks: uses (evidence: `SeldomArchipelago.cs`)
- Mod Entry → NPC Checks: registers (evidence: `NPCs/ArchipelagoGlobalNPC.cs`)
- Mod Entry → Tile Hooks: registers (evidence: `Tile/ArchipelagoGlobalTile.cs`)
- Calamity Hooks → Session Runtime: reports progress (evidence: `Systems/CalamitySystem.cs`)
- World Definition → Check Catalog: loads (evidence: `TerrariaAPWorld/__init__.py`)
- World Definition → World Options: uses (evidence: `TerrariaAPWorld/__init__.py`)
- World Definition → World Resources: uses (evidence: `TerrariaAPWorld/__init__.py`)
- Check Catalog → Item Definitions: referenced by (evidence: `TerrariaAPWorld/Items.py`)
- Data Loader → Entity Data: loads (evidence: `TerrariaAPWorld/DataLoader.py`)
- World Definition → Progression Rules: defines rules (evidence: `TerrariaAPWorld/__init__.py`)
- World Definition → Archipelago Server: runs within (evidence: `README.md`)
- Player State → Session Runtime: sends deathlink (evidence: `Players/ArchipelagoPlayer.cs`)
- Session Runtime → Flag Starters: grants flags (evidence: `Systems/ArchipelagoSystem.cs`)
