mkdocs.yml

site_name: 吉里吉里Z ドキュメント
site_description: 吉里吉里Z (Kirikiri Z) の TJS2 リファレンス・ガイド・仕様書
site_url: https://wamsoft.github.io/krkrz_dev/
repo_url: https://github.com/wamsoft/krkrz_dev
repo_name: wamsoft/krkrz_dev
edit_uri: edit/develop/doc/
copyright: "(c) Kirikiri Z Project / Wamsoft Ltd. Partnership"

docs_dir: doc

# ブラウザ実行デモ (doc/_assets/demo) を iframe 埋め込みで動かすため、全ページで
# coi-serviceworker を登録し crossOriginIsolated (SharedArrayBuffer) を成立させる。
# GitHub Pages は COOP/COEP ヘッダを設定できないため、SW でクライアント側に注入する。
# 既定 COEP=credentialless なので外部リソース (テーマのフォント等) は壊れにくい。
extra_javascript:
  - coi-serviceworker.js

theme:
  name: material
  language: ja
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: amber
      toggle:
        icon: material/weather-night
        name: ダークモードに切替
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: ライトモードに切替
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
    - toc.follow

plugins:
  - search:
      lang: ja
      separator: '[\s\-,:!=\[\]()"/]+|\.(?!\d)|&[lg]t;'

markdown_extensions:
  - admonition
  - tables
  - attr_list
  - md_in_html
  - footnotes
  - toc:
      permalink: true
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.details

# 自動生成のメタファイル類はサイト内に出さない
exclude_docs: |
  _missing.md
  _inventory.json

nav:
  - デモ: demos.md
  - 吉里吉里Z:
    - guide/about.md
    - 入門・運用:
      - 起動: guide/Startup.md
      - コマンドラインオプション: guide/CommandLine.md
      - 吉里吉里設定: guide/Configure.md
      - コンソール: guide/Console.md
      - デバッグ: guide/Debug.md
      - 環境依存の不具合: guide/ComputerDependentProblems.md
      - 著作権など: guide/Copyrights.md
      - ライセンス情報の取得と表示: guide/Licenses.md
      - 同梱ライセンス一覧: guide/BundledLicenses.md
      - ファイル一覧: guide/Files.md
    - サブシステム:
      - イベントシステム: guide/EventSystem.md
      - グラフィックシステム: guide/GraphicSystem.md
      - Layer と Bitmap と ImageFunction: guide/LayerAndBitmap.md
      - 3Dグラフィックシステム: guide/Graphic3DSystem.md
      - サウンドシステム: guide/SoundSystem.md
      - ストレージシステム: guide/StorageSystem.md
      - ダイアログ: guide/ElementsDialog.md
      - 読み上げ (スクリーンリーダー): guide/Accessibility.md
      - フォントシステム: guide/FontSystem.md
      - トランジション: guide/Transition.md
      - プラグイン: guide/Plugins.md
    - 標準ツール:
      - 標準ツールについて: guide/Tools.md
      - xp3 アーカイブツール: guide/Xp3Tool.md
      - キー・署名ツール: guide/SignTool.md
      - ファイル破損チェックツール: guide/FileChkTool.md
      - 画像フォーマットコンバータ: guide/TPC.md
      - 音声フォーマットコンバータ: guide/AudioConverter.md
      - ループチューナ: guide/LoopTuner.md
      - リリーサ: guide/Releaser.md
      - レンダリング済みフォントデータの作成: guide/FontMaker.md
    - 定数一覧:
      - 仮想キーコード: guide/KeyCodes.md
      - マウスカーソル: guide/MouseCursors.md
      - 色定数: guide/ColorCodes.md
  - TJS2言語仕様:
    - tjs2/index.md
    - 概要:
      - TJS2 について: tjs2/about.md
      - スタイルなど: tjs2/style.md
    - 構文:
      - トークン: tjs2/token.md
      - 項: tjs2/factor.md
      - 式と演算子: tjs2/expr_and_op.md
      - ステートメントとブロック: tjs2/statement_and_block.md
      - if ステートメント: tjs2/if.md
      - switch ステートメント: tjs2/switch.md
      - for ステートメント: tjs2/for.md
      - while ステートメント: tjs2/while.md
      - with ステートメント: tjs2/with.md
      - 例外処理: tjs2/try.md
      - プリプロセッサ: tjs2/pp.md
    - 言語要素:
      - 変数: tjs2/variable.md
      - データ型: tjs2/types.md
      - 関数: tjs2/function.md
      - クラス: tjs2/class.md
      - プロパティ: tjs2/property.md
    - 内部仕様:
      - 組み込み方法: tjs2/simple.md
      - 基本型: tjs2/basictypes.md
      - iTJSDispatch2 インターフェース: tjs2/interface.md
      - tTJSVariant 型: tjs2/variant.md
      - tTJS: tjs2/ttjs.md
      - 仮想マシン: tjs2/vmcodes.md
  - クラスリファレンス:
    - 吉里吉里Z コアクラス:
      - reference/AsyncTrigger.md
      - reference/Bitmap.md
      - reference/BitmapLayerTreeOwner.md
      - reference/ElementsDialog.md
      - reference/ElementsPanel.md
      - reference/Font.md
      - reference/ImageFunction.md
      - reference/Layer.md
      - reference/Rect.md
      - reference/SoundBuffer.md
      - reference/SoundListener.md
      - reference/Timer.md
      - reference/VideoOverlay.md
      - reference/WaveSoundBuffer.md
      - reference/WaveSoundBuffer.PhaseVocoder.md
      - reference/Window.md
      - reference/Window.BasicDrawDevice.md
      - reference/SDLOGLDrawDevice.md
      - reference/SDLDrawDevice.md
      - reference/NullDrawDevice.md
    - 吉里吉里Z 3D機能クラス:
      - reference/OGLDrawDevice.md
      - reference/GPUDrawDevice.md
      - reference/Canvas.md
      - reference/Texture.md
      - reference/Offscreen.md
      - reference/ShaderProgram.md
      - reference/VertexBuffer.md
      - reference/VertexBinder.md
      - reference/Matrix32.md
      - reference/Matrix44.md
      - reference/GLCompositor.md
    - 吉里吉里Z 管理機能クラス:
      - reference/System.md
      - reference/Storages.md
      - reference/Debug.md
      - reference/Scripts.md
      - reference/Plugins.md
      - reference/Clipboard.md
      - reference/Controller.md
      - reference/Agent.md
      - reference/WebServer.md
    - TJS2 組み込みクラス・型:
      - Array クラス: tjs2/array.md
      - Date クラス: tjs2/date.md
      - Dictionary クラス: tjs2/dictionary.md
      - Exception クラス: tjs2/exception.md
      - Math クラス: tjs2/math.md
      - Math.RandomGenerator クラス: tjs2/randomgenerator.md
      - RegExp クラス: tjs2/regexp.md
      - 文字列: tjs2/string.md
      - オクテット列: tjs2/octet.md
    - プラグイン拡張クラス:
      - reference/AlphaMovie.md
      - reference/BinaryStream.md
      - reference/CLIP.md
      - reference/CLIPWriter.md
      - reference/Console.md
      - reference/CSVParser.md
      - reference/HttpRequest.md
      - reference/SimpleHTTPServer.md
      - reference/KAGParser.md
      - reference/LineParser.md
      - reference/MenuItem.md
      - reference/Pad.md
      - reference/Process.md
      - reference/PSD.md
      - reference/PreRenderedFontImage.md
      - reference/Steam.md
      - reference/TemporaryFiles.md
      - reference/Zip.md
      - reference/Unzip.md
      - reference/XMLParser.md
      - GLES 描画 (krkrgles):
        - reference/GLESAdaptor.md
        - reference/GLESTexture.md
      - Effekseer (krkreffekseer):
        - reference/EffekseerDevice.md
        - reference/EffekseerEffect.md
        - reference/EffekseerPlayer.md
      - Live2D (krkrlive2d):
        - reference/Live2DDevice.md
        - reference/Live2DModel.md
        - reference/Live2DPlayer.md
      - 3D (krkrthreepp):
        - reference/threepp/index.md
      - 描画 (layerExDraw):
        - reference/GdiPlus.md
        - reference/GdiPlus.Appearance.md
        - reference/GdiPlus.Font.md
        - reference/GdiPlus.Image.md
        - reference/GdiPlus.Matrix.md
        - reference/GdiPlus.Path.md
        - reference/GdiPlus.PointF.md
        - reference/GdiPlus.RectF.md
      - リッチテキスト (krkr_richtext):
        - reference/RichText.md
        - reference/RichText.Style.md
        - reference/RichText.Appearance.md
        - reference/RichText.Layout.md
        - reference/RichText.ParagraphLayout.md
        - reference/RichText.StyledLayout.md
        - reference/RichText.TextureAtlas.md
        - reference/RichTextRenderBase.md
      - リソース (resourceRW):
        - reference/ResourceReader.md
        - reference/ResourceWriter.md
        - reference/ResourceIconGroup.md
        - reference/ResourceIconImage.md
        - reference/ResourceVersionInfo.md
      - Win32:
        - reference/WIN32Dialog.md
        - reference/WIN32Dialog.Header.md
        - reference/WIN32Dialog.Items.md
        - reference/WIN32DialogEX.md
        - reference/WIN32OLE.md
        - reference/ActiveX.md
        - reference/JScriptHost.md
      - TJS 組み込み拡張:
        - reference/Array.md
        - reference/Dictionary.md
        - reference/Math.md
  - 仕様書:
    - specification/index.md
    - システム構成: specification/system.md
    - ファイルフォーマット: specification/fileformat.md
    - 動画再生機能: specification/movie.md
    - 画像処理機能: specification/graphics.md
    - 音声再生機能: specification/sound.md
    - アクセシビリティ (スクリーンリーダー): specification/accessibility.md
  - 周辺情報:
    - topics/index.md
    - ユーザー向け情報:
      - エンジン設定ツール: topics/user/engine_setting.md
    - TJS2 で利用する機能:
      - ツールチップの表示方法: topics/tjs2/tooltip.md
      - 非同期画像読み込み: topics/tjs2/asyncimageload.md
      - 吉里吉里2と吉里吉里Zの判別方法: topics/tjs2/check_2_z.md
      - 動画の再生方法: topics/tjs2/playmovie.md
      - Wamsoft 派生版で削除/追加された機能: topics/tjs2/wamsoft_changes.md
      - 吉里吉里Zで削除された機能: topics/tjs2/deleted.md
      - サポートするファイルフォーマット: topics/tjs2/fileformat.md
      - 型指定構文: topics/tjs2/type_specified.md
      - よくある落とし穴: topics/tjs2/pitfalls.md
    - ツール:
      - Releaser: topics/tools/releaser.md
    - 本体 (exe) 変更者向け情報:
      - エンジン設定の追加/編集: topics/core/engine_setting.md
      - 吉里吉里Z固有のクラッキング対策: topics/core/anti_cracking.md
      - メモリ不足対策: topics/core/low_memory.md
      - メモリ観測・リーク調査: topics/core/memory_observation.md
      - 描画スレッドプール利用率の計測 (DrawStats): topics/core/draw_stats.md
      - Elements UI 機構の全体像: topics/core/elements.md
      - ゲームパッド入力: topics/core/gamepad.md
      - ゲームパッド状態の観察 (PadOverlay): topics/core/pad_overlay.md
      - REPL (対話型 TJS シェル): topics/core/repl.md
      - Steam Deck 実機確認 (リリース前チェック): topics/core/steamdeck.md
      - Linux 版の配布パッケージ (krkrz_linux): topics/core/linux_package.md
      - ゲーム画面の表示画角制御 (ビューポート): topics/core/viewport.md
      - ログ出力: topics/core/logging.md
    - ライセンス: topics/LICENSE.md