# sulemarevientu/gameplayfixesv-scripthookv architecture

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

- Interactive diagram: https://gitdiagram.com/sulemarevientu/gameplayfixesv-scripthookv
- Repository: https://github.com/sulemarevientu/gameplayfixesv-scripthookv

## Overview

##### Project type and purpose
- This is a native-code GTA V mod (an .asi plugin) built with Visual Studio and loaded at runtime by ScriptHookV.
- Its purpose is to hook into GTA V’s scripting engine, read a user-configurable INI, and call game “native” functions to enable/disable gameplay features.

##### File structure
Top-level items:
- GameplayFixesV.sln / .vcxproj – Visual Studio solution/project
- bin/Release/GameplayFixesV.asi – the compiled plugin
- bin/Release/GameplayFixesV.ini – runtime configuration file
- inc/ – headers for ScriptHookV, SimpleIni, natives, enums, types
- lib/ScriptHookV.lib – import library to link against ScriptHookV
- source/ – core logic
– main.cpp, script.cpp, globals.h
– utils/ (functions, ini loader, keyboard, peds)

##### README for additional insights
- The mod never patches game binaries directly; it makes native calls via ScriptHookV.
- SimpleIni is used for INI parsing.
- Features are grouped by category (Player, HUD, Audio, etc.), each implemented in code under source/utils or script.cpp.

##### Main components
a. GTA V Game Engine (host process)
b. ScriptHookV (hook/dll injector + scripting runtime)
c. GameplayFixesV.asi plugin
d. SimpleIni library (INI parsing)
e. Configuration file (GameplayFixesV.ini)
f. Internal modules:
- Script Entry & Tick Loop (script.cpp / main.cpp)
- Feature modules (utils/functions.cpp, keyboard.cpp, peds.cpp, ini.cpp)
- Native Caller (nativeCaller.h + natives.h)

##### Relationships & interactions
- On GTA V startup, ScriptHookV injects and loads all .asi plugins, including GameplayFixesV.asi.
- The plugin’s entry point (main.cpp) registers an update callback in ScriptHookV’s scripting runtime.
- At each game tick:
1. The plugin reads or reloads the INI (via SimpleIni).
2. It checks input (keyboard module) for reload key or toggle keys.
3. For each enabled feature, it invokes the corresponding function in utils/ (which wraps one or more native calls).
4. The Native Caller layer translates high-level calls into GTA V’s native API.
- All calls execute inside the GTA V process space, altering game state at runtime.

##### Architectural patterns and principles
- Modular design: separate “feature” modules in source/utils, plus a central script loop.
- Dependency injection: config values flow into feature modules.
- Layered calls: ScriptHookV → plugin entry → feature logic → native API.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Host and Loader
    subgraph "Host Runtime" 
        direction TB
        GTA["GTA V Game Engine"]:::host
        SHV["ScriptHookV"]:::host
    end

    %% Development Artifacts
    subgraph "Development Artifacts"
        direction TB
        SLN["GameplayFixesV.sln"]:::external
        VCX["GameplayFixesV.vcxproj"]:::external
    end

    %% External Dependencies
    subgraph "External Libraries"
        direction TB
        LIBSHV["ScriptHookV.lib"]:::external
        SI["SimpleIni.h"]:::external
    end

    %% Configuration
    CFGFILE["GameplayFixesV.ini"]:::config

    %% Plugin Internal Modules
    subgraph "GameplayFixesV.asi Plugin" 
        direction TB
        PLUGIN["GameplayFixesV.asi"]:::plugin

        subgraph "Script Loop & Entry"
            direction TB
            MAIN["main.cpp"]:::plugin
            SCRIPTCPP["script.cpp"]:::plugin
            SCRIPTH["script.h"]:::plugin
            GLOBALS["globals.h"]:::plugin
        end

        subgraph "Config Loader"
            direction TB
            INICPP["ini.cpp"]:::plugin
            INIH["ini.h"]:::plugin
        end

        subgraph "Input Handler"
            direction TB
            KEYCPP["keyboard.cpp"]:::plugin
            KEYH["keyboard.h"]:::plugin
        end

        subgraph "Feature Modules"
            direction TB
            FUNCPP["functions.cpp"]:::feature
            FUNH["functions.h"]:::feature
            PEDCPP["peds.cpp"]:::feature
            PEDH["peds.h"]:::feature
        end

        subgraph "Native Caller"
            direction TB
            NCALLER["nativeCaller.h"]:::external
            NATIVES["natives.h"]:::external
            TYPES["types.h"]:::external
            ENUMS["enums.h"]:::external
        end
    end

    %% Connections
    GTA -->|"hosts"| SHV
    SHV -->|"loads"| PLUGIN
    PLUGIN -->|"RegisterScript"| MAIN
    MAIN -->|"calls OnTick"| SCRIPTCPP
    SCRIPTCPP -->|"OnTick callback"| INICPP
    SCRIPTCPP -->|"OnTick callback"| KEYCPP
    SCRIPTCPP -->|"OnTick callback"| FUNCPP
    SCRIPTCPP -->|"OnTick callback"| PEDCPP
    CFGFILE -.->|"LoadConfig"| INICPP
    INICPP -->|"uses"| SI
    FUNCPP -->|"wraps"| NCALLER
    PEDCPP -->|"wraps"| NCALLER
    NCALLER -->|"NativeCall"| GTA
    SHV -->|"link against"| LIBSHV

    %% Click Events
    click SLN "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/GameplayFixesV.sln"
    click VCX "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/GameplayFixesV.vcxproj"
    click PLUGIN "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/bin/Release/GameplayFixesV.asi"
    click CFGFILE "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/bin/Release/GameplayFixesV.ini"
    click LIBSHV "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/lib/ScriptHookV.lib"
    click SI "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/inc/SimpleIni.h"
    click NCALLER "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/inc/nativeCaller.h"
    click NATIVES "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/inc/natives.h"
    click TYPES "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/inc/types.h"
    click ENUMS "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/inc/enums.h"
    click MAIN "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/source/main.cpp"
    click SCRIPTCPP "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/source/script.cpp"
    click SCRIPTH "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/source/script.h"
    click GLOBALS "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/source/globals.h"
    click INICPP "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/source/utils/ini.cpp"
    click INIH "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/source/utils/ini.h"
    click KEYCPP "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/source/utils/keyboard.cpp"
    click KEYH "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/source/utils/keyboard.h"
    click FUNCPP "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/source/utils/functions.cpp"
    click FUNH "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/source/utils/functions.h"
    click PEDCPP "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/source/utils/peds.cpp"
    click PEDH "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/source/utils/peds.h"
    click CFGFILE "https://github.com/sulemarevientu/gameplayfixesv-scripthookv/blob/main/GameplayFixesV/bin/Release/GameplayFixesV.ini"

    %% Styles
    classDef host fill:#f9f,stroke:#333,stroke-width:1px
    classDef plugin fill:#9f9,stroke:#333,stroke-width:1px
    classDef external fill:#ff9,stroke:#333,stroke-width:1px
    classDef feature fill:#9ff,stroke:#333,stroke-width:1px
    classDef config fill:#fc9,stroke:#333,stroke-width:1px
```
