# bbfox0703/mydev-cheat-engine-tables architecture

> Architecture diagram of the GitHub repository bbfox0703/mydev-cheat-engine-tables, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bbfox0703/mydev-cheat-engine-tables
- Repository: https://github.com/bbfox0703/mydev-cheat-engine-tables

## Overview

##### Main Components
- Repository & Source Control: At the top level, include components representing the Git repository (with its .gitignore, .gitattributes, and LICENSE files). This is the entry point for the repository hosted on GitHub.
- Game Titles Modules: Each top-level directory (e.g., “4 Elements II Special Edition”, “Age of Empires II Definitive Edition”, “Assassin's Creed Odyssey”, etc.) is a module containing a cheat table file (.CT) along with additional documentation files for that title. Think of each game folder as an independent “plugin” or “module.”
- Utility/Toolchain Components: The “ZZ_Tools” directory contains various subcomponents:
– The AAToggleGenerator project (with its code files, project files, and configuration).
– Several subfolders for Cheat Engine-related files and testing utilities. These represent the tool support intended to both process cheat tables or assist in their creation and testing.

##### Architectural Patterns and Design Principles
- Separation of Concerns: Clearly differentiate between the core cheat table content (game directories) vs. the tools/utilities (ZZ_Tools) and the external integration points (Cheat Engine and OCT site).

##### Relevant Technologies and Frameworks
- Git and GitHub (for version control and repository hosting).
- Cheat Engine (as the runtime tool that utilizes these cheat tables).
- The .CT file format (the core file type used as cheat tables).
- .NET (as indicated by the C# projects in the AAToggleGenerator tool).
- Scripts and auxiliary files used for tasks (like the PowerShell script in Atelier Ryza 3 and the various Lua scripts in the ZZ_Tools folder).

- Clear labels:
– “Git Repository (Mydev-Cheat-Engine-Tables)”
– “Utility Tools (ZZ_Tools)” with its sub-components (like AAToggleGenerator, CE autorun tools, Test utilities)
– “Cheat Engine 7.5+” (external dependency)
– “Open Cheat Tables (OCT) Website” (external publication and support)
– Download flow: Repository ➔ User ➔ Cheat Engine.
– Maintenance flow: Tools ➔ Cheat Table Files.
– Documentation/Support flow: README and Title List ➔ OCT website.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Repository cluster
    subgraph "Git Repository (Mydev-Cheat-Engine-Tables)"
        REPO["Repository"]:::repo
        REPO_Gitattributes[".gitattributes"]:::repo
        REPO_Gitignore[".gitignore"]:::repo
        REPO_LICENSE["LICENSE"]:::repo
        REPO_README["README.md"]:::repo
        REPO_TITLELIST["TITLELIST.md"]:::repo
    end

    %% Game Titles Modules cluster
    subgraph "Game Titles Modules"
        GE1["4 Elements II Special Edition"]:::module
        GE2["Age of Empires II Definitive Edition"]:::module
        GE3["Age of Empires IV"]:::module
        GE4["Anno 1800"]:::module
        GE5["Assassin's Creed Odyssey"]:::module
    end

    %% Utility Tools cluster
    subgraph "Utility Tools (ZZ_Tools)"
        UT1["AAToggleGenerator"]:::tools
        UT2["Cheat Engine Utilities & Scripts"]:::tools
        UT3["Test Utilities"]:::tools
    end

    %% External Systems and User
    CE["Cheat Engine 7.5+"]:::external
    OCT["Open Cheat Tables (OCT) Website"]:::external
    User["User"]:::external

    %% Relationships
    REPO ---|"contains" | GE1
    REPO ---|"contains" | GE2
    REPO ---|"contains" | GE3
    REPO ---|"contains" | GE4
    REPO ---|"contains" | GE5

    REPO ---|"hosts" | UT1
    REPO ---|"hosts" | UT2
    REPO ---|"hosts" | UT3

    REPO ---|"providesCT" | User
    User ---|"loadsCT" | CE

    UT1 ---|"processes" | GE1
    UT1 ---|"processes" | GE2
    UT1 ---|"processes" | GE3
    UT1 ---|"processes" | GE4
    UT1 ---|"processes" | GE5
    UT2 ---|"supports" | GE1
    UT3 ---|"tests" | GE1

    REPO_README ---|"docsLink" | OCT
    REPO_TITLELIST ---|"listsTitles" | OCT

    %% Click Events for Git Repository Files
    click REPO_Gitattributes "https://github.com/bbfox0703/mydev-cheat-engine-tables/blob/main/.gitattributes"
    click REPO_Gitignore "https://github.com/bbfox0703/mydev-cheat-engine-tables/blob/main/.gitignore"
    click REPO_LICENSE "https://github.com/bbfox0703/mydev-cheat-engine-tables/tree/main/LICENSE"
    click REPO_README "https://github.com/bbfox0703/mydev-cheat-engine-tables/blob/main/README.md"
    click REPO_TITLELIST "https://github.com/bbfox0703/mydev-cheat-engine-tables/blob/main/TITLELIST.md"

    %% Click Events for Game Titles Modules
    click GE1 "https://github.com/bbfox0703/mydev-cheat-engine-tables/tree/main/4 Elements II Special Edition"
    click GE2 "https://github.com/bbfox0703/mydev-cheat-engine-tables/tree/main/Age of Empires II Definitive Edition"
    click GE3 "https://github.com/bbfox0703/mydev-cheat-engine-tables/tree/main/Age of Empires IV"
    click GE4 "https://github.com/bbfox0703/mydev-cheat-engine-tables/tree/main/Anno 1800"
    click GE5 "https://github.com/bbfox0703/mydev-cheat-engine-tables/tree/main/Assassin's Creed Odyssey"

    %% Click Events for Utility Tools
    click UT1 "https://github.com/bbfox0703/mydev-cheat-engine-tables/tree/main//ZZ_Tools/AAToggleGenerator"
    click UT2 "https://github.com/bbfox0703/mydev-cheat-engine-tables/tree/main//ZZ_Tools"
    click UT3 "https://github.com/bbfox0703/mydev-cheat-engine-tables/tree/main//ZZ_Tools/Test"

    %% Styling Classes
    classDef repo fill:#AED6F1,stroke:#1B4F72,stroke-width:2px;
    classDef module fill:#ABEBC6,stroke:#186A3B,stroke-width:2px;
    classDef tools fill:#F9E79F,stroke:#B9770E,stroke-width:2px;
    classDef external fill:#F5B7B1,stroke:#922B21,stroke-width:2px;
```
