Adapters

What are Adapters?

Adapters are packages that connect OpenCore with specific multiplayer platforms. Each adapter implements the framework's contracts for platform-specific APIs like player info, vehicle management, events UI bridges and extra APIs.

Architecture

┌─────────────────────────────────────────────────────────┐
│                    Your Game Code                       │
│         (Controllers, Services, Decorators)             │
└─────────────────────────┬───────────────────────────────┘
                          │
┌─────────────────────────▼───────────────────────────────┐
│                   OpenCore Framework                    │
│              (Runtime, DI, Processors)                  │
└─────────────────────────┬───────────────────────────────┘
                          │
┌─────────────────────────▼───────────────────────────────┐
│                    Contracts (Interfaces)               │
│     IPlayerServer, IVehicleServer, IWebViewBridge...    │
└─────────────────────────┬───────────────────────────────┘
                          │
┌─────────────────────────▼───────────────────────────────┐
│                      Adapters                           │
│     FiveM Adapter  │  RageMP Adapter  │  RedM Adapter   │
└─────────────────────────────────────────────────────────┘

Available Adapters

Adapter	Package	Status	Game
FiveM	@open-core/fivem-adapter	Stable	GTA V
RageMP	@open-core/ragemp-adapter	Stable	GTA V
RedM	Built-in	Coming Soon	RDR3

Common Contracts

All adapters implement these core contracts:

Server Contracts

• IPlayerServer — Player operations (drop, getPed, getName, getPing)
• IVehicleServer — Vehicle operations (create, delete, getAll)
• IPedServer — Ped operations (spawn, delete)
• IPlayerLifecycleServer — Spawn, teleport, respawn actions
• IPlayerStateSyncServer — Health, armor, state sync
• IPlatformContext — Platform info and capabilities
• MessagingTransport — RPC and events between server/client

Client Contracts

• IClientRuntimeBridge — Tick, commands, NUI callbacks
• IClientSpawnBridge — Player spawn management
• IClientWebViewBridge — WebView/NUI communication
• IClientBlipBridge — Map blip management
• IClientMarkerBridge — 3D marker rendering
• IClientNotificationBridge — Notifications and help text

Installation

Each adapter has its own package. Install the ones you need:

# FiveM
pnpm add @open-core/fivem-adapter

# RageMP
pnpm add @open-core/ragemp-adapter

Validating Adapter Coverage

If you maintain an adapter package, use the CLI helper command to verify that your adapter still covers the framework contracts expected by OpenCore:

# run inside the adapter repository
opencore adapter check

# fail on optional parity gaps too
opencore adapter check --strict

The command compares your adapter's server and client bindings against the framework's default adapter baseline.

It is useful when:

• new contracts are added to the framework
• you are upgrading @open-core/framework
• you want a fast verification step in CI for adapter packages

By default the report separates:

• required contracts that must exist for the adapter to pass
• optional parity gaps that are reported as warnings unless --strict is used

Reference:

• CLI Commands
• Contracts Introduction

Usage

Import and pass the adapter during initialization:

import { Server } from '@open-core/framework/server'
import { Client } from '@open-core/framework/client'

// FiveM
import { FiveMServerAdapter } from '@open-core/fivem-adapter/server'
import { FiveMClientAdapter } from '@open-core/fivem-adapter/client'

await Server.init({ mode: 'CORE', adapter: FiveMServerAdapter() })
await Client.init({ mode: 'CORE', adapter: FiveMClientAdapter() })

Or use the CLI wizard which handles installation and configuration automatically:

opencore init my-server --adapter=fivem
opencore init my-server --adapter=ragemp

Platform Detection

OpenCore uses the adapter you provide at runtime to determine:

• Which native APIs are available
• How player identifiers are handled
• Transport protocol for server/client communication
• Maximum player counts and game-specific defaults

Next Steps

• FiveM — FiveM specifics
• RageMP — Rage Multiplayer specifics
• RedM — Red Dead Redemption specifics