# jishnukarri/a2s-discord-arma3-bot architecture

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

- Interactive diagram: https://gitdiagram.com/jishnukarri/a2s-discord-arma3-bot
- Repository: https://github.com/jishnukarri/a2s-discord-arma3-bot

## Overview

This is an Arma 3 Discord server-status and mod-update reminder bot. Discord users see periodically refreshed server/player status and can upload a modlist to configure update reminders. The main bot loads configured servers, runs A2S polling, and publishes a status embed; modlist commands decode uploads, fetch Steam Workshop metadata, persist settings, and start reminder loops. The graph covers the sampled runtime modules and README capabilities; unsampled behavior is not inferred beyond documented features.

Main entry points: [`src/bot/__init__.py`](https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/bot/__init__.py) (Discord bot), [`src/mod_update/__init__.py`](https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/mod_update/__init__.py) (Modlist commands), [`src/config.py`](https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/config.py) (Config and database), [`src/query/a2sQuery.py`](https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/query/a2sQuery.py) (A2S status poller)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["Bot runtime"]
  node_entry["Bot entry<br/>[main.py]"]
  node_bot["Discord bot<br/>[__init__.py]"]
end

subgraph group_status["Server status"]
  node_serverregistry["Server instances<br/>[__init__.py]"]
  node_poller["A2S status poller<br/>[a2sQuery.py]"]
  node_rules["Arma rules decoder<br/>[arma3query_e.py]"]
  node_statusview["Status embed<br/>[__init__.py]"]
  node_statusupdater["Status message updater<br/>[__init__.py]"]
end

subgraph group_modlists["Mod reminders"]
  node_modcommands["Modlist commands<br/>[__init__.py]"]
  node_decoder["Upload decoder"]
  node_steammetadata["Workshop metadata"]
  node_reminder["Update checker"]
end

subgraph group_state["Configuration and state"]
  node_models["Domain models<br/>[data_models.py]"]
  node_configdb["Config and database<br/>[config.py]"]
  node_jsonfile[("JSON database file")]
end

node_operator(("Discord users"))
node_discord(("Discord"))
node_steam(("Steam Workshop API"))
node_steamcommunity(("Steam Community"))
node_game(("Arma 3 servers"))

node_entry -->|"starts"| node_bot
node_bot -->|"connects"| node_discord
node_operator -.->|"uses"| node_discord
node_bot -->|"reads config"| node_configdb
node_bot -->|"registers commands"| node_modcommands
node_bot -->|"loads servers"| node_serverregistry
node_serverregistry -->|"creates poller"| node_poller
node_poller -->|"queries status"| node_game
node_poller -->|"provides status"| node_statusview
node_bot -->|"builds embed"| node_statusview
node_bot -->|"runs updater"| node_statusupdater
node_statusupdater -->|"sends or edits"| node_discord
node_statusupdater -->|"stores message ID"| node_configdb
node_poller -.->|"uses decoder"| node_rules
node_operator -.->|"uploads modlist"| node_modcommands
node_modcommands -->|"decodes upload"| node_decoder
node_modcommands -->|"fetches details"| node_steammetadata
node_steammetadata -->|"requests metadata"| node_steam
node_modcommands -->|"saves modlist"| node_configdb
node_modcommands -->|"starts checker"| node_reminder
node_reminder -->|"refreshes details"| node_steammetadata
node_reminder -->|"updates modlist"| node_configdb
node_reminder -->|"sends reminders"| node_discord
node_rules -->|"looks up names"| node_steamcommunity
node_configdb -->|"reads and writes"| node_jsonfile
node_configdb -->|"loads model data"| node_models
node_bot -->|"uses server models"| node_models
node_modcommands -->|"uses modlist models"| node_models

click node_entry "https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/main.py"
click node_bot "https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/bot/__init__.py"
click node_serverregistry "https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/bot/__init__.py"
click node_poller "https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/query/a2sQuery.py"
click node_rules "https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/query/arma3query_e.py"
click node_statusview "https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/bot/__init__.py"
click node_statusupdater "https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/bot/__init__.py"
click node_modcommands "https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/mod_update/__init__.py"
click node_decoder "https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/mod_update/decodeModlistCommands.py"
click node_steammetadata "https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/mod_update/getSteamInformation.py"
click node_reminder "https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/mod_update/modlistReminderLoop.py"
click node_models "https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/data_models.py"
click node_configdb "https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/config.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_entry,node_bot,node_operator toneBlue
class node_serverregistry,node_poller,node_rules,node_statusview,node_statusupdater toneAmber
class node_modcommands,node_decoder,node_steammetadata,node_reminder,node_steam,node_game toneMint
class node_models,node_configdb,node_jsonfile toneRose
class node_discord,node_steamcommunity toneIndigo
```

## Components

### Bot runtime

- [Bot entry](https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/main.py): `main.py`
- [Discord bot](https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/bot/__init__.py): `src/bot/__init__.py`

### Server status

- [Server instances](https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/bot/__init__.py): `src/bot/__init__.py`
- [A2S status poller](https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/query/a2sQuery.py): `src/query/a2sQuery.py`
- [Arma rules decoder](https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/query/arma3query_e.py): `src/query/arma3query_e.py`
- [Status embed](https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/bot/__init__.py): `src/bot/__init__.py`
- [Status message updater](https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/bot/__init__.py): `src/bot/__init__.py`

### Mod reminders

- [Modlist commands](https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/mod_update/__init__.py): `src/mod_update/__init__.py`
- [Upload decoder](https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/mod_update/decodeModlistCommands.py): `src/mod_update/decodeModlistCommands.py`
- [Workshop metadata](https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/mod_update/getSteamInformation.py): `src/mod_update/getSteamInformation.py`
- [Update checker](https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/mod_update/modlistReminderLoop.py): `src/mod_update/modlistReminderLoop.py`

### Configuration and state

- [Domain models](https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/data_models.py): `src/data_models.py`
- [Config and database](https://github.com/jishnukarri/a2s-discord-arma3-bot/blob/master/src/config.py): `src/config.py`
- **JSON database file**

### Other components

- **Discord users**
- **Discord**
- **Steam Workshop API**
- **Steam Community**
- **Arma 3 servers**

## Connections

- Bot entry → Discord bot: starts (evidence: `main.py`)
- Discord bot → Discord: connects (evidence: `src/bot/__init__.py`)
- Discord users → Discord: uses (evidence: `README.md`)
- Discord bot → Config and database: reads config (evidence: `src/bot/__init__.py`)
- Discord bot → Modlist commands: registers commands (evidence: `src/bot/__init__.py`)
- Discord bot → Server instances: loads servers (evidence: `src/bot/__init__.py`)
- Server instances → A2S status poller: creates poller (evidence: `src/bot/__init__.py`)
- A2S status poller → Arma 3 servers: queries status (evidence: `src/query/a2sQuery.py`)
- A2S status poller → Status embed: provides status (evidence: `src/bot/__init__.py`)
- Discord bot → Status embed: builds embed (evidence: `src/bot/__init__.py`)
- Discord bot → Status message updater: runs updater (evidence: `src/bot/__init__.py`)
- Status message updater → Discord: sends or edits (evidence: `src/bot/__init__.py`)
- Status message updater → Config and database: stores message ID (evidence: `src/bot/__init__.py`)
- A2S status poller → Arma rules decoder: uses decoder (evidence: `src/query/a2sQuery.py`)
- Discord users → Modlist commands: uploads modlist (evidence: `README.md`)
- Modlist commands → Upload decoder: decodes upload (evidence: `src/mod_update/__init__.py`)
- Modlist commands → Workshop metadata: fetches details (evidence: `src/mod_update/__init__.py`)
- Workshop metadata → Steam Workshop API: requests metadata (evidence: `src/mod_update/getSteamInformation.py`)
- Modlist commands → Config and database: saves modlist (evidence: `src/mod_update/__init__.py`)
- Modlist commands → Update checker: starts checker (evidence: `src/mod_update/__init__.py`)
- Update checker → Workshop metadata: refreshes details (evidence: `src/mod_update/modlistReminderLoop.py`)
- Update checker → Config and database: updates modlist (evidence: `src/mod_update/modlistReminderLoop.py`)
- Update checker → Discord: sends reminders (evidence: `src/mod_update/modlistReminderLoop.py`)
- Arma rules decoder → Steam Community: looks up names (evidence: `src/query/arma3query_e.py`)
- Config and database → JSON database file: reads and writes (evidence: `src/config.py`)
- Config and database → Domain models: loads model data (evidence: `src/config.py`)
- Discord bot → Domain models: uses server models (evidence: `src/bot/__init__.py`)
- Modlist commands → Domain models: uses modlist models (evidence: `src/mod_update/__init__.py`)
