Skip to content

RELEASE.md

Latest commit

 

History

History
58 lines (53 loc) · 3.93 KB

RELEASE.md

File metadata and controls

58 lines (53 loc) · 3.93 KB

OpenCore Framework v1.0.5-beta.2

Highlights

  • Added an explicit server adapter API for platform-specific runtimes.
  • Player creation and remote hydration now support adapter-owned subclasses while preserving the public Player type.
  • Added an explicit client adapter API and removed the built-in ClientPlayer singleton.
  • Added client UI bridges for markers, blips, and notifications.
  • Added lifecycle services for NPC and Vehicle management.
  • Improved Player management with spawn, teleport, and respawn actions.

New Features

  • Server.init() now accepts adapter to install a single server adapter during bootstrap.
  • Added public server adapter helpers in @open-core/framework/server for custom adapter packages.
  • Added adapter-aware Player serialization hooks for CORE/RESOURCE flows.
  • Client.init() now accepts adapter to install a single client adapter during bootstrap.
  • Added client runtime bridge contracts so event processors, WebView callbacks, key mappings, and ticks no longer depend directly on CFX globals.
  • Added client UI bridges for markers, blips, and notifications.
  • Added lifecycle services and contracts for NPC and Vehicle management.
  • Added ISpawnActions interface and implementation for managing player spawn, teleport, and respawn actions.
  • Added ClientLoggerBridge to abstract client-side logging from direct console calls.
  • Added playerCommand runtime event.
  • Added RedM-specific ped appearance adapter and client services for RDR3 profile appearance logic.
  • Added runtime platform and game profile detection with duplicate DI registration prevention.
  • Added useAdapter() function to pre-set the client adapter before initialization.
  • Added project-level adapter injection and runtime hints for server and client adapters.
  • Added WebView abstraction for client UI interactions.
  • Renamed routing bucket methods to dimension.
  • Added dedicated client and server contract files with updated exports and package entry points.

Breaking Changes

  • Server bootstrap now defaults to the built-in Node adapter when no explicit runtime adapter is provided.
  • Platform-specific Player APIs should move into adapter packages through Player subclassing/module augmentation.
  • ClientPlayer is no longer exported from @open-core/framework/client.
  • Client bootstrap no longer uses register-client-capabilities; external adapters should be installed through Client.init({ adapter }).
  • WebViewBridge is now the preferred embedded UI abstraction; OnView now represents WebView callbacks directly, while NuiBridge and NUI remain as deprecated compatibility aliases.

Bug Fixes

  • Fixed lint issues and removed unused variables.
  • Fixed exportation issues.
  • Added tests for lint and unused variable fixes.

Notes

  • Migration path for external adapters:
    1. Create an adapter with defineServerAdapter({ name, register(ctx) { ... } }).
    2. Register platform contracts inside register(ctx) with bindSingleton, bindInstance, or bindMessagingTransport.
    3. If you extend Player, provide ctx.usePlayerAdapter({ createLocal, createRemote, serialize, hydrate }).
    4. Pass the adapter to Server.init({ mode, adapter }) in both CORE and RESOURCE resources.
  • RESOURCE hydration now validates adapter identity before rebuilding remote Player instances.
  • Client adapter migration path:
    1. Create an adapter with defineClientAdapter({ name, register(ctx) { ... } }).
    2. Register transport, appearance, hashing, and runtime bridge contracts inside register(ctx).
    3. Pass the adapter to Client.init({ mode, adapter }).
  • Client files now safe to remove from core once moved to external adapter packages:
    • src/adapters/register-client-capabilities.ts
    • src/adapters/fivem/fivem-ped-appearance-client.ts
    • src/adapters/redm/redm-ped-appearance-client.ts
    • src/adapters/node/node-ped-appearance-client.ts
    • Any remaining client-only transport/runtime bindings that your external adapter reimplements.