# omuanko/nnjhtrkn architecture

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

- Interactive diagram: https://gitdiagram.com/omuanko/nnjhtrkn
- Repository: https://github.com/omuanko/nnjhtrkn

## Overview

この忍者ゲームのソースは、主にアセンブリ言語（.A65ファイル群）とバッチファイル（.BAT）、およびスクリプト（.SCRファイル）で構成されており、各ファイルがゲームの特定の機能やフェーズを実装しています。システム図を作成する際は、ゲームの各主要機能（コアロジック、敵処理、移動ロジックなど）をできるだけ詳細に分解して、相互の関係がわかるように示すことがポイントです。以下の手順に従って、図の作成方法と各要素の連携を明確にしましょう。

【1. プロジェクトのタイプと目的の特定】
・このプロジェクトは「とある忍者ゲームのソース」とあるように、レトロな忍者アクションゲームを実装するためのソースコードです。
・各ファイル群はゲームループ、キャラクターや敵の動作、背景やマップ、サウンドなど、ゲームの各面を担当していると思われます。

【2. ファイル構造から読み取れる主要モジュール】
・HMAIN.A65：ゲームのエントリーポイント。全体のコアロジックを管理している可能性が高いです。
・HATMOV.A65：キャラクターの移動ロジック。プレイヤーや場合によっては一部の敵の移動処理を実装していると考えられます。
・HATENM.A65：敵処理専用のモジュール。敵の行動パターン、生成、接触判定などを担う部分です。
・HATMAP.A65、HATTIL.A65：マップやタイル描画についての処理。ゲーム世界の背景や障害物の管理を行います。
・HATMUS.A65、HTBGM.SCR、HTBONUS.SCR等：サウンドやBGM、効果音関連のスクリプト・コード。
・その他の.BATや.SCRファイル：ビルド、実行、または特定のイベント（例：HTOVER.SCRはゲームオーバー時の処理、HTFIRE.SCRは攻撃アニメーション等）が含まれている可能性があります。

【3. READMEから読み解ける追加情報】
・READMEには単に「とある忍者ゲームのソース」と記載されているため、機能の詳細はファイル名から推測する必要があります。
・プロジェクトの各要素に直接のコメントは無いものの、ファイル名から「コアロジック」、「敵処理（enemy handling）」、「移動ロジック（movement logic）」などの各役割を連想できます。

【4. システム設計図に含めるべき主要コンポーネントとその関係】
① コアロジック（Main Engine）
・中心となるHMAIN.A65：ゲームループ（入力処理、状態更新、描画呼び出しなど）を管理。
・コアロジックは他のすべてのサブコンポーネントと連携し、順序立ててゲームの各ステージを更新する役割を持ちます。

② 敵処理（Enemy Handling）
・HATENM.A65のようなファイルが敵キャラクターの状態管理、AI行動、スポーン、衝突判定等を担当。
・コアロジックから定期的に呼び出され、各敵の現在状態や移動パターンの更新、プレイヤーとの相互作用（ダメージ、接触判定）を行う。
・システム図では、矢印で「ゲームループ → 敵処理モジュール」とデータや状態更新の流れを示す。

③ 移動ロジック（Movement Logic）
・HATMOV.A65で実装されていると考えられ、プレイヤーキャラクターの入力に基づく移動、アニメーション、衝突チェックなどが含まれる。
・場合によっては敵の一部移動や背景とのスクロール処理も含む可能性がある。
・このモジュールは、コアロジックからの入力データを基に更新結果を返し、またマップ（HATMAP.A65）との連携も必要です。

④ 補助モジュール（Map/Tile Management, Sound, etc.）
・マップ描画やタイル管理：HATMAP.A65、HATTIL.A65などで実装。
・サウンド・音楽管理：HATMUS.A65、HTBGM.SCRなどが該当。
・その他、ゲームイベント（ボーナス、ファイヤー、ゲームオーバー等）の処理は各SCRファイルに分かれて管理。

【5. 敵処理、移動ロジック、コアロジックの詳細化】
・敵処理：
- 敵キャラクターの初期化、各種行動パターン（待機、追跡、攻撃など）を担当。
- 敵とプレイヤーの衝突判定、ダメージや状態変化の計算、敵のリスポーンや削除のタイミングもここで管理する。
- 敵処理モジュールからは、各敵の位置、状態（例：攻撃中、防御中）、アニメーションフレームなどが更新され、コアロジックにその結果が返される。

・移動ロジック：
- プレイヤー入力による移動命令の受け取り、現在位置から新位置への計算と更新を行う。
- マップ境界、障害物との衝突チェック、スムーズなスクロール調整など、リアルタイムな動作判定を実施。
- 必要に応じて敵キャラクターやその他オブジェクトとのインタラクションの判定も含む可能性があり、また、アニメーションの更新やフレーム管理にも関与する。

・コアロジック：
- ゲーム全体のフロー（メインループ）を統括し、各フレームごとに入力処理、移動ロジック、敵処理、描画、サウンド更新を順次呼び出す。
- ゲームの状態管理（ステージの開始、クリア、ゲームオーバー等）もここで統制する。

【6. システム設計図の作成ガイドライン】
・各主要コンポーネント（コアロジック、敵処理モジュール、移動ロジックモジュール、マップ管理、サウンド管理等）を分かりやすく区別して配置します。
・各コンポーネントは、明確なラベル（例：「Main Engine (HMAIN)」、「Enemy Handler (HATENM)」、「Movement Logic (HATMOV)」など）で表示。
・データフローや依存関係を示すために、コンポーネント間に方向性のある矢印を描きます。例えば：
- 入力デバイスからMain Engineへの矢印。
- Main Engineから各モジュール（Enemy, Movement, Map, Sound）への呼び出しを示す矢印。
- 戻ってくる更新結果の流れも明示する。
・異なるコンポーネントの種類は、色分けまたは異なる形（丸、四角、楕円など）を利用して区別する。
・特に詳細化する必要がある点として、Enemy Handling と Movement Logic の各内部処理（例えば、敵キャラクターの各行動パターンの分岐、またはプレイヤーの移動における衝突判定とスクロール制御）をサブモジュールとして内側にブレークダウンすると分かりやすくなります。

【7. 図作成時のポイントまとめ】
- すべてのコンポーネントには明確な名前と役割（例：「Enemy AI」、「Player Movement」、「Game Loop Controller」など）を付ける。
- 矢印でどのモジュールが誰にデータを渡すのか、どこでフィードバックが発生するのかを分かるようにする。
- 色分けやシェイプを使って、処理の種類（コア処理、サブ処理、イベント駆動など）を視覚的に区別する。
- 敵処理、移動ロジック、そしてコアロジックの内部サブプロセス（例えば、状態更新、入力処理、画面描画呼び出し）をできる限り詳細に分割し、どのタイミングで各処理が呼び出されるかを説明するノートを併記する。

以上の手順で、主要なゲームシステムの各要素と、その中でも特に敵処理（enemy handling）と移動ロジック（movement logic）、およびゲーム全体のコアロジックの連携を詳細に表現したシステム設計図が完成します。これにより、実装の全体像を一目で把握でき、今後のデバッグや機能追加の際にも横断的に理解しやすいアーキテクチャが形成されるはずです。

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Game Core"
        ME["Main Engine (HMAIN)"]:::coreLogic
        IP["Input Processing"]:::subProcess
        ULC["Update Loop Controller"]:::coreLogic
        ME -->|"processes"| IP
        IP -->|"start_loop"| ULC
    end

    subgraph "Enemy Handling Module"
        EH["Enemy Handling (HATENM)"]:::enemy
        EInit["Enemy Initialization"]:::enemy
        EAI["EnemyAI"]:::enemy
        EColl["Collision_and_Damage"]:::enemy
        ERsp["Enemy_Respawn"]:::enemy
        EH -->|"initializes"| EInit
        EH -->|"executes"| EAI
        EH -->|"checks_collision"| EColl
        EH -->|"handles_respawn"| ERsp
    end

    subgraph "Movement Logic Module"
        MV["Movement Logic (HATMOV)"]:::movement
        MMCalc["Input_Move_Calc"]:::movement
        MColl["Collision_Boundaries"]:::movement
        MScroll["Scroll_and_Anim"]:::movement
        MV -->|"calculates_move"| MMCalc
        MV -->|"checks_collision"| MColl
        MV -->|"handles_scroll"| MScroll
    end

    subgraph "Map/Tile Management"
        MM["Map Controller (HATMAP)"]:::map
        MT["Tile Renderer (HATTIL)"]:::map
    end

    subgraph "Sound & Music Management"
        SM["Sound Manager (HATMUS)"]:::sound
        BGM["BGM Script (HTBGM)"]:::sound
        BONUS["Bonus Sound Script (HTBONUS)"]:::sound
    end

    %% Inter-module Relationships
    ME -->|"calls_enemy_update"| EH
    ME -->|"calls_movement_update"| MV
    ME -->|"updates_map"| MM
    ME -->|"updates_map_tiles"| MT
    ME -->|"updates_sound"| SM
    ME -->|"updates_sound"| BGM
    ME -->|"updates_sound"| BONUS

    EH -->|"sends_status"| ME
    MV -->|"sends_position"| ME

    ULC -->|"invokes_enemy_module"| EH
    ULC -->|"invokes_movement_module"| MV
    ULC -->|"invokes_sound_module"| SM

    click ME "https://github.com/omuanko/nnjhtrkn/blob/master/HMAIN.A65"
    click EH "https://github.com/omuanko/nnjhtrkn/blob/master/HATENM.A65"
    click MV "https://github.com/omuanko/nnjhtrkn/blob/master/HATMOV.A65"
    click MM "https://github.com/omuanko/nnjhtrkn/blob/master/HATMAP.A65"
    click MT "https://github.com/omuanko/nnjhtrkn/blob/master/HATTIL.A65"
    click SM "https://github.com/omuanko/nnjhtrkn/blob/master/HATMUS.A65"
    click BGM "https://github.com/omuanko/nnjhtrkn/blob/master/HTBGM.SCR"
    click BONUS "https://github.com/omuanko/nnjhtrkn/blob/master/HTBONUS.SCR"

    classDef coreLogic fill:#F8E0E0,stroke:#FF0000,stroke-width:2px;
    classDef enemy fill:#E0F8E0,stroke:#008000,stroke-width:2px;
    classDef movement fill:#E0E0F8,stroke:#0000FF,stroke-width:2px;
    classDef map fill:#FFF8E0,stroke:#FF9900,stroke-width:2px;
    classDef sound fill:#E8E8E8,stroke:#999999,stroke-width:2px;
    classDef subProcess fill:#FFE0F8,stroke:#CC00CC,stroke-width:1px;
```
