Expand description
§openstranded-plugin-api
Plugin SDK for OpenStranded — re-exports all contract types from
[openstranded-common-wasmcontract] and adds plugin-specific utilities.
§Re-exports
All core types come from [openstranded-common-wasmcontract]:
Value— dynamic type for cross-plugin arguments and return valuesServiceError— typed errors for Service API callsService— cross-plugin method call interface (trait)Registry— in-memory content pack data storeRegistryEntry— a single file from content pack (DTO)GameAPI— host-side API surface provided to pluginsContribution— declarative output from WASM pluginbuild()phaseApiVersion— compile-time baked version for compatibility checksLogLevel— log severity level
§Plugin-specific additions
MockGameAPI(behindtest-utilsfeature): mock implementation ofGameAPIfor unit-testing plugins natively
§Feature flags
test-utils: enablesMockGameAPIand test utilities
§WASM entry points (planned)
Every WASM plugin must export the following #[no_mangle] extern "C" functions:
| Export | Required | Called during |
|---|---|---|
plugin_api_version() -> ApiVersion | Yes | Load, before anything |
plugin_build(ctx) -> Vec<Contribution> | Yes | Registry phase |
plugin_ready(api) -> bool | No | Discovery phase |
plugin_finish(api) | No | Integration phase |
Modules§
Structs§
- ApiVersion
- Version of
openstranded-common-wasmcontractbaked at compile time. - Registry
- All data from a Content Pack, grouped by domain (from manifest.toml).
- Registry
Entry - A single file from a Content Pack, indexed in the Registry.
- Resource
Decl - Describes a resource to be registered in the Bevy World.
- System
Decl - Describes a system to be added to a Bevy schedule.
Enums§
- Contribution
- Declarative interface from WASM plugin to Host.
- LogLevel
- Log severity level.
- Service
Error - Errors that occur during Service API calls or Registry access.
- Value
- Dynamic type for Service API arguments and return values.
- Version
Mismatch - Version mismatch between a plugin and the engine.
Traits§
- GameAPI
- Host-side API surface provided to WASM plugins.
- Service
- Unified interface for cross-plugin calls.
Functions§
- parse_
registry_ data - Parse registry data bytes into a Value tree.
- parse_
registry_ list - Convenience wrapper: parse bytes as an array and return elements.