[WIP] TypeScript wrapper

FiveM Releases
,
1

Subject: :rocket: Introducing fivem-ts: The Next-Gen JavaScript/TypeScript Wrapper for FiveM Natives :video_game:

Links :

Github Repo: Link
npm registry package: Link

–

Hello FiveM Community!

I’m thrilled to unveil my latest project: fivem-ts – a modern and robust JavaScript/TypeScript wrapper for FiveM natives. This library is crafted to enhance your development experience, offering a clean, powerful, and efficient way to interact with FiveM’s API.

What is fivem-ts?

fivem-ts is a versatile library that provides a seamless bridge between FiveM natives and modern JavaScript/TypeScript. It builds upon the FiveM C# wrapper and extends the original Fivem-js project by d0p3t. This tool is designed to simplify your scripting tasks and accelerate your project development, offering both familiar and new functionalities.

Key Features:

  • Dependency Integration:

  • Abstraction of Common Practices: Streamlines routine development tasks and simplifies the interaction with FiveM’s complex API.

  • Entity Management: Manage game entities such as Vehicle, Ped, and more through well-structured class objects.

  • UI Elements: Effortlessly handle UI components including scaleforms, prompts, and other interactive elements.

  • Additional Functionality: Enhanced support for managing Audio, Blips, Cameras, and other game features.

  • Upcoming Features:

    • Groups Management: Control and manage player groups with ease.
    • Buckets Management: Handle data buckets effectively for various use cases.

  • Work in Progress:

    • IoC (Inversion of Control): Full support for IoC with TypeScript Decorators, bringing more flexibility and modularity to your code.

Getting Started

Installation

Adding fivem-ts to your project is straightforward. Choose your preferred package manager:

  • npm: npm install fivem-ts
  • pnpm: pnpm add fivem-ts
  • yarn: yarn add fivem-ts

For additional details, visit the npm registry page.

Usage

Explore our example projects to see fivem-ts in action. Full documentation is on the way, but you can get a head start with these examples!

Contributing

We’re excited to have you contribute to fivem-ts! Whether you want to submit improvements, report issues, or suggest new features, your input is valuable. For contribution guidelines, please refer to our CONTRIBUTING.md.

License

fivem-ts is licensed under the MIT License. You can find more details in the LICENSE file.

Thank you for checking out fivem-ts. I’m eager to hear your feedback and see how this tool enhances your FiveM projects. If you have any questions or need assistance, don’t hesitate to reach out!

Happy coding, and I look forward to seeing your creations with fivem-ts! :rocket:

5 Likes