Skip to main content

Crate openstranded_plugin_api

Crate openstranded_plugin_api 

Source
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 values
  • ServiceError — typed errors for Service API calls
  • Service — cross-plugin method call interface (trait)
  • Registry — in-memory content pack data store
  • RegistryEntry — a single file from content pack (DTO)
  • GameAPI — host-side API surface provided to plugins
  • Contribution — declarative output from WASM plugin build() phase
  • ApiVersion — compile-time baked version for compatibility checks
  • LogLevel — log severity level

§Plugin-specific additions

  • MockGameAPI (behind test-utils feature): mock implementation of GameAPI for unit-testing plugins natively

§Feature flags

  • test-utils: enables MockGameAPI and test utilities

§WASM entry points (planned)

Every WASM plugin must export the following #[no_mangle] extern "C" functions:

ExportRequiredCalled during
plugin_api_version() -> ApiVersionYesLoad, before anything
plugin_build(ctx) -> Vec<Contribution>YesRegistry phase
plugin_ready(api) -> boolNoDiscovery phase
plugin_finish(api)NoIntegration phase

Modules§

test_utils

Structs§

ApiVersion
Version of openstranded-common-wasmcontract baked at compile time.
Registry
All data from a Content Pack, grouped by domain (from manifest.toml).
RegistryEntry
A single file from a Content Pack, indexed in the Registry.
ResourceDecl
Describes a resource to be registered in the Bevy World.
SystemDecl
Describes a system to be added to a Bevy schedule.

Enums§

Contribution
Declarative interface from WASM plugin to Host.
LogLevel
Log severity level.
ServiceError
Errors that occur during Service API calls or Registry access.
Value
Dynamic type for Service API arguments and return values.
VersionMismatch
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.