fivem-ts

🔥 A JavaScript/TypeScript wrapper for the FiveM natives 🎮

---

---

Table of Contents

• Overview
• Features
• Download and Install
  • Client Package
  • Server Package
  • Shared Package
• Usage
• Community
• Contributing
• License

---

Overview

Documentation - Join our Discord

This wrapper is based on the FiveM C# wrapper - link.

It offers a comprehensive set of helper classes, objects, and functions designed to accelerate your project development.

Originally forked from Fivem-js by d0p3t (link), this project has since evolved. A big thank you to d0p3t for the initial inspiration and contributions! ❤️

---

Features

• Dependencies:

  • @citizenfx/client
  • @citizenfx/server
  • cross-fetch
  • reflect-metadata

• Abstraction of common FiveM practices: Simplifies development tasks.

• Entity management: Includes class objects for Vehicle, Ped, and more.

• UI Elements: Supports scaleforms, loading prompts, and other UI components.

• Additional Functionality: Handles Audio, Blips, Cameras, and more.

• Web Wrapper: Support for making requests and using HttpHandlers in resources.

• Upcoming Features:

  • Groups Management
  • Buckets Management
  • IoC (Inversion of Control): Full support with TypeScript Decorators.

In essence, this package encompasses all the capabilities of the FiveM C# wrapper and offers even more!

---

Download and Install

Client Package

Easily integrate the client package into your project.

• View on npm: @fivem-ts/client

• Install:

  # Using npm
  npm install @fivem-ts/client
  
  # Using pnpm
  pnpm add @fivem-ts/client
  
  # Using yarn
  yarn add @fivem-ts/client

Server Package

Easily integrate the server package into your project.

• View on npm: @fivem-ts/server

• Install:

  # Using npm
  npm install @fivem-ts/server
  
  # Using pnpm
  pnpm add @fivem-ts/server
  
  # Using yarn
  yarn add @fivem-ts/server

Shared Package

Easily integrate the shared package into your project.

• View on npm: @fivem-ts/shared

• Install:

  # Using npm
  npm install @fivem-ts/shared
  
  # Using pnpm
  pnpm add @fivem-ts/shared
  
  # Using yarn
  yarn add @fivem-ts/shared

---

Usage

Explore example projects to get started.

---

Community

Connect with us on our public discord server for help and discussions.

---

Contributing

We welcome contributions! You can assist by submitting pull requests or reporting issues.

For contribution guidelines, please refer to CONTRIBUTING.md.

---

License

MIT (Custom license details coming soon). See the LICENSE file for more information's.

---