@cybermp-community/server-types 1.2.2 → 1.2.3

package/README.md

@@ -1,33 +1,48 @@
 # CyberMP Server Types
 
-This repository contains the TypeScript type definitions for the **[CyberMP](https://cyber.mp) multiplayer server**, providing comprehensive type safety and IntelliSense support for server-side development.
+`@cybermp-community/server-types` types the global `mp` of the dedicated server: players, entities, vehicles, events, commands, and resource exports.
 
-These types are designed to work seamlessly with the CyberMP server environment, offering full typing for server events, player management, world state synchronization, and all server-side APIs exposed by the CyberMP multiplayer modification.
-
-## 📦 Installation
-
-Using NPM:
+## Installation
 
 ```bash
+# npm
 npm install -D @cybermp-community/server-types
+
+# pnpm
+pnpm add -D @cybermp-community/server-types
+
+# bun
+bun add -d @cybermp-community/server-types
 ```
 
-Using PNPM:
+## Usage
 
-```bash
-pnpm install -D @cybermp-community/server-types
+`server/global.d.ts`:
+
+```ts
+import type { MpServer } from "@cybermp-community/server-types";
+
+declare global {
+  const mp: MpServer;
+}
 ```
 
-Using Bun:
+`server/index.ts` runs only on the dedicated server. Keep shared player state here. The first argument of `onClient` is the player who sent the event:
 
-```bash
-bun add -d @cybermp-community/server-types
+```ts
+mp.events.onClient("requestItem", (player, itemName: string) => {
+  player.emit("giveItem", itemName);
+});
 ```
 
-## 📜 Disclaimer
+`player.emit` is delivered to that player's client as `mp.events.onServer`.
+
+Put `global.d.ts` next to the server scripts so `include` in `tsconfig.json` picks it up.
+
+## Disclaimer
 
-This repository is developed by [CyberMP Community Developers](https://gitlab.com/cybermp) and is not directly related to CyberMP (cyber.mp).
+This repository is developed by [CyberMP Community Developers](https://gitlab.com/cybermp) and is separate from CyberMP (cyber.mp).
 
-## ⚖️ License
+## License
 
-This project is licensed under the СС BY-SA 4.0 License - see the [LICENSE](LICENSE) file for details.
+CC BY-SA 4.0. See the [LICENSE](LICENSE) file for details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cybermp-community/server-types",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "TypeScript type definitions for the CyberMP server-side environment.",
   "license": "CC BY-SA 4.0",
   "author": {
@@ -48,3 +48,4 @@
     "@biomejs/biome": "^2.0.0"
   }
 }
+

package/src/commands.ts

@@ -4,9 +4,9 @@ export interface MpCommands {
   /**
    * Register a command in the server scope.
    * @param commandName Command name without "/".
-   * @param callback Callback with player and args.
+   * @param callback Callback with the player, or `null` from the server console, and args.
    */
-  add(commandName: string, callback: (player: MpPlayer, args: string[]) => void): void;
+  add(commandName: string, callback: (player: MpPlayer | null, args: string[]) => void): void;
 
   /**
    * Unregister a command.