[WIP] Add Game Settings API contracts to Plugin Exports - #7
Open
Cryotechnic wants to merge 4 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces a new declarative game settings contract to the plugin core library (v0.1.6.0), enabling plugins to describe, serialize, and manage game settings pages in a standardized way. The main features include new data structures for settings pages, launcher and plugin-side APIs for settings access and mutation, and related test coverage. The library version is incremented to reflect these additions.
Game Settings Contract Implementation
GameSettingsPage,GameSettingsSection,GameSettingEntry,GameSettingChoice, andGameSettingKind, enabling plugins to define settings pages with various entry types (toggle, text, number, slider, choice). (UI/Settings/GameSettingsPage.cs[1]UI/Settings/GameSettingsSection.cs[2]UI/Settings/GameSettingEntry.cs[3]UI/Settings/GameSettingChoice.cs[4]UI/Settings/GameSettingKind.cs[5]UI/Settings/GameSettingsPageSerializer.csUI/Settings/GameSettingsPageSerializer.csR1-R20)Plugin Core and Launcher Integration
SharedStatic.V1Ext_Update6.cs[1]SharedStatic.V1Ext.cs[2]GameSettingsExtension.GameSettingsContextto access these APIs, check feature availability, and manipulate settings from the launcher. (Utility/GameSettingsExtension.csUtility/GameSettingsExtension.csR1-R115)Versioning and Documentation
v0.1.6.0and updated the implementation standard in the documentation to reflect the new version and features. (SharedStatic.cs[1]README.md[2]Testing and CLI Enhancements
PluginTest/Test.GameSettings.cs[1]PluginTest/Program.cs[2] [3]These changes establish a robust, extensible foundation for plugin-defined settings pages, facilitating future UI and integration work.