@nativewrappers/fivem
Version:
Native wrappers and utilities for use with FiveM.
46 lines (38 loc) • 2.04 kB
Markdown
<h1 align="center">Monorepo for a FiveM server/client wrapper</h1>
<p align="center">
<i>🔥 A Javascript/Typescript package for FiveM resource development 🎮</i>
<br>
<small>This project is in no way affiliated with FiveM or the Cfx.re Collective.</small>
</br></br>
<a href="https://github.com/nativewrappers/nativewrappers/blob/master/LICENSE">
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat" alt="License: MIT">
</a>
<a href="https://www.npmjs.com/package/@nativewrappers/fivem">
<img src="https://img.shields.io/npm/v/@nativewrappers/fivem?style=flat" alt="npm version">
</a>
<a href="https://www.npmjs.com/package/@nativewrappers/fivem">
<img src="https://img.shields.io/npm/dm/@nativewrappers/fivem?style=flat">
</a>
<a href="https://github.com/nativewrappers/nativewrappers/actions/workflows/config.yml">
<img src="https://github.com/nativewrappers/nativewrappers/actions/workflows/config.yml/badge.svg" alt="Workflow Status">
</a>
<a href="https://github.com/nativewrappers/nativewrappers/commits/master">
<img src="https://img.shields.io/github/last-commit/nativewrappers/fivem.svg?style=flat" alt="Last commit">
</a>
</p>
<h3 align="center">This project is currently iterating rapidly, there will be breaking changes.</h3>
<p align="center">
<h2 align="center"><a href="https://github.com/nativewrappers/nativewrappers/tree/main/docs">Documentation</a></h2>
<!-- <a href="https://forum.fivem.net/t/fivem-js-v1-3-2-javascript-typescript-wrapper-now-with-menu-class-nativeui/268640">Forum</a> -->
</p>
## Features
- No runtime dependencies
- Entity management through class objects (i.e. `Vehicle` and `Ped` entities)
- Server and Client side variants on wrapper
## Download & Install
```
pnpm add @nativewrappers/redm # for redm,
pnpm add @nativewrappers/fivem # for fivem
pnpm add @nativewrappers/common # for any, should be game agnostic, provides Vector3, decors, kvps, helper functions, etc
pnpm add @nativewrappers/server # for server
```