# pingouinn/pingouinmod architecture

> Architecture diagram of the GitHub repository pingouinn/pingouinmod, 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/pingouinn/pingouinmod
- Repository: https://github.com/pingouinn/pingouinmod

## Overview

PingouinMod is a UE4SS Lua framework for Rescue Ops: Wildfire. Its documented runtime entry point is `main.lua`, alongside the utility API, configuration parser, and isolated gameplay and debug features. The graph preserves the README’s listed utility modules and product capabilities. Source excerpts were not provided, so relationships are limited to the README’s architecture and feature descriptions; implementation-level calls are unverified.

Main entry points: [`scripts/main.lua`](https://github.com/pingouinn/pingouinmod/blob/main/scripts/main.lua) (Mod entry point), [`scripts/code/utils/Utils.lua`](https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/utils/Utils.lua) (Utility API), [`scripts/code/ShortNamingUtils.lua`](https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/ShortNamingUtils.lua) (Short naming), [`scripts/config.ini`](https://github.com/pingouinn/pingouinmod/blob/main/scripts/config.ini) (Mod configuration)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["Runtime and configuration"]
  node_main["Mod entry point<br/>[main.lua]"]
  node_lip["INI parser<br/>[LIP.lua]"]
  node_config["Mod configuration<br/>[config.ini]"]
end

subgraph group_utilities["Utility API"]
  node_utils["Utility API<br/>[Utils.lua]"]
  node_types["UE4SS types<br/>[Types.lua]"]
  node_math["Vector math<br/>[Math.lua]"]
  node_entity["Entity helpers<br/>[Entity.lua]"]
  node_world["World helpers<br/>[World.lua]"]
  node_path["Path helpers<br/>[Path.lua]"]
end

subgraph group_gameplay["Gameplay features"]
  node_cheats["Player cheats<br/>[PlayerCheat.lua]"]
  node_teleport["Teleportation<br/>[Teleport.lua]"]
  node_noclip["NoClip<br/>[NoClip.lua]"]
  node_spawner["Actor spawner<br/>[Spawner.lua]"]
  node_naming["Short naming"]
end

subgraph group_debug["Debug tools"]
  node_outline["Entity outline<br/>[EntityOutline.lua]"]
  node_barrier["Barrier opener<br/>[BarrierOpener.lua]"]
  node_boundaries["Boundary disabling"]
end

node_ue4ss["UE4SS"]

node_ue4ss -->|"loads mod"| node_main
node_main -->|"entry architecture"| node_utils
node_main -->|"entry architecture"| node_lip
node_main -->|"feature module"| node_cheats
node_main -->|"feature module"| node_teleport
node_main -->|"feature module"| node_noclip
node_main -->|"feature module"| node_spawner
node_main -->|"feature module"| node_naming
node_main -->|"feature module"| node_outline
node_main -->|"feature module"| node_barrier
node_main -->|"feature module"| node_boundaries
node_utils -->|"API module"| node_types
node_utils -->|"API module"| node_math
node_utils -->|"API module"| node_entity
node_utils -->|"API module"| node_world
node_utils -->|"API module"| node_path
node_config -->|"provides names"| node_naming

click node_main "https://github.com/pingouinn/pingouinmod/blob/main/scripts/main.lua"
click node_lip "https://github.com/pingouinn/pingouinmod/blob/main/scripts/dependencies/LIP.lua"
click node_config "https://github.com/pingouinn/pingouinmod/blob/main/scripts/config.ini"
click node_utils "https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/utils/Utils.lua"
click node_types "https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/utils/Types.lua"
click node_math "https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/utils/Math.lua"
click node_entity "https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/utils/Entity.lua"
click node_world "https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/utils/World.lua"
click node_path "https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/utils/Path.lua"
click node_cheats "https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/PlayerCheat.lua"
click node_teleport "https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/Teleport.lua"
click node_noclip "https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/NoClip.lua"
click node_spawner "https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/Spawner.lua"
click node_naming "https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/ShortNamingUtils.lua"
click node_outline "https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/EntityOutline.lua"
click node_barrier "https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/BarrierOpener.lua"
click node_boundaries "https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/DisableWorldBoundaries.lua"

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_main,node_lip,node_config toneBlue
class node_utils,node_types,node_math,node_entity,node_world,node_path toneAmber
class node_cheats,node_teleport,node_noclip,node_spawner,node_naming toneMint
class node_outline,node_barrier,node_boundaries toneRose
class node_ue4ss toneIndigo
```

## Components

### Runtime and configuration

- [Mod entry point](https://github.com/pingouinn/pingouinmod/blob/main/scripts/main.lua): `scripts/main.lua`
- [INI parser](https://github.com/pingouinn/pingouinmod/blob/main/scripts/dependencies/LIP.lua): `scripts/dependencies/LIP.lua`
- [Mod configuration](https://github.com/pingouinn/pingouinmod/blob/main/scripts/config.ini): `scripts/config.ini`

### Utility API

- [Utility API](https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/utils/Utils.lua): `scripts/code/utils/Utils.lua`
- [UE4SS types](https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/utils/Types.lua): `scripts/code/utils/Types.lua`
- [Vector math](https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/utils/Math.lua): `scripts/code/utils/Math.lua`
- [Entity helpers](https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/utils/Entity.lua): `scripts/code/utils/Entity.lua`
- [World helpers](https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/utils/World.lua): `scripts/code/utils/World.lua`
- [Path helpers](https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/utils/Path.lua): `scripts/code/utils/Path.lua`

### Gameplay features

- [Player cheats](https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/PlayerCheat.lua): `scripts/code/PlayerCheat.lua`
- [Teleportation](https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/Teleport.lua): `scripts/code/Teleport.lua`
- [NoClip](https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/NoClip.lua): `scripts/code/NoClip.lua`
- [Actor spawner](https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/Spawner.lua): `scripts/code/Spawner.lua`
- [Short naming](https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/ShortNamingUtils.lua): `scripts/code/ShortNamingUtils.lua`

### Debug tools

- [Entity outline](https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/EntityOutline.lua): `scripts/code/EntityOutline.lua`
- [Barrier opener](https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/BarrierOpener.lua): `scripts/code/BarrierOpener.lua`
- [Boundary disabling](https://github.com/pingouinn/pingouinmod/blob/main/scripts/code/DisableWorldBoundaries.lua): `scripts/code/DisableWorldBoundaries.lua`

### Other components

- **UE4SS**

## Connections

- UE4SS → Mod entry point: loads mod (evidence: `README.md`)
- Mod entry point → Utility API: entry architecture (evidence: `README.md`)
- Mod entry point → INI parser: entry architecture (evidence: `README.md`)
- Mod entry point → Player cheats: feature module (evidence: `README.md`)
- Mod entry point → Teleportation: feature module (evidence: `README.md`)
- Mod entry point → NoClip: feature module (evidence: `README.md`)
- Mod entry point → Actor spawner: feature module (evidence: `README.md`)
- Mod entry point → Short naming: feature module (evidence: `README.md`)
- Mod entry point → Entity outline: feature module (evidence: `README.md`)
- Mod entry point → Barrier opener: feature module (evidence: `README.md`)
- Mod entry point → Boundary disabling: feature module (evidence: `README.md`)
- Utility API → UE4SS types: API module (evidence: `README.md`)
- Utility API → Vector math: API module (evidence: `README.md`)
- Utility API → Entity helpers: API module (evidence: `README.md`)
- Utility API → World helpers: API module (evidence: `README.md`)
- Utility API → Path helpers: API module (evidence: `README.md`)
- Mod configuration → Short naming: provides names (evidence: `README.md`)
