https://github.com/void2610/my-unity-settings
https://github.com/void2610/my-unity-settings
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/void2610/my-unity-settings
- Owner: void2610
- License: mit
- Created: 2025-12-15T15:10:10.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2026-04-15T00:05:47.000Z (3 months ago)
- Last Synced: 2026-04-15T02:20:51.035Z (3 months ago)
- Language: C#
- Size: 67.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# SettingsSystem
Unity向けの汎用設定画面システム。R3リアクティブプログラミングとVContainerを活用した、拡張性の高い設定管理パッケージ。
## 特徴
- **リアクティブ設計**: R3を使用した設定値の変更監視と自動反映
- **型安全な設定項目**: スライダー、ボタン、列挙型の3種類をサポート
- **永続化対応**: JSON形式でのデータ保存・読み込み
- **カスタマイズ可能**: プロジェクト固有の設定を`ISettingsDefinition`で定義
- **UIナビゲーション**: ゲームパッド対応の設定画面ナビゲーション
## 依存パッケージ
- [R3](https://github.com/Cysharp/R3) - リアクティブプログラミング
- [UniTask](https://github.com/Cysharp/UniTask) - 非同期処理
- [VContainer](https://github.com/hadashiA/VContainer) - 依存性注入
- TextMeshPro - UI表示
## インストール
### git submoduleとして追加
```bash
# リポジトリルートに追加
git submodule add https://github.com/void2610/my-unity-settings.git my-unity-settings
# Assets/Scripts/にシンボリックリンク作成
ln -s ../../my-unity-settings Assets/Scripts/SettingsSystem
```
## 使い方
### 1. 設定定義クラスの作成
プロジェクト固有の設定を`ISettingsDefinition`を実装して定義:
```csharp
public class GameSettingsDefinition : ISettingsDefinition
{
public IEnumerable CreateSettings()
{
yield return new SliderSetting(
name: "BGM音量",
desc: "BGMの音量を設定します",
defaultVal: 0.5f,
min: 0f,
max: 1f
);
yield return new EnumSetting(
name: "画質",
desc: "グラフィック品質を設定",
opts: new[] { "low", "medium", "high" },
defaultValue: "medium",
displayNames: new[] { "低", "中", "高" }
);
yield return new ButtonSetting(
name: "データ削除",
desc: "セーブデータを削除",
btnText: "削除",
needsConfirmation: true,
confirmMsg: "本当に削除しますか？"
);
}
public void BindSettingActions(IReadOnlyList settings, CompositeDisposable disposables)
{
foreach (var setting in settings)
{
switch (setting)
{
case SliderSetting { SettingName: "BGM音量" } s:
s.OnSettingChanged
.Subscribe(_ => AudioManager.Instance.BgmVolume = s.CurrentValue)
.AddTo(disposables);
break;
}
}
}
}
```
### 2. VContainerでの登録
```csharp
public class RootLifetimeScope : LifetimeScope
{
protected override void Configure(IContainerBuilder builder)
{
// 設定システムの登録
builder.Register(Lifetime.Singleton);
builder.Register(Lifetime.Singleton).As();
builder.Register(Lifetime.Singleton);
}
}
```
### 3. 確認ダイアログの実装
ボタン設定で確認が必要な場合、`IConfirmationDialog`を実装:
```csharp
public class ConfirmationDialogService : IConfirmationDialog
{
public async UniTask ShowDialog(string message, string confirmText)
{
// ダイアログ表示ロジック
return await ShowConfirmationUI(message, confirmText);
}
}
```
## フォルダ構成
```
SettingsSystem/
├── Core/ # 設定タイプ定義
│ ├── SettingBase.cs # 基底クラス
│ ├── SliderSetting.cs # スライダー設定
│ ├── ButtonSetting.cs # ボタン設定
│ └── EnumSetting.cs # 列挙型設定
├── Manager/
│ ├── SettingsManager.cs # 設定管理
│ └── ISettingsDefinition.cs
├── Persistence/
│ └── DataPersistence.cs # データ永続化
├── UI/
│ ├── Abstractions/ # インターフェース
│ ├── Items/ # 設定項目UI
│ ├── Presenters/ # MVP Presenter
│ ├── Utils/ # ユーティリティ
│ └── Views/ # MVP View
└── SettingsSystem.asmdef
```
## 設定タイプ
| タイプ | 用途 | 値の型 |
|--------|------|--------|
| `SliderSetting` | 数値調整（音量、感度等） | `float` |
| `EnumSetting` | 選択肢から選択 | `string` |
| `ButtonSetting` | アクション実行 | - |
## ライセンス
MIT License