Types-ragemp-s - TypeScript Definitions for RAGE:MP

Types-ragemp-s is a collection of TypeScript definitions for RAGE:MP, a popular multiplayer game modification framework for Grand Theft Auto V.

The library includes definitions for the RAGE:MP Client and Server APIs, which allow developers to interact with the game world, manage player connections, and create custom game modes and features.

Installation

To use types-ragemp-s in your project, you'll need to add it as a dependency via npm:

npm install types-ragemp-s

Usage

Once installed, you can import the definitions like so:

import { Player, Vehicle } from 'types-ragemp-s';

The definitions are split into client and server namespaces, depending on whether they are intended for use on the client or server-side of the game.

Here's an example of using them to create a custom command on the server side:

import { CommandBuilder } from 'types-ragemp-s/server';

const command = new CommandBuilder('test', player =>
    player.outputChatBox('Hello, world!')
).build();

This creates a new command called 'test' which, when executed by a player, will output 'Hello, world!' to their chat box.

Contributing

Types-ragemp-s is an open source project, and contributions are welcome! If you'd like to help out, please take a look at our contributing guidelines and code of conduct.

Conclusion

Types-ragemp-s makes it easy to develop custom game modes and features for RAGE:MP using TypeScript. Whether you're a seasoned developer or new to the framework, these definitions will save you time and help you avoid errors by providing fully-typed access to the RAGE:MP APIs.