# sua0649/4-up-game architecture

> Architecture diagram of the GitHub repository sua0649/4-up-game, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sua0649/4-up-game
- Repository: https://github.com/sua0649/4-up-game

## Overview

##### Project Type and Overall Purpose
- The project is a low-level, text-based game implemented in Assembly Language. It simulates a two-player Four-Up game (similar to Connect Four) and is built for educational purposes, emphasizing memory management, register operations, and game logic using MASM and the Irvine32 library.
- The purpose is to offer insights into low-level programming constructs, such as direct memory use, stack operations, and I/O handling on a console, rather than relying on high-level abstractions.

##### File Structure
- The file tree shows two major directories: one under “BoardForGame” and another as “Coal Project/4-Up-Game”. Both include Visual Studio solution files (.sln) and various project files (.vcxproj), indicating they’re built using Microsoft Visual Studio and MASM.
- Key assembly files to note are the several .asm files (e.g., main.asm, main_game_file.asm, main_menu.asm, Checker.asm, board.asm) together with shared include files. These signify separation of concerns—each file handling parts of the game logic such as input handling, game board rendering, win detection, and program structure.
- Additionally, there are configuration and build output directories (Debug, x64/Debug, .vs) which indicate the development and debugging infrastructure.

##### Key Components (Nodes) in the Architecture
a. Input Handling Module:
– Manages and validates player inputs (column selection) via routines that leverage Irvine32’s input functions.
b. Game Engine / Logic Module:
– Contains core game loop, alternate turn management, board updates, and overall game state management.
– Implements the win detection algorithms (checking for four in a row horizontally, vertically, or diagonally).
c. / Rendering Module:
– Responsible for updating the console with ASCII-based graphics that render the game board (the 6x7 grid).
– Provides visual feedback after every move.
d. Memory and Register Management:
– Handles direct memory access of the board (modeled as a 2D array in memory) and leverages CPU registers (AX, BX, CX, etc.) for operations.
e. Assembly and Build Infrastructure:
– Includes the MASM assembler as the build tool, the Irvine32 library for IO, and Visual Studio as the debugging/IDE environment.
f. (Optional) Game Configuration Controls:
– Allows players to select winning condition variants (e.g., 4, 5, 6, or 7 in a row).

##### Relationships and Interactions
– Player Input → Input Handling Module → Game Engine (updates the game state).
– Game Engine (after processing logic) → Display Module (renders updated board).
- Additionally, include interactions where the Memory Management component supports the Game Engine by storing the board state and win conditions.
- The Assembly toolchain and debugging environment support all modules and are not directly “in the game,” but they are the infrastructure that ties everything together.

##### Architectural Patterns & Design Principles
- Even though this is an assembly language project, the architecture logically separates concerns much like a modular design:
– Separation of Input, Processing (Game Logic), and Output (Rendering).
– Emphasis on memory efficiency and explicit, low-level handling of resources.
- This separation helps with clarity (e.g., each .asm file can be seen as a module or a “service”) even if it is not object oriented.

## Diagram (Mermaid)

```mermaid
flowchart TD
    playerInput["Player Input"]:::module
    inputModule["Input Handling Module"]:::module
    engine["Game Engine / Logic Module"]:::module
    memory["Memory & Register Management"]:::module
    display["Display / Rendering Module"]:::module
    infra(("Assembly and Build Infrastructure")):::infra

    playerInput -->|"input"| inputModule
    inputModule -->|"process"| engine
    engine -->|"state_update"| memory
    memory -->|"render"| display
    display -->|"feedback"| playerInput
    infra -->|"build_support"| engine

    click inputModule "https://github.com/sua0649/4-up-game/blob/main/Coal Project/4-Up-Game/Coal Project/main_menu.asm"
    click engine "https://github.com/sua0649/4-up-game/blob/main/Coal Project/4-Up-Game/Coal Project/main_game_file.asm"
    click display "https://github.com/sua0649/4-up-game/blob/main/Coal Project/4-Up-Game/Coal Project/board.asm"
    click memory "https://github.com/sua0649/4-up-game/blob/main/Coal Project/4-Up-Game/Coal Project/shared.inc"
    click infra "https://github.com/sua0649/4-up-game/blob/main/Coal Project/4-Up-Game/Coal Project/Coal Project.vcxproj"

    classDef module fill:#B3E5FC,stroke:#01579B,stroke-width:2px,color:#000;
    classDef infra fill:#FFCC80,stroke:#FF9800,stroke-width:2px,color:#000;
```
