https://github.com/mixtuti/aes_save-for-unity
PlayerPrefsをAES暗号を用いて保存するライブラリ
https://github.com/mixtuti/aes_save-for-unity
aes playerprefs save unity
Last synced: about 1 month ago
JSON representation
PlayerPrefsをAES暗号を用いて保存するライブラリ
- Host: GitHub
- URL: https://github.com/mixtuti/aes_save-for-unity
- Owner: mixtuti
- License: unlicense
- Created: 2024-12-02T10:05:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-21T01:52:15.000Z (over 1 year ago)
- Last Synced: 2025-06-06T04:03:02.114Z (about 1 year ago)
- Topics: aes, playerprefs, save, unity
- Language: C#
- Homepage:
- Size: 55.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# AES_Save
 
PlayerPrefsをAES暗号を用いて保存するライブラリです。
int float string以外の型も保存可能です。
## システム要件
Unity 2022.3.28 での動作は確認済みです。
## 概要
Unity標準のPlayerPrefsの拡張機能です。
AES暗号を用いてセーブデータを暗号化します。
int型やfloat型、string型などの基本の型に加え、Bool型、List型、Vector2型、Vector3型、Dictionary型に対応しています。
int型、Float型限定で2つの値を比較する機能も付いています。
> [!IMPORTANT]
> あくまでPlayerPrefsの拡張であるため特別な理由がない限り利用は推奨しません。
## 依存関係
なし
## 導入方法
### 1. プロジェクトへの導入
導入方法は大きく分けて2つあります。お好きな方法で導入してください。
#### 1. Unity Package Managerを使う方法
「Window > Package Manager」を開き、「Add Package from git URL」を選択します。
その後、以下のURLを入力してください。
```
https://github.com/mixtuti/AES_Save-for-Unity.git?path=AESSave
```
#### 2. Import Packageを使う方法
リリースから最新のUnity Packageをダウンロードし、インポートします。
> [!TIP]
> 更新が遅くなることが多いので1の方法を使うことをお勧めします。
### 2. 利用方法
適当なゲームオブジェクトに、`AESKeyManager.cs`、`AESDataExploration.cs`をアタッチする。
> [!NOTE]
> `AESDataExploration.cs`は、必須ではなく任意でアタッチすることができます。
## スクリプトの解説
### 1. AESCore.cs
int,float,string型のデータを保存し暗号化するためのスクリプトです。
暗号化以外にも２つのデータの差を比較する比較する機能もあります。
AESKeyManagerで生成された暗号キーを用いて暗号化と復号を行います。
### 2. AESKeyManager.cs
適当なオブジェクトにアタッチして用いるスクリプト。
キーの生成には32バイトの長さが必要です。
> [!WARNING]
> 途中で暗号化キーを変更してしまうと正常に復号ができなくなります。
### 3. AESDataExploration.cs
保存された内容をtxtやjsonファイルに書き出し、閲覧するためのデバッグ用ツールです。
### 4. AESKeyManagerEditor.cs
ランダムキー生成用のボタンを追加するためのエディタ拡張機能です。
### 5. AESDataExplorationEditor.cs
保存用のボタンを追加するためのエディタ拡張機能です。
## 関数
1. SetEncryptedInt(string key, int value)
2. GetEncryptedInt(string key, int defaultValue = 0)
3. SetEncryptedFloat(string key, float value)
4. GetEncryptedFloat(string key, float defaultValue = 0.0f)
5. SetEncryptedString(string key, string value)
6. GetEncryptedString(string key, string defaultValue = "")
7. SetEncryptedBool(string key, bool value)
8. GetEncryptedBool(string key, bool defaultValue = false)
9. SetEncryptedList(string key, List list)
10. GetEncryptedList(string key)
11. SetEncryptedVector2(string key, Vector2 vector)
12. GetEncryptedVector2(string key)
13. SetEncryptedVector3(string key, Vector3 vector)
14. GetEncryptedVector3(string key)
15. DeleteEncryptedKey(string key)
16. SetEncryptedDictionary(string key, Dictionary dictionary)
17. GetEncryptedDictionary(string key)
18. DeleteAllEncryptedData
19. CompareIntDifference(string key1, string key2)
20. CompareFloatDifference(string key1, string key2)
#### 1. SetEncryptedInt(string key, int value)
int型の値を保存するための関数。
第１引数はキーの名前(string型)、第２引数は保存する値(int型)
戻り値は、なし
#### 2. GetEncryptedInt(string key, int defaultValue = 0)
保存した値をロードするための関数。
第１引数はキーの名前(string型)
第２引数はデフォルトの値(省略可能)
戻り値は、defaultValue(int型)
3~16は基本的に同じなので省略。
#### 17. DeleteEncryptedKey(string key)
指定したキーのデータを削除する関数。
第１引数はキーの名前(string型)
#### 18. DeleteAllEncryptedData
すべてのセーブデータを削除する関数。
#### 19. CompareIntDifference(string key1, string key2)
二つのセーブデータの差を比較して数値を返す関数。
引数はどちらもキーの名前(string型)
key1からkey2を引く形で差の計算をします。
20は19と基本的に同じなので省略。
## リファレンス
```cs
using UnityEngine;
using AES; // AESCoreを使用するには必須の名前空間
public class Exsample : MonoBehaviour
{
void Start()
{
// 数値を保存
AESCore.SetEncryptedInt("score1", 120); // score1 に 120 を保存
Debug.Log("スコア1に保存しました：" + AESCore.GetEncryptedInt("score1"));
AESCore.SetEncryptedInt("score2", 150); // score2 に 150 を保存
Debug.Log("スコア2に保存しました：" + AESCore.GetEncryptedInt("score2"));
// int 型の比較と差を計算
int intDifference = AESCore.CompareIntDifference("score1", "score2");
Debug.Log($"score1 と score2 の差: {intDifference}");
// データを削除
AESCore.DeleteEncryptedKey("score1");
// データをすべて削除
AESCore.DeleteAllEncryptedData();
}
}
```
```cs
using UnityEngine;
using AES; // AESCoreを使用するには必須の名前空間
public class Exsample : MonoBehaviour
{
void Start()
{
// Bool型のデータ保存と取得
AESCore.SetEncryptedBool("isGameOver", true); // GameOverフラグを保存
bool isGameOver = AESCore.GetEncryptedBool("isGameOver");
Debug.Log($"Is Game Over: {isGameOver}");
// Listの保存 int型以外でも可能
List scoreList = new List { 100, 200, 300 };
AESCore.SetEncryptedList("scoreList", scoreList);
List loadedScores = AESCore.GetEncryptedList("scoreList");
Debug.Log($"Loaded Score List: {string.Join(", ", loadedScores)}");
// Vector2の保存
Vector2 myVector2 = new Vector2(1.5f, 3.0f);
AESCore.SetEncryptedVector2("myVector2", myVector2);
Vector2 loadedVector2 = AESCore.GetEncryptedVector2("myVector2");
Debug.Log($"Loaded Vector2: {loadedVector2}");
// Vector3の保存
Vector3 myVector3 = new Vector3(1.5f, 3.0f, 5.0f);
AESCore.SetEncryptedVector3("myVector3", myVector3);
Vector3 loadedVector3 = AESCore.GetEncryptedVector3("myVector3");
Debug.Log($"Loaded Vector3: {loadedVector3}");
}
}
```
```cs
using UnityEngine;
using AES; // AESCoreを使用するには必須の名前空間
public class DictionaryExsample : MonoBehaviour
{
void Start()
{
// 辞書型データを作成
Dictionary playerData = new Dictionary()
{
{ "name", "Player1" },
{ "score", "100" },
{ "level", "5" }
};
// 辞書型データを保存（暗号化されている場合は暗号化されて保存される）
AESCore.SetEncryptedDictionary("playerData", playerData);
// 保存したデータを読み込む（暗号化されていれば復号化されて読み込まれる）
Dictionary loadedData = AESCore.GetEncryptedDictionary("playerData");
// 読み込んだデータを表示
foreach (KeyValuePair entry in loadedData)
{
Debug.Log($"{entry.Key}: {entry.Value}");
}
}
}
```