# soulsmods/modengine2 architecture

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

- Interactive diagram: https://gitdiagram.com/soulsmods/modengine2
- Repository: https://github.com/soulsmods/modengine2

## Overview

Mod Engine 2 injects runtime modding support into supported Souls games. The principal flow is launcher configuration and game startup, followed by DLL initialization, settings/game detection, extension attachment, and runtime hooks, patches, and scripts. The graph also preserves documented profiling, crash reporting, debugging, and multi-mod loading capabilities. Edges are limited to relationships visible in excerpts, the SOURCE INDEX, or README; several extension internals are unsampled, so their implementation-level links are omitted.

Main entry points: [`src/modengine/mod_engine.cpp`](https://github.com/soulsmods/modengine2/blob/main/src/modengine/mod_engine.cpp) (ModEngine runtime), [`src/main.cpp`](https://github.com/soulsmods/modengine2/blob/main/src/main.cpp) (DLL entrypoint), [`launcher/launcher.cpp`](https://github.com/soulsmods/modengine2/blob/main/launcher/launcher.cpp) (Mod launcher), [`src/modengine/crash_handler.cpp`](https://github.com/soulsmods/modengine2/blob/main/src/modengine/crash_handler.cpp) (Crash handling)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_launch["Launch and configuration"]
  node_launcher["Mod launcher<br/>[launcher.cpp]"]
  node_steam["Steam game location<br/>[steam_app_path.cpp]"]
  node_settings["TOML settings<br/>[settings.h]"]
  node_settings_loader["Settings loading"]
end

subgraph group_runtime["Runtime core"]
  node_entry["DLL entrypoint<br/>[main.cpp]"]
  node_game_info["Game detection<br/>[game_info.cpp]"]
  node_engine["ModEngine runtime<br/>[mod_engine.cpp]"]
  node_extension_api["Extension API<br/>[extension.h]"]
  node_extension_set["Extension registry<br/>[extension_set.cpp]"]
  node_hook_set["Hook management<br/>[hook_set.cpp]"]
  node_scanner["Memory scanning<br/>[memory_scanner.h]"]
end

subgraph group_extensions["Extensions"]
  node_mod_loader["Mod file overrides"]
  node_mod_config["Multiple mod configuration"]
  node_debug_menu["DS3 debug menu<br/>[debug_menu_ds3.cpp]"]
end

subgraph group_tooling["Creator tooling"]
  node_profiling["Optick profiling"]
  node_scripting["Lua scripting<br/>[script_host.cpp]"]
  node_patch_api["Script patch API<br/>[api_patch.cpp]"]
end

subgraph group_support["Diagnostics"]
  node_crash["Crash handling<br/>[crash_handler.cpp]"]
  node_crash_store[("Crash dump database")]
  node_scylla["ScyllaHide integration"]
end

node_user(("Game user"))
node_game["Supported game"]

node_user -->|"launches"| node_launcher
node_launcher -->|"locates game"| node_steam
node_launcher -->|"starts with DLL"| node_game
node_launcher -->|"passes configuration"| node_entry
node_entry -->|"starts handler"| node_crash
node_entry -->|"loads settings"| node_settings_loader
node_entry -->|"detects game"| node_game_info
node_entry -->|"creates and attaches"| node_engine
node_settings_loader -.->|"parses TOML"| node_settings
node_engine -->|"loads extensions"| node_extension_set
node_engine -->|"registers extension"| node_mod_loader
node_engine -->|"registers extension"| node_profiling
node_engine -->|"registers extension"| node_scylla
node_engine -->|"references extension"| node_debug_menu
node_engine -->|"installs hooks"| node_hook_set
node_engine -->|"scans for patches"| node_scanner
node_extension_api -->|"registers hooks"| node_hook_set
node_extension_api -->|"exposes scanning"| node_scanner
node_engine -->|"binds patch API"| node_patch_api
node_engine -->|"loads scripts"| node_scripting
node_crash -->|"initializes database"| node_crash_store
node_crash -.->|"uploads reports"| node_user

click node_launcher "https://github.com/soulsmods/modengine2/blob/main/launcher/launcher.cpp"
click node_steam "https://github.com/soulsmods/modengine2/blob/main/launcher/steam_app_path.cpp"
click node_settings "https://github.com/soulsmods/modengine2/blob/main/include/modengine/settings.h"
click node_settings_loader "https://github.com/soulsmods/modengine2/blob/main/src/modengine/settings_loader.cpp"
click node_entry "https://github.com/soulsmods/modengine2/blob/main/src/main.cpp"
click node_game_info "https://github.com/soulsmods/modengine2/blob/main/src/modengine/game_info.cpp"
click node_engine "https://github.com/soulsmods/modengine2/blob/main/src/modengine/mod_engine.cpp"
click node_extension_api "https://github.com/soulsmods/modengine2/blob/main/include/modengine/extension.h"
click node_extension_set "https://github.com/soulsmods/modengine2/blob/main/src/modengine/extension_set.cpp"
click node_hook_set "https://github.com/soulsmods/modengine2/blob/main/src/modengine/hook_set.cpp"
click node_scanner "https://github.com/soulsmods/modengine2/blob/main/include/modengine/util/memory_scanner.h"
click node_mod_loader "https://github.com/soulsmods/modengine2/blob/main/src/modengine/ext/mod_loader/archive_file_overrides.cpp"
click node_mod_config "https://github.com/soulsmods/modengine2/blob/main/src/modengine/ext/mod_loader/mod_loader_extension.cpp"
click node_debug_menu "https://github.com/soulsmods/modengine2/blob/main/src/modengine/ext/debug_menu/ds3/debug_menu_ds3.cpp"
click node_profiling "https://github.com/soulsmods/modengine2/blob/main/src/modengine/ext/profiling/profiling_extension.cpp"
click node_scripting "https://github.com/soulsmods/modengine2/blob/main/src/modengine/script_host.cpp"
click node_patch_api "https://github.com/soulsmods/modengine2/blob/main/src/modengine/scripting/api_patch.cpp"
click node_crash "https://github.com/soulsmods/modengine2/blob/main/src/modengine/crash_handler.cpp"
click node_scylla "https://github.com/soulsmods/modengine2/blob/main/src/modengine/ext/scylla/scyllahide_extension.cpp"

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_launcher,node_steam,node_settings,node_settings_loader,node_user toneBlue
class node_entry,node_game_info,node_engine,node_extension_api,node_extension_set,node_hook_set,node_scanner toneAmber
class node_mod_loader,node_mod_config,node_debug_menu toneMint
class node_profiling,node_scripting,node_patch_api toneRose
class node_crash,node_crash_store,node_scylla,node_game toneIndigo
```

## Components

### Launch and configuration

- [Mod launcher](https://github.com/soulsmods/modengine2/blob/main/launcher/launcher.cpp): `launcher/launcher.cpp`
- [Steam game location](https://github.com/soulsmods/modengine2/blob/main/launcher/steam_app_path.cpp): `launcher/steam_app_path.cpp`
- [TOML settings](https://github.com/soulsmods/modengine2/blob/main/include/modengine/settings.h): `include/modengine/settings.h`
- [Settings loading](https://github.com/soulsmods/modengine2/blob/main/src/modengine/settings_loader.cpp): `src/modengine/settings_loader.cpp`

### Runtime core

- [DLL entrypoint](https://github.com/soulsmods/modengine2/blob/main/src/main.cpp): `src/main.cpp`
- [Game detection](https://github.com/soulsmods/modengine2/blob/main/src/modengine/game_info.cpp): `src/modengine/game_info.cpp`
- [ModEngine runtime](https://github.com/soulsmods/modengine2/blob/main/src/modengine/mod_engine.cpp): `src/modengine/mod_engine.cpp`
- [Extension API](https://github.com/soulsmods/modengine2/blob/main/include/modengine/extension.h): `include/modengine/extension.h`
- [Extension registry](https://github.com/soulsmods/modengine2/blob/main/src/modengine/extension_set.cpp): `src/modengine/extension_set.cpp`
- [Hook management](https://github.com/soulsmods/modengine2/blob/main/src/modengine/hook_set.cpp): `src/modengine/hook_set.cpp`
- [Memory scanning](https://github.com/soulsmods/modengine2/blob/main/include/modengine/util/memory_scanner.h): `include/modengine/util/memory_scanner.h`

### Extensions

- [Mod file overrides](https://github.com/soulsmods/modengine2/blob/main/src/modengine/ext/mod_loader/archive_file_overrides.cpp): `src/modengine/ext/mod_loader/archive_file_overrides.cpp`
- [Multiple mod configuration](https://github.com/soulsmods/modengine2/blob/main/src/modengine/ext/mod_loader/mod_loader_extension.cpp): `src/modengine/ext/mod_loader/mod_loader_extension.cpp`
- [DS3 debug menu](https://github.com/soulsmods/modengine2/blob/main/src/modengine/ext/debug_menu/ds3/debug_menu_ds3.cpp): `src/modengine/ext/debug_menu/ds3/debug_menu_ds3.cpp`

### Creator tooling

- [Optick profiling](https://github.com/soulsmods/modengine2/blob/main/src/modengine/ext/profiling/profiling_extension.cpp): `src/modengine/ext/profiling/profiling_extension.cpp`
- [Lua scripting](https://github.com/soulsmods/modengine2/blob/main/src/modengine/script_host.cpp): `src/modengine/script_host.cpp`
- [Script patch API](https://github.com/soulsmods/modengine2/blob/main/src/modengine/scripting/api_patch.cpp): `src/modengine/scripting/api_patch.cpp`

### Diagnostics

- [Crash handling](https://github.com/soulsmods/modengine2/blob/main/src/modengine/crash_handler.cpp): `src/modengine/crash_handler.cpp`
- **Crash dump database**
- [ScyllaHide integration](https://github.com/soulsmods/modengine2/blob/main/src/modengine/ext/scylla/scyllahide_extension.cpp): `src/modengine/ext/scylla/scyllahide_extension.cpp`

### Other components

- **Game user**
- **Supported game**

## Connections

- Game user → Mod launcher: launches
- Mod launcher → Steam game location: locates game (evidence: `launcher/launcher.cpp`)
- Mod launcher → Supported game: starts with DLL
- Mod launcher → DLL entrypoint: passes configuration
- DLL entrypoint → Crash handling: starts handler (evidence: `src/main.cpp`)
- DLL entrypoint → Settings loading: loads settings (evidence: `src/main.cpp`)
- DLL entrypoint → Game detection: detects game (evidence: `src/main.cpp`)
- DLL entrypoint → ModEngine runtime: creates and attaches (evidence: `src/main.cpp`)
- Settings loading → TOML settings: parses TOML
- ModEngine runtime → Extension registry: loads extensions (evidence: `src/modengine/mod_engine.cpp`)
- ModEngine runtime → Mod file overrides: registers extension (evidence: `src/modengine/mod_engine.cpp`)
- ModEngine runtime → Optick profiling: registers extension (evidence: `src/modengine/mod_engine.cpp`)
- ModEngine runtime → ScyllaHide integration: registers extension (evidence: `src/modengine/mod_engine.cpp`)
- ModEngine runtime → DS3 debug menu: references extension (evidence: `src/modengine/mod_engine.cpp`)
- ModEngine runtime → Hook management: installs hooks (evidence: `src/modengine/mod_engine.cpp`)
- ModEngine runtime → Memory scanning: scans for patches (evidence: `src/modengine/mod_engine.cpp`)
- Extension API → Hook management: registers hooks (evidence: `include/modengine/extension.h`)
- Extension API → Memory scanning: exposes scanning (evidence: `include/modengine/extension.h`)
- ModEngine runtime → Script patch API: binds patch API (evidence: `src/modengine/mod_engine.cpp`)
- ModEngine runtime → Lua scripting: loads scripts (evidence: `src/modengine/mod_engine.cpp`)
- Crash handling → Crash dump database: initializes database (evidence: `src/modengine/crash_handler.cpp`)
- Crash handling → Game user: uploads reports
