Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fuqunaga/prefsgui
Accessors and GUIs for persistent preference values using a JSON file
https://github.com/fuqunaga/prefsgui
editorwindow imgui prefs unity unity-playerprefs unity3d
Last synced: 5 days ago
JSON representation
Accessors and GUIs for persistent preference values using a JSON file
- Host: GitHub
- URL: https://github.com/fuqunaga/prefsgui
- Owner: fuqunaga
- License: mit
- Created: 2016-09-16T06:25:14.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-09-25T09:23:23.000Z (4 months ago)
- Last Synced: 2024-10-30T00:31:31.761Z (3 months ago)
- Topics: editorwindow, imgui, prefs, unity, unity-playerprefs, unity3d
- Language: C#
- Homepage:
- Size: 58.5 MB
- Stars: 127
- Watchers: 14
- Forks: 13
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# PrefsGUI
Accessors and GUIs for persistent preference values using a JSON file
```csharp
// define PrefsParams with key.
public PrefsBool prefsBool = new("PrefsBool");
public PrefsInt prefsInt = new("PrefsInt");
public PrefsFloat prefsFloat = new("PrefsFloat");
public PrefsString prefsString = new("PrefsString");
public PrefsParam prefsEnum = new("PrefsEnum");
public PrefsColor prefsColor = new("PrefsColor");
public PrefsVector2 prefsVector2 = new("PrefsVector2");
public PrefsVector3 prefsVector3 = new("PrefsVector3");
public PrefsVector4 prefsVector4 = new("PrefsVector4");
public PrefsAny prefsClass = new("PrefsClass");
public PrefsList prefsList = new("PrefsList");
public Element CreateElement(LabelElement label)
{
return UI.Column(
prefsBool.CreateElement(),
prefsInt.CreateElement(),
prefsFloat.CreateElement(),
prefsFloat.CreateSlider(),
prefsString.CreateElement(),
prefsEnum.CreateElement(),
prefsColor.CreateElement(),
prefsVector2.CreateElement(),
prefsVector2.CreateSlider(),
prefsVector3.CreateElement(),
prefsVector3.CreateSlider(),
prefsVector4.CreateElement(),
prefsVector4.CreateSlider(),
prefsClass.CreateElement(),
prefsList.CreateElement()
);
}
```
# Installation
This package uses the [scoped registry] feature to resolve package dependencies.
[scoped registry]: https://docs.unity3d.com/Manual/upm-scoped.html
**Edit > ProjectSettings... > Package Manager > Scoped Registries**
Enter the following and click the Save button.
```
"name": "fuqunaga",
"url": "https://registry.npmjs.com",
"scopes": [ "ga.fuquna" ]
```
**Window > Package Manager**
Select `MyRegistries` in `Packages:`
Install `PrefsGUI - RosettaUI` and `RosettaUI - UIToolkit`
If you prefer IMGUI, select the `PrefsGUI - RapidGUI` instead.
If you do not see it, make sure that your Unity version is 2021.3 or higher.
# JSON file path
```
Application.persistentDataPath + "/Prefs.json"
```
You can customize it by placing `PrefsKvsPathCustom` in the scene and setting the `Path` field.
Special folder names and environment variables are also available.
```
- %dataPath% -> Application.dataPath
- %companyName% -> Application.companyName
- %productName% -> Application.productName
- other %[word]% -> System.Environment.GetEnvironmentVariable([word])
```
# PrefsSearch
Display loaded PrefsParams with a partial key match.
# EditorWindow
**Window -> PrefsGUI**
- Display all loaded PrefsParams that can be modified.
- Feed back the current value as a default value.
- Edit the key prefix for each GameObject.
# PrefsMaterialProperty
Auto-create material menu.
# Sync PrefsParams over a network
see [PrefsGUISyncForMirror](https://github.com/fuqunaga/PrefsGUISyncForMirror)
# URP PostProcessing
see [PrefsGUI-PostProcessingURP](https://github.com/fuqunaga/PrefsGUI-PostProcessingURP)
# References
- [UV Checker Map Maker](http://uvchecker.byvalle.com/)(CustomUVChecker_byValle_1K.png)
- [RosettaUI](https://github.com/fuqunaga/RosettaUI)
- [RapidGUI](https://github.com/fuqunaga/RapidGUI)
- [PrefsGUISyncForMirror](https://github.com/fuqunaga/PrefsGUISyncForMirror)