/axonbody3

Axon Body 3 realism

Primary LanguageLuaMIT LicenseMIT

FiveM Axon Body 3

Patreon Discord

Table of Contents

About

The most realistic Axon Body 3 script, based on Axon Body Camera.
img
img

Image 1: a real AB3 overlay
Image 2: this script

TFNRP’s Axon Body 3 script’s goal is to be as realistic as possible, with future plans for more audio files the real Axon Body 3 uses.

Installation

Clone from Git or download manually

git clone https://github.com/TFNRP/axonbody3.git

To be able to use AB3, implement the ab3.user.toggle ace in your server config.

Note: If you don't need ACL checks, you may disable this ace by setting CommandAccessAce to nil, and implement the client-side logic in CommandAccessHandling.

Features

  • Supports the TFNRP framework to allow use for LEO.
  • Just like the real thing. Beeps every 2 minutes whilst recording, audible to nearby players.
  • Realistic overlay, with the same font used by Axon, ISO-8601 date format and transparent Axon logo.
  • Maximum server performance. Everything that can be done client-side, is.
  • Two commands included:
    • /axon, /axonon, /axonoff - Starts/stops Axon recording
    • /axonhide, /axonshow - Hide/show the first-person overlay

Configuration

The config.lua is shared between the client and server.
Config variables are explained in greater detail in config.lua, but here's an overview.

Warning
Do not enter server secrets in config.lua.

property type description
CommandBinding = 'u' string|nil Keybind to use for on/off command. May be nil for no keybind
ThirdPersonMode = false boolean Whether the axon overlay is also visible in third person
CommandAccessHandling function Handling used to verify if the client should be able to enable AB3
CommandAccessAce = 'ab3' string|nil Use ACL to determine whether the client should be able to enable AB3
ThrottleServerEvents = false boolean Whether server events should be throttled server-side
ThrottleDropPlayer = true boolean Whether the player should be dropped if the throttle is violated

Screenshots

img

Contributing

Please read Contributing before submitting a pull request.

Credits & Copyright

Licensed under MIT License.