# acristescu/onlinego architecture

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

- Interactive diagram: https://gitdiagram.com/acristescu/onlinego
- Repository: https://github.com/acristescu/onlinego

## Overview

##### Project type and purpose
- This is a client-only Android application (“OnlineGo”) that lets users play Go against other players on the Online-Go.com (OGS) service, or locally against a built-in AI (KataGo).
- It is not a server or full-stack web app, but it does interact with external services (OGS REST + WebSocket) and hosts a native AI engine via JNI.

##### File structure
- Top-level “app” module contains all Android code (Java/Kotlin, CMake, native libs).
- “schemas” folder shows Room database versions (16–19).
- src/main/java: organized by feature—ai, data (db, models, ogs, repositories), di, gamelogic, mvi, notifications, playstore, ui (composables + screens), usecases, utils.
- Native code in src/main/cpp with CMakeLists to build KataGo bindings.
- Build scripts: Gradle, proguard, gradle-wrapper.
- README confirms architectures used: MVP, MVI, Room, coroutines, RxJava2, Retrofit.

##### README for additional insights
- The app employs a mix of patterns: legacy MVP on some screens, modern MVI + Jetpack Compose on others.
- Data layer uses Room for local caching, Retrofit + Moshi for OGS REST, OkHttp WebSocket for real-time.
- Native AI engine (KataGo) bound by JNI to Kotlin via jnibindings.cpp.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% UI Layer
    subgraph "UI Layer" 
        direction TB
        Composables["Composable Screens"]:::ui
        MVI["Store / Reducer / Middleware"]:::ui
        MVP["MainActivity / MainPresenter (MVP)"]:::ui
        GameScreen["GameFragment / GameUI / GameViewModel"]:::ui
        Face2Face["FaceToFaceFragment / FaceToFaceUI / FaceToFaceViewModel"]:::ui
        LocalAI["AiGameFragment / AiGameState / AiGameReducer / AiGameViewModel"]:::ui
        PuzzleDir["PuzzleDirectoryFragment / PuzzleDirectoryViewModel"]:::ui
        Onboarding["OnboardingFragment / OnboardingViewModel"]:::ui
    end

    %% Domain Layer
    subgraph "Domain Layer" 
        direction TB
        UseCases["UseCase Classes"]:::domain
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        Repos["Repositories"]:::data
        RoomDB["Room Database\n(DAOs, TypeConverters, Schemas)"]:::data
        NetModels["Network Models"]:::data
        REST["OGSRestService / OGSRestAPI"]:::data
        WS["OGSWebSocketService / GameConnection"]:::data
        DI["Modules.kt\n(Dependency Injection)"]:::data
        Workers["WorkManager Tasks\n(CheckNotificationsTask, SynchronizeGamesWork)"]:::data
    end

    %% Native AI Engine
    subgraph "Native AI Engine"
        direction TB
        KataGoEngine["KataGoAnalysisEngine"]:::native
        JNI["jnibindings.cpp"]:::native
        CPP["C++ Sources (Goban.cpp/.h, Vec.h, constants.h)"]:::native
        CMake["CMakeLists.txt"]:::native
        Libs["Prebuilt jniLibs"]:::native
    end

    %% External Services
    subgraph "External Services"
        direction TB
        OGS_REST["OGS REST Backend"]:::external
        OGS_WS["OGS WebSocket Backend"]:::external
        PlayStore["PlayStoreService"]:::external
        Crashlytics["Crashlytics / Analytics"]:::external
    end

    %% Relationships
    Composables -->|dispatch intents| MVI
    MVP -->|dispatch events| UseCases
    MVI -->|calls| UseCases
    GameScreen -->|binds to| MVI
    Face2Face -->|binds to| MVI
    LocalAI -->|binds to| MVI
    PuzzleDir -->|binds to| MVI
    Onboarding -->|binds to| MVI

    UseCases -->|use| Repos
    Repos -->|read/write| RoomDB
    Repos -->|fetch| REST
    Repos -->|stream| WS
    Repos -->|trigger| Workers

    REST -->|HTTP| OGS_REST
    WS -->|WebSocket| OGS_WS
    Workers -->|update| RoomDB

    UseCases -->|invoke AI| KataGoEngine
    KataGoEngine -->|JNI call| JNI
    JNI -->|C++ binding| CPP
    CPP -->|built by| CMake
    CMake -->|links| Libs

    PlayStore -->|IAP| PlayStore
    Workers -->|analytics| Crashlytics

    %% Click Events
    click Composables "https://github.com/acristescu/onlinego/tree/master/app/src/main/java/io/zenandroid/onlinego/ui/composables"
    click MVI "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/mvi/Store.kt"
    click MVI "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/mvi/Reducer.kt"
    click MVI "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/mvi/Middleware.kt"
    click MVP "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/ui/screens/main/MainContract.kt"
    click MVP "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/ui/screens/main/MainPresenter.kt"
    click MVP "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/ui/screens/main/MainActivity.kt"
    click GameScreen "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/ui/screens/game/GameFragment.kt"
    click GameScreen "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/ui/screens/game/GameUI.kt"
    click GameScreen "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/ui/screens/game/GameViewModel.kt"
    click UseCases "https://github.com/acristescu/onlinego/tree/master/app/src/main/java/io/zenandroid/onlinego/usecases/"
    click Repos "https://github.com/acristescu/onlinego/tree/master/app/src/main/java/io/zenandroid/onlinego/data/repositories/"
    click RoomDB "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/data/db/Database.kt"
    click RoomDB "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/data/db/DbTypeConverters.kt"
    click RoomDB "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/data/db/GameDao.kt"
    click RoomDB "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/data/db/PuzzleDao.kt"
    click RoomDB "https://github.com/acristescu/onlinego/blob/master/app/schemas/io.zenandroid.onlinego.data.db.Database/16.json"
    click RoomDB "https://github.com/acristescu/onlinego/blob/master/app/schemas/io.zenandroid.onlinego.data.db.Database/19.json"
    click NetModels "https://github.com/acristescu/onlinego/tree/master/app/src/main/java/io/zenandroid/onlinego/data/model/ogs/"
    click REST "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/data/ogs/OGSRestService.kt"
    click REST "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/data/ogs/OGSRestAPI.kt"
    click WS "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/data/ogs/OGSWebSocketService.kt"
    click WS "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/data/ogs/GameConnection.kt"
    click DI "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/di/Modules.kt"
    click KataGoEngine "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/ai/KataGoAnalysisEngine.kt"
    click JNI "https://github.com/acristescu/onlinego/blob/master/app/src/main/cpp/jnibindings.cpp"
    click CPP "https://github.com/acristescu/onlinego/tree/master/app/src/main/cpp/"
    click CMake "https://github.com/acristescu/onlinego/blob/master/app/CMakeLists.txt"
    click Libs "https://github.com/acristescu/onlinego/tree/master/app/src/main/jniLibs/arm64-v8a"
    click Libs "https://github.com/acristescu/onlinego/tree/master/app/src/main/jniLibs/armeabi-v7a"
    click Workers "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/notifications/CheckNotificationsTask.kt"
    click Workers "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/notifications/SynchronizeGamesWork.kt"
    click PlayStore "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/playstore/PlayStoreService.kt"
    click Crashlytics "https://github.com/acristescu/onlinego/blob/master/app/src/main/java/io/zenandroid/onlinego/utils/Crashlytics.kt"

    %% Styles
    classDef ui fill:#D0E6FF,stroke:#0366d6,stroke-width:1px
    classDef domain fill:#DFFFE0,stroke:#2E8B57,stroke-width:1px
    classDef data fill:#FFE5B4,stroke:#FF8C00,stroke-width:1px
    classDef native fill:#E0E0E0,stroke:#696969,stroke-width:1px
    classDef external fill:#E5D0FF,stroke:#800080,stroke-width:1px
```
