# yurisizuku/onscripteryuri architecture

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

- Interactive diagram: https://gitdiagram.com/yurisizuku/onscripteryuri
- Repository: https://github.com/yurisizuku/onscripteryuri

## Overview

##### Main Components
- Core Engine (src/onsyuri)
- Script Parser & Handler: ScriptParser(.cpp/.h), ScriptHandler(.cpp/.h), LUAHandler
- Readers: DirectReader, NsaReader, SarReader, AVIWrapper
- Rendering Pipeline: GLES2Renderer (+ shader folder), DirtyRect, FontInfo, AnimationInfo
- Audio/Video: SDL_mixer (or system player on Android), AVIWrapper for video
- Built‑in Effects: builtin_dll modules (cascade, trig, snow, oldmovie)
- Utilities & SIMD: simd folder, Utils.h, coding2utf16, resize_image
- Platform Abstraction Layer
- File I/O: SDL_RWops, BrowserFS/IndexedDB (web), SAF (Android)
- Input: SDL2 input events, touch/long‑press abstractions (Android & web)
- Window & Graphics Context: SDL2/OpenGL ES2
- Audio Output: SDL_mixer or native audio APIs
- Frontend Wrappers (entry points)
- Native Desktop: onsyuri_main.cpp linked via CMake to a standalone binary
- Android: Java layer (MainActivity.java, SAFFile.java) + JNI bindings + C++ via CMake/Gradle
- Web: Emscripten build → onsyuri.html, .js, .wasm + onsyuri_index.json + onscripter web UI
- Libretro: SDL_libretro.c (RetroArch plug‑in)
- Tools & Packaging
- Script utilities: nscriptdecode, sarconv, onsyuri_index.py
- Build Scripts: shell scripts in /script (cross_*.sh, local_*.sh)
- Dockerfiles: per‑platform containers under /docker
- CI/CD: GitHub Actions workflows (build_linux.yml, build_android.yml, etc.)
- Configuration & Build System
- CMakeLists.txt, vcpkg.json, gradle files under src/onsyuri_android

##### Relationships & Data Flows
a. Frontend → Core Engine initialization (onsyuri_main)
b. Core Engine reads game assets via File I/O abstraction
c. ScriptParser parses .txt/.ns scripts → ScriptHandler dispatches commands
d. Rendering Module drives OpenGL ES2 via Platform Layer → screen
e. Audio Commands go through SDL_mixer or native player
f. Built‑in DLL effects loaded dynamically by Core
g. Save data written to IndexedDB (web) or SAF/OS FS
a. CMake + shell scripts → platform‑specific builds
b. Docker containers can automate cross‑compile steps
c. GitHub Actions trigger Docker or scripts → produce binaries/artifacts

##### Architectural Patterns
- Layered Architecture:
- Presentation (Frontend wrappers)
- Application Logic (Core Engine)
- Infrastructure (Platform Abstraction)
- External Dependencies (SDL2, Emscripten, Android SDK, Libretro)
- Plugin‑style Effects: builtin_dll modules loaded by name
- Cross‑compile Orchestration: Docker + shell scripts + CI pipelines

##### Technologies & Frameworks
- C++17, SDL2, OpenGL ES2
- Lua scripting
- Emscripten (WASM + JS) for web port
- Android NDK + JNI + Gradle for Android port
- Libretro API for RetroArch port
- CMake, vcpkg, Docker, GitHub Actions

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Wrappers
    subgraph "Frontend Wrappers" 
        direction TB
        ND["Native Desktop"]:::frontend
        AN["Android (Java→JNI)"]:::frontend
        WB["Web (Emscripten)"]:::frontend
        LR["Libretro Plugin"]:::frontend
    end

    %% Core Engine
    subgraph "Core Engine" 
        direction TB
        SP["ScriptParser"]:::core
        SH["ScriptHandler"]:::core
        LU["LUAHandler"]:::core
        DR["DirectReader"]:::core
        NR["NsaReader"]:::core
        SR["SarReader"]:::core
        AW["AVIWrapper"]:::core
        GR["GLES2Renderer"]:::core
        DRR["DirtyRect"]:::core
        FI["FontInfo"]:::core
        AI["AnimationInfo"]:::core
        AV["Audio/Video"]:::core
        BE["Built-in Effects"]:::core
        UT["Utils & SIMD"]:::core
    end

    %% Platform Abstraction
    subgraph "Platform Abstraction" 
        direction TB
        FIOL["File I/O"]:::platform
        INP["Input Events"]:::platform
        WGC["Window & GL Context"]:::platform
        ADO["Audio Output"]:::platform
    end

    %% Storage
    subgraph "Storage" 
        direction TB
        FS["OS File System"]:::storage
        IDB["IndexedDB"]:::storage
    end

    %% Tools & CI
    subgraph "Tools & CI" 
        direction TB
        SU["Script Utilities"]:::tools
        SS["Shell Build Scripts"]:::tools
        DC["Docker Containers"]:::tools
        GH["GitHub Actions"]:::tools
    end

    %% Runtime Data Flows (solid)
    ND -->|"init onscripter_main"| SP
    AN -->|"JNI bridge"| SP
    WB -->|"Emscripten FS init"| SP
    LR -->|"plugin load"| SP

    SP -->|"dispatch commands"| SH
    SH -->|"calls LUA"| LU
    SP -->|"reads asset"| FIOL
    FIOL -->|"SDL_RWops/BrowserFS/SAF"| FS
    FIOL -->|"BrowserFS mount"| IDB

    SP -->|"load reader"| DR
    SP -->|"load reader"| NR
    SP -->|"load reader"| SR
    SP -->|"video playback"| AW

    SP -->|"render frame"| GR
    GR -->|"uses shaders"| DRR
    GR -->|"text info"| FI
    GR -->|"animation info"| AI
    GR -->|"draw calls"| WGC

    SP -->|"audio cmd"| AV
    AV -->|"SDL_mixer/native"| ADO

    SP -->|"load effect"| BE
    SP -->|"util funcs"| UT

    %% Build & CI Flows (dashed)
    SS -.->|"invoke CMake"| ND
    SS -.->|"invoke Gradle"| AN
    SS -.->|"invoke Emscripten"| WB
    SS -.->|"invoke Libretro build"| LR
    DC -.->|"cross-compile"| SS
    GH -.->|"trigger"| DC
    GH -.->|"trigger"| SS

    %% Click Events
    click SP "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/ScriptParser.cpp"
    click SP "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/ScriptParser.h"
    click SH "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/ScriptHandler.cpp"
    click SH "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/ScriptHandler.h"
    click LU "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/LUAHandler.cpp"
    click LU "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/LUAHandler.h"
    click DR "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/DirectReader.cpp"
    click DR "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/DirectReader.h"
    click NR "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/NsaReader.cpp"
    click NR "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/NsaReader.h"
    click SR "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/SarReader.cpp"
    click SR "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/SarReader.h"
    click AW "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/AVIWrapper.cpp"
    click AW "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/AVIWrapper.h"
    click GR "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/renderer/gles_renderer.cpp"
    click GR "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/renderer/gles_renderer.h"
    click DRR "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/DirtyRect.cpp"
    click DRR "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/DirtyRect.h"
    click FI "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/FontInfo.cpp"
    click FI "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/FontInfo.h"
    click AI "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/AnimationInfo.cpp"
    click AI "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/AnimationInfo.h"
    click AV "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/simple_aviplay.cpp"
    click BE "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/builtin_dll/ONScripter_effect_cascade.cpp"
    click BE "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/builtin_dll/ONScripter_effect_trig.cpp"
    click BE "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/builtin_dll/layer_oldmovie.cpp"
    click BE "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/builtin_dll/layer_snow.cpp"
    click BE "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/builtin_dll/builtin_layer.h"
    click UT "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/Utils.h"
    click UT "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/resize_image.cpp"
    click UT "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/resize_image.h"
    click UT "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/coding2utf16.cpp"
    click UT "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/coding2utf16.h"
    click UT "https://github.com/yurisizuku/onscripteryuri/tree/master/src/onsyuri/simd/"
    click ND "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/onscripter_main.cpp"
    click ND "https://github.com/yurisizuku/onscripteryuri/blob/master/CMakeLists.txt"
    click AN "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri_android/app/java/com/yuri/onscripter/MainActivity.java"
    click AN "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri_android/app/java/com/yuri/onscripter/SafFile.java"
    click AN "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri_android/app/cpp/CMakeLists.txt"
    click AN "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri_android/build.gradle"
    click WB "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri_web/onsyuri.html"
    click WB "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri_web/onsyuri_index.py"
    click WB "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri_web/dummy.c"
    click LR "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri_libretro/SDL_libretro.c"
    click LR "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri_libretro/SDL_libretro.h"
    click LR "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri_libretro/libretro.cpp"
    click LR "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri_libretro/libretro.h"
    click LR "https://github.com/yurisizuku/onscripteryuri/tree/master/src/onsyuri_libretro/deps/"
    click SU "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/tool/nscriptdecode.cpp"
    click SU "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/tool/sarconv.cpp"
    click SU "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/tool/nsadec.cpp"
    click SU "https://github.com/yurisizuku/onscripteryuri/blob/master/src/onsyuri/tool/sardec.cpp"
    click SS "https://github.com/yurisizuku/onscripteryuri/tree/master/script/"
    click DC "https://github.com/yurisizuku/onscripteryuri/tree/master/docker/"
    click GH "https://github.com/yurisizuku/onscripteryuri/blob/master/.github/workflows/build_android.yml"
    click GH "https://github.com/yurisizuku/onscripteryuri/blob/master/.github/workflows/build_linux.yml"
    click GH "https://github.com/yurisizuku/onscripteryuri/blob/master/.github/workflows/build_web.yml"
    click GH "https://github.com/yurisizuku/onscripteryuri/blob/master/.github/workflows/build_win.yml"
    click GH "https://github.com/yurisizuku/onscripteryuri/blob/master/.github/workflows/build_win_msvc.yml"
    click GH "https://github.com/yurisizuku/onscripteryuri/blob/master/.github/workflows/build_darwin.yml"

    %% Styles
    classDef core fill:#ADD8E6,stroke:#000,stroke-width:1px;
    classDef platform fill:#90EE90,stroke:#000,stroke-width:1px;
    classDef frontend fill:#FFA500,stroke:#000,stroke-width:1px;
    classDef tools fill:#D3D3D3,stroke:#000,stroke-width:1px;
    classDef storage fill:#F5DEB3,stroke:#000,stroke-width:1px;
```
