Skip to content

Refactor Toolkit, Workspace and Resource provider API#15

Merged
iMrShadow merged 4 commits into
mainfrom
refactor/api-improvements-and-simplification
May 16, 2026
Merged

Refactor Toolkit, Workspace and Resource provider API#15
iMrShadow merged 4 commits into
mainfrom
refactor/api-improvements-and-simplification

Conversation

@iMrShadow

@iMrShadow iMrShadow commented May 16, 2026

Copy link
Copy Markdown
Owner

This PR improves the public API surface, internal structure and documentation.

Toolkit

  • Renamed methods for clarity:
    • OpenObject/SaveObject -> Serialize/Deserialize
    • Added SerializeWithConfig/DeserializeWithConfig for metadata access
  • Simplified parameters: Removed MetaStreamConfiguration parameter from main methods, which is now returned via tuple when needed
  • Removed redundant overloads:
    • Non-generic object-based methods
    • Try variants (use nullable returns instead)
  • Added AutoResolveSymbols to Configuration for automatic symbol resolution
  • Added missing documentation

Resource Providers

  • Fixed IsEnabled behavior across all providers
  • Added missing documentation

Workspace

  • Cleaner asset API:
    • LoadAsset returns nullable T
    • LoadAssetWithConfig returns tuple with metadata
  • Added ExportAsset as counterpart to LoadAsset (supports file path, stream, custom config)
  • Removed redundant methods:
    • All SaveObject/LoadObject variants
    • Non-generic object-based methods
    • Try variants
  • Added AutoResolveSymbols for automatic symbol resolution
  • Added Workspaces property (mirrors GameProfiles)
  • Added missing documentation

Samples

  • Updated example projects to demonstrate new API workflow

iMrShadow added 4 commits May 15, 2026 13:48
Large refactor of Toolkit and Workspace:
- introduce a safer singleton (s_instance) with Initialize/IsInitialized
- add workspace registry
- rework serialization API with internal helpers
- remove obsolete serialization functions
- rename some functions related to archives and metaclass exportation
- enhance Configuration with AutoResolveSymbols
- remove obsolete/duplicated helpers
@iMrShadow iMrShadow added documentation Improvements or additions to documentation enhancement New feature or request labels May 16, 2026
@iMrShadow iMrShadow merged commit 38c38df into main May 16, 2026
1 check passed
@iMrShadow iMrShadow deleted the refactor/api-improvements-and-simplification branch May 16, 2026 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant