fivem-rpc/readme.md
2025-07-16 20:41:35 +01:00

1.2 KiB

FiveM RPC

is an all-in-one package with asynchronous RPC implementation for FiveM servers in JS/TS

Installation

  pnpm i @entityseven/fivem-rpc
  yarn add @entityseven/fivem-rpc
  bun add @entityseven/fivem-rpc

It is highly recommended to also install additional package for enhanced typing

  pnpm i @entityseven/fivem-rpc-shared-types -D
  yarn add @entityseven/fivem-rpc-shared-types --dev
  bun add @entityseven/fivem-rpc-shared-types -d

Docs

Can be found in /rpc/readme.md

Features

  • Type-Safe Development: Eliminate runtime errors and enhance code reliability with comprehensive type safety
  • All-in-one package: Communicate effortlessly between server, client and webview

Contributing

Issues and pull requests are very welcome

License

Licensed under Custom Attribution-NoDerivs Software License

WIP

  • client observers to catch events between server and webview (subscribe-like behaviour)
  • client observers to prevent events (middleware-like behaviour)
  • player manager (transform player id to desired data straight from a listener)