Skip to main content
Branch: Release Candidate

Shared module (alt-shared)

Introduction

Welcome to the alt:V Multiplayer documentation!​

Here you will find a comprehensive resource to help you navigate through various aspects of alt:V Multiplayer. Whether you're looking for troubleshooting assistance, have generic questions about alt:V, or need specific guidance on JavaScript or C# modules, this documentation has got you covered.

The troubleshooting section provides solutions to common issues that you may encounter during your alt:V journey, helping you overcome any hurdles you may face along the way. Additionally, the documentation includes a wide range of topics, from general alt:V inquiries to more specialized discussions about JavaScript and C# modules.

To further enhance your experience, we have included a handy FAQ section that addresses frequently asked questions, providing quick answers to common queries. This resource is designed to ensure that you have the necessary information at your fingertips, empowering you to make the most of your alt:V Multiplayer experience.

Let's dive into the documentation and discover all that alt:V has to offer!

FAQ​

Will the limits of GTA:V be increased?​

Yes, alt:V has already increased certain limits compared to the original GTA V. If you find the need to further increase a specific limit, it can be achieved using a resource packed in the RPF format. For detailed instructions on how to increase limits using an RPF resource, please refer to the tutorial available [here](PLACEHOLDER LINK).

Does alt:V work on Linux?​

While there are native builds of the alt:V server available for Linux, it's important to note that the alt:V client does not have official support for Linux. However, some users have reported success running alt:V with compatibility layers such as Wine or Proton. If you decide to give it a try, you can attempt to run alt:V by installing both GTA V and alt:V within the same Wine prefix. For further questions, join our Discord and ask in the altV on Linux thread.

Is or will alt:V be open-source?​

alt:V consists of a combination of open-source and closed-source components. While the core parts of alt:V are not open-source, certain components are available as open-source and can be found in the official alt:V GitHub repositories. It's important to note that there are ongoing plans to release additional components of alt:V as open-source in the future.

Are there any charges for additional server slots?​

No, you do not have to pay for additional server slots. They are completely free of charge. The number of server slots you can have is not restricted, except by the limitations of the hardware on which your server is hosted.

How can I contribute to alt:V?​

We greatly appreciate contributions to the alt:V project, and there are multiple ways you can get involved. Here are some options:

  • Open-source Projects: You can directly contribute to the open-source projects hosted on GitHub.
  • Community Engagement: Join our Discord server to engage with the alt:V community and explore opportunities for contributing.
  • Financial Support: Consider supporting us financially on Patreon, where you can become a patron and contribute to the ongoing development and maintenance of alt:V. We value and appreciate contributions in any form, be it code contributions, community involvement, or financial support. Thank you for your interest in contributing to alt:V!

How can I get a token for the masterlist?​

info

During the development stage of your server, you don't need a token. Tokens are only required if your server is in the release branch and you want it to be listed on the masterlist.

To obtain a token, you can send a message with the word "token" to the alt:V Master-Bot on Discord (username: Master-Bot#3667). There are two requirements to obtain a token:

  • Wait for a minimum of 30 days, and a token will be automatically generated for you.
  • Alternatively, you can subscribe as a Bronze Patreon to generate a token immediately.

Either fulfilling the 30-day waiting period or becoming a Bronze Patreon subscriber will allow you to obtain a token for the masterlist.

Index

Classes

Enumerations

Functions

Interfaces

Namespaces

Variables

Variables

constbranch

branch: string

Represents the current branch.

constdebug

debug: boolean

Returns if the resource is in debug mode.

Returns

True when the resource is launched with debug mode enabled.

constdefaultDimension

defaultDimension: number

Default dimension (0). Read more: https://docs.altv.mp/articles/dimensions.html

constglobalDimension

globalDimension: number

Global dimension (-2147483648). Read more: https://docs.altv.mp/articles/dimensions.html

constisClient

isClient: boolean

A boolean indicating whether the current script is executed on the clientside.

constisServer

isServer: boolean

A boolean indicating whether the current script is executed on the serverside.

constresourceName

resourceName: string

Resource name of the executing resource.

constsdkVersion

sdkVersion: string

Represents the current SDK version.

Remarks

It’s the version of the SDK the current runtime was compiled with.

constversion

version: string

Represents the current version.

Remarks

It’s a slighty modified semantic versioning specification, which can be matched using this regular expression pattern ^(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))$.