VOICEVOX ENGINEの起動引数と環境変数に関するドキュメントのたたき台（docs/起動引数と環境変数.md）

起動引数と環境変数.md

起動引数と環境変数

一覧

設定内容	起動引数	環境変数
プリセットファイルの指定	--preset_file	VV_PRESET_FILE
設定内容2	--hoge	VV_HOGE

プリセットファイルの指定

GET /presets、POST /add_preset、POST /audio_query_from_presetなどで使われるプリセットファイルのパスを指定します。

設定

起動引数	--preset_file
環境変数	VV_PRESET_FILE
設定する値	絶対パスまたは作業ディレクトリからの相対パスの文字列
設定例	./presets.yaml

フローチャート

• ${VOICEVOX_DIR}: 引数 --voicevox_dir のパス
• ${ENGINE_DIR}: エンジンの実行ファイルがあるディレクトリのパス

graph TB
  START("Start")

  IF_ENV_DEFINED{"環境変数 VV_PRESET_FILE が定義されているか?"}
  IF_ENV_EMPTY{"環境変数 VV_PRESET_FILE が空文字列か?"}
  SELECT_ENV("環境変数 VV_PRESET_FILE のパスを選択")

  IF_ARG_DEFINED{"引数 --preset_file が定義されているか?"}
  SELECT_ARG("引数 --preset_file のパスを選択")

  IF_VOICEVOX_DIR_DEFINED{"引数 --voicevox_dir が定義されているか?"}
  SELECT_VOICEVOX_DIR("${VOICEVOX_DIR}/presets.yaml を選択")

  SELECT_ENGINE_DIR("${ENGINE_DIR}/presets.yaml を選択")

  START --> IF_ARG_DEFINED
  IF_ARG_DEFINED -->|Yes| SELECT_ARG
  IF_ARG_DEFINED -->|No| IF_ENV_DEFINED

  IF_ENV_DEFINED -->|Yes| IF_ENV_EMPTY
  IF_ENV_DEFINED -->|No| IF_VOICEVOX_DIR_DEFINED

  IF_ENV_EMPTY -->|Yes| IF_VOICEVOX_DIR_DEFINED
  IF_ENV_EMPTY -->|No| SELECT_ENV

  IF_VOICEVOX_DIR_DEFINED -->|Yes| SELECT_VOICEVOX_DIR
  IF_VOICEVOX_DIR_DEFINED -->|No| SELECT_ENGINE_DIR

設定内容2

略

設定

略

フローチャート

略