LCOV - code coverage report
Current view: top level - config - config.go Coverage Total Hit
Test: coverage.lcov Lines: 100.0 % 142 142
Test Date: 2026-11-19 00:25:22 Functions: - 0 0

            Line data    Source code
       1              : package config
       2              : 
       3              : import (
       4              :         "errors"
       5              :         "fmt"
       6              :         "math/rand/v2"
       7              :         "os"
       8              : 
       9              :         "github.com/kijimaD/ruins/internal/consts"
      10              :         "github.com/kijimaD/ruins/internal/i18n"
      11              : )
      12              : 
      13              : // Profile は設定プロファイルを表す
      14              : type Profile string
      15              : 
      16              : const (
      17              :         // ProfileProduction は本番環境プロファイル
      18              :         ProfileProduction Profile = "production"
      19              :         // ProfileDevelopment は開発環境プロファイル
      20              :         ProfileDevelopment Profile = "development"
      21              : )
      22              : 
      23              : // Config はアプリケーションの設定を管理する
      24              : type Config struct {
      25              :         // 設定のデフォルト値を決定するプロファイル
      26              :         Profile Profile `env:"RUINS_PROFILE" envDefault:"production"`
      27              : 
      28              :         // プレイヤーが変更してファイルに永続化するユーザー設定
      29              :         User UserConfig
      30              : 
      31              :         // デバッグモードを有効にする。有効時は設定情報をログ出力する
      32              :         Debug bool `env:"RUINS_DEBUG"`
      33              :         // ログレベルを指定する
      34              :         LogLevel string `env:"RUINS_LOG_LEVEL"`
      35              :         // 出力するログカテゴリをカンマ区切りで指定する
      36              :         LogCategories string `env:"RUINS_LOG_CATEGORIES"`
      37              :         // pprofサーバーを起動するかどうか
      38              :         DebugPProf bool `env:"RUINS_DEBUG_PPROF"`
      39              :         // pprofサーバーのポート番号
      40              :         PProfPort int `env:"RUINS_PPROF_PORT"`
      41              :         // パフォーマンスモニターを表示するかどうか
      42              :         ShowMonitor bool `env:"RUINS_SHOW_MONITOR"`
      43              :         // AI行動のデバッグ表示を有効にするかどうか
      44              :         ShowAIDebug bool `env:"RUINS_SHOW_AI_DEBUG"`
      45              :         // マップのデバッグ表示を有効にするかどうか
      46              :         ShowMapDebug bool `env:"RUINS_SHOW_MAP_DEBUG"`
      47              :         // エンカウントを無効化するかどうか
      48              :         NoEncounter bool `env:"RUINS_NO_ENCOUNTER"`
      49              :         // プレイヤーを無敵にするかどうか。毎フレーム HP・体温・空腹・疲労を満たし、倒れても起こす
      50              :         DebugInvincible bool `env:"RUINS_DEBUG_INVINCIBLE"`
      51              : 
      52              :         // オープニング演出をスキップするかどうか
      53              :         SkipOpening bool `env:"RUINS_SKIP_OPENING"`
      54              :         // 起動時に最新のオートセーブを読み込んで続きから始めるかどうか
      55              :         Continue bool `env:"RUINS_CONTINUE"`
      56              :         // アニメーション演出を無効化するかどうか
      57              :         DisableAnimation bool `env:"RUINS_DISABLE_ANIMATION"`
      58              :         // 画面のポスト処理、レトロフィルタのスキャンラインと色収差、を無効化するかどうか。
      59              :         // VRT はこれを立てて撮る。スキャンラインは全画面の高周波パターンで、フォントの
      60              :         // アンチエイリアスや GL 実装差をピクセル比較上で増幅し、ゴールデンの再現性を落とす
      61              :         DisableScreenFilter bool `env:"RUINS_DISABLE_SCREEN_FILTER"`
      62              :         // オートセーブを無効化するか。再生とテストが立て、副作用でセーブファイルを書かないようにする
      63              :         DisableAutoSave bool `env:"RUINS_DISABLE_AUTOSAVE"`
      64              : 
      65              :         // セーブ・ロードを有効にするか。env でなく profile と steam タグで決まる導出値。
      66              :         // development は常に true で、開発時の起動とテストが保存を試せる。production は steam タグの
      67              :         // ときだけ true で、Steam 版がフル版になる。既定配布と WASM は production かつタグなしなので
      68              :         // false になり、体験版としてセーブ・ロードを出さない。
      69              :         SaveLoadEnabled bool
      70              : 
      71              :         // 乱数シード。環境変数で指定すると再現可能になる。未指定の場合は自動生成される
      72              :         Seed uint64 `env:"RUINS_SEED"`
      73              :         // 乱数生成器。Seedから生成される
      74              :         RNG *rand.Rand
      75              : 
      76              :         // 描画のターゲットFPS
      77              :         TargetFPS int `env:"RUINS_TARGET_FPS"`
      78              :         // メモリプロファイルを取得するかどうか
      79              :         ProfileMemory bool `env:"RUINS_PROFILE_MEMORY"`
      80              :         // CPUプロファイルを取得するかどうか
      81              :         ProfileCPU bool `env:"RUINS_PROFILE_CPU"`
      82              :         // Mutexプロファイルを取得するかどうか
      83              :         ProfileMutex bool `env:"RUINS_PROFILE_MUTEX"`
      84              :         // トレースプロファイルを取得するかどうか
      85              :         ProfileTrace bool `env:"RUINS_PROFILE_TRACE"`
      86              :         // プロファイル出力先のディレクトリパス
      87              :         ProfilePath string `env:"RUINS_PROFILE_PATH"`
      88              : }
      89              : 
      90              : // UserConfig はプレイヤーが変更してファイルに永続化するユーザー設定を表す。
      91              : // この構造体に含めたフィールドだけが設定ファイルへ書き出される。
      92              : // デバッグ用フィールドを混ぜないことで、永続化対象を構造で明示する。
      93              : type UserConfig struct {
      94              :         // ゲームウィンドウの幅(ピクセル)
      95              :         WindowWidth int `env:"RUINS_WINDOW_WIDTH" toml:"window_width"`
      96              :         // ゲームウィンドウの高さ(ピクセル)
      97              :         WindowHeight int `env:"RUINS_WINDOW_HEIGHT" toml:"window_height"`
      98              :         // 表示言語の言語コード。"ja" / "en"
      99              :         Language string `env:"RUINS_LANGUAGE" toml:"language"`
     100              : }
     101              : 
     102              : // DefaultUserConfig はユーザー設定のデフォルト値を返す。
     103              : // 設定ファイルが存在しない場合や、新規フィールド追加でファイルに値が無い場合の補完に使う。
     104              : func DefaultUserConfig() UserConfig {
     105            1 :         return UserConfig{
     106            1 :                 WindowWidth:  960,
     107            1 :                 WindowHeight: 720,
     108            1 :                 Language:     "en",
     109            1 :         }
     110              : }
     111              : 
     112              : // ApplyProfileDefaults はプロファイルに基づいてデフォルト値を設定する
     113              : func (c *Config) ApplyProfileDefaults() {
     114              :         // ユーザー設定のデフォルトはプロファイルによらず共通
     115            1 :         c.User = DefaultUserConfig()
     116            1 : 
     117            1 :         switch c.Profile {
     118              :         case ProfileProduction:
     119            1 :                 c.applyProductionDefaults()
     120              :         case ProfileDevelopment:
     121            1 :                 c.applyDevelopmentDefaults()
     122              :         default:
     123              :                 // デフォルトは本番設定
     124            1 :                 c.applyProductionDefaults()
     125              :         }
     126              : }
     127              : 
     128              : // applyProductionDefaults は本番環境のデフォルト値を設定
     129              : func (c *Config) applyProductionDefaults() {
     130              :         // デバッグ設定
     131            1 :         if os.Getenv("RUINS_DEBUG") == "" {
     132            1 :                 c.Debug = false
     133            1 :         }
     134            1 :         if os.Getenv("RUINS_LOG_LEVEL") == "" {
     135            1 :                 c.LogLevel = "info"
     136            1 :         }
     137            1 :         if os.Getenv("RUINS_LOG_CATEGORIES") == "" {
     138            1 :                 c.LogCategories = ""
     139            1 :         }
     140            1 :         if os.Getenv("RUINS_DEBUG_PPROF") == "" {
     141            1 :                 c.DebugPProf = false
     142            1 :         }
     143            1 :         if os.Getenv("RUINS_PPROF_PORT") == "" {
     144            1 :                 c.PProfPort = 6060
     145            1 :         }
     146            1 :         if os.Getenv("RUINS_SHOW_MONITOR") == "" {
     147            1 :                 c.ShowMonitor = false
     148            1 :         }
     149            1 :         if os.Getenv("RUINS_SHOW_MAP_DEBUG") == "" {
     150            1 :                 c.ShowMapDebug = false
     151            1 :         }
     152            1 :         if os.Getenv("RUINS_NO_ENCOUNTER") == "" {
     153            1 :                 c.NoEncounter = false
     154            1 :         }
     155              : 
     156              :         // ゲーム設定
     157            1 :         if os.Getenv("RUINS_SKIP_OPENING") == "" {
     158            1 :                 c.SkipOpening = false
     159            1 :         }
     160            1 :         if os.Getenv("RUINS_DISABLE_ANIMATION") == "" {
     161            1 :                 c.DisableAnimation = false
     162            1 :         }
     163            1 :         if os.Getenv("RUINS_DISABLE_SCREEN_FILTER") == "" {
     164            1 :                 c.DisableScreenFilter = false
     165            1 :         }
     166            1 :         if os.Getenv("RUINS_DISABLE_AUTOSAVE") == "" {
     167            1 :                 c.DisableAutoSave = false
     168            1 :         }
     169            1 :         c.SaveLoadEnabled = consts.IsSteamBuild
     170            1 : 
     171              :         // パフォーマンス設定
     172            1 :         if os.Getenv("RUINS_TARGET_FPS") == "" {
     173            1 :                 c.TargetFPS = 60
     174            1 :         }
     175              : 
     176              :         // プロファイル設定
     177            1 :         if os.Getenv("RUINS_PROFILE_MEMORY") == "" {
     178            1 :                 c.ProfileMemory = false
     179            1 :         }
     180            1 :         if os.Getenv("RUINS_PROFILE_CPU") == "" {
     181            1 :                 c.ProfileCPU = false
     182            1 :         }
     183            1 :         if os.Getenv("RUINS_PROFILE_MUTEX") == "" {
     184            1 :                 c.ProfileMutex = false
     185            1 :         }
     186            1 :         if os.Getenv("RUINS_PROFILE_TRACE") == "" {
     187            1 :                 c.ProfileTrace = false
     188            1 :         }
     189            1 :         if os.Getenv("RUINS_PROFILE_PATH") == "" {
     190            1 :                 c.ProfilePath = "."
     191            1 :         }
     192              : }
     193              : 
     194              : // applyDevelopmentDefaults は開発環境のデフォルト値を設定
     195              : func (c *Config) applyDevelopmentDefaults() {
     196              :         // デバッグ設定
     197            1 :         if os.Getenv("RUINS_DEBUG") == "" {
     198            1 :                 c.Debug = true
     199            1 :         }
     200            1 :         if os.Getenv("RUINS_LOG_LEVEL") == "" {
     201            1 :                 c.LogLevel = "info"
     202            1 :         }
     203            1 :         if os.Getenv("RUINS_LOG_CATEGORIES") == "" {
     204            1 :                 c.LogCategories = ""
     205            1 :         }
     206            1 :         if os.Getenv("RUINS_DEBUG_PPROF") == "" {
     207            1 :                 c.DebugPProf = true
     208            1 :         }
     209            1 :         if os.Getenv("RUINS_PPROF_PORT") == "" {
     210            1 :                 c.PProfPort = 6060
     211            1 :         }
     212            1 :         if os.Getenv("RUINS_SHOW_MONITOR") == "" {
     213            1 :                 c.ShowMonitor = false
     214            1 :         }
     215            1 :         if os.Getenv("RUINS_SHOW_MAP_DEBUG") == "" {
     216            1 :                 c.ShowMapDebug = false
     217            1 :         }
     218            1 :         if os.Getenv("RUINS_NO_ENCOUNTER") == "" {
     219            1 :                 c.NoEncounter = false
     220            1 :         }
     221              : 
     222              :         // ゲーム設定
     223            1 :         if os.Getenv("RUINS_SKIP_OPENING") == "" {
     224            1 :                 c.SkipOpening = true
     225            1 :         }
     226            1 :         if os.Getenv("RUINS_CONTINUE") == "" {
     227            1 :                 c.Continue = true
     228            1 :         }
     229            1 :         if os.Getenv("RUINS_DISABLE_ANIMATION") == "" {
     230            1 :                 c.DisableAnimation = false
     231            1 :         }
     232            1 :         if os.Getenv("RUINS_DISABLE_SCREEN_FILTER") == "" {
     233            1 :                 c.DisableScreenFilter = false
     234            1 :         }
     235            1 :         if os.Getenv("RUINS_DISABLE_AUTOSAVE") == "" {
     236            1 :                 c.DisableAutoSave = false
     237            1 :         }
     238            1 :         c.SaveLoadEnabled = true
     239            1 : 
     240              :         // パフォーマンス設定
     241            1 :         if os.Getenv("RUINS_TARGET_FPS") == "" {
     242            1 :                 c.TargetFPS = 60
     243            1 :         }
     244              : 
     245              :         // プロファイル設定
     246            1 :         if os.Getenv("RUINS_PROFILE_MEMORY") == "" {
     247            1 :                 c.ProfileMemory = true
     248            1 :         }
     249            1 :         if os.Getenv("RUINS_PROFILE_CPU") == "" {
     250            1 :                 c.ProfileCPU = false
     251            1 :         }
     252            1 :         if os.Getenv("RUINS_PROFILE_MUTEX") == "" {
     253            1 :                 c.ProfileMutex = false
     254            1 :         }
     255            1 :         if os.Getenv("RUINS_PROFILE_TRACE") == "" {
     256            1 :                 c.ProfileTrace = false
     257            1 :         }
     258            1 :         if os.Getenv("RUINS_PROFILE_PATH") == "" {
     259            1 :                 c.ProfilePath = "./profiles" // 開発時は専用フォルダ
     260            1 :         }
     261              : }
     262              : 
     263              : // 検証エラーの種類を識別するためのセンチネルエラー
     264              : var (
     265              :         errWindowWidthTooSmall  = errors.New("window width is too small")
     266              :         errWindowHeightTooSmall = errors.New("window height is too small")
     267              :         errTargetFPSInvalid     = errors.New("invalid target FPS")
     268              :         errPProfPortOutOfRange  = errors.New("pprof port out of range")
     269              :         errUnsupportedLanguage  = errors.New("unsupported language")
     270              : )
     271              : 
     272              : // Validate は設定値が妥当な範囲にあるか検証する。
     273              : // 不正な値があればエラーを返す。値の補正は行わず、呼び出し側が起動中止などを判断する。
     274              : func (c *Config) Validate() error {
     275            1 :         if c.User.WindowWidth < 320 {
     276            1 :                 return fmt.Errorf("%w: %d, minimum 320", errWindowWidthTooSmall, c.User.WindowWidth)
     277            1 :         }
     278            1 :         if c.User.WindowHeight < 240 {
     279            1 :                 return fmt.Errorf("%w: %d, minimum 240", errWindowHeightTooSmall, c.User.WindowHeight)
     280            1 :         }
     281            1 :         if !i18n.IsSupportedLang(c.User.Language) {
     282            1 :                 return fmt.Errorf("%w: %q", errUnsupportedLanguage, c.User.Language)
     283            1 :         }
     284            1 :         if c.TargetFPS < 1 {
     285            1 :                 return fmt.Errorf("%w: %d, at least 1", errTargetFPSInvalid, c.TargetFPS)
     286            1 :         }
     287            1 :         if c.PProfPort < 1024 || c.PProfPort > 65535 {
     288            1 :                 return fmt.Errorf("%w: %d, range 1024 to 65535", errPProfPortOutOfRange, c.PProfPort)
     289            1 :         }
     290            1 :         return nil
     291              : }
        

Generated by: LCOV version 2.0-1