✅ Official client-side type definitions for CyberMP multiplayer.

🚀 Installation

Install the package as a development dependency:

With npm:

npm install --save-dev @cybermp/client-types

With pnpm:

pnpm add -D @cybermp/client-types

With yarn:

yarn add -D @cybermp/client-types

🛠️ Configuration & Usage

To make TypeScript aware of the global mp variable, choose one of the following two approaches:

Approach 1: Global Declaration

Create a global.d.ts file in your source root (e.g., src/global.d.ts) to make the mp namespace available globally across your entire project without explicit imports.

import { MpClient } from '@cybermp/client-types';

declare global {
  const mp: MpClient;
}

⚠️ Note: Ensure your tsconfig.json includes your global.d.ts file (either via the "include" array or the "files" array) so the compiler picks up the definitions.

Approach 2: Scoped Local Variable

If you prefer to avoid polluting the global scope, you can create a local alias module (e.g., src/mp.ts) that links directly to globalThis.

import { MpClient } from '@cybermp/client-types';

export const mp = (globalThis as any).mp as MpClient;

📜 Documentation

You can find the full documentation here.

⚖️ License

Distributed under the MIT License. See LICENSE for more information.