Skip to content

Latest commit

 

History

History
56 lines (33 loc) · 2.15 KB

README.md

File metadata and controls

56 lines (33 loc) · 2.15 KB
Raw

@snailycad/fivem-integrations

This repository includes several FiveM integrations for SnailyCADv4.

Please see documenation here

Installation

For regular installation please see the documentation.

Integrations

sna-alpr

This must be used together with the Wraith ARS 2X resource. When a player runs a plate, it will automatically search the plate in your SnailyCAD instance.

sna-call911

This will allow a player to contact 911 Services from the chat. /sn-call911 <message>

sna-calltow

This will allow a player to contact Tow Services from the chat. /sn-calltow <message>

sna-calltaxi

This will allow a player to contact Taxi Services from the chat. /sn-calltaxi <message>

sna-postals

When this is enabled, it will automatically send the current postal code when a player contacts 911, Tow or Taxi services. For further details see the documentation.

sna-sync

This will allow a player to interact with your SnailyCAD instance from the game. For further details see the documentation.

Developer Docs

Source code installation

Warning This is only for developers who want to contribute to the project.

  1. Clone the repository: git clone https://github.com/SnailyCAD/fivem-integrations.git.
  2. Install dependencies: pnpm install.
  3. Copy .env.example to .env and enter your FXServer path.
  4. Run the dev command pnpm run dev. This will listen for changes and automatically update the files in your FXServer.
  5. Manually run restart <resource> in your FXServer console to restart the resource.

Publishing

  1. Run the bump releases script: node scripts/bump-version.mjs <version-here>.
  2. Commit the changes: git commit -am "chore(release): <version-here>.
  3. Push the changes: git push.