https://github.com/tfnrp/axonbody3
Axon Body 3 realism
https://github.com/tfnrp/axonbody3
fivem lua
Last synced: over 1 year ago
JSON representation
Axon Body 3 realism
- Host: GitHub
- URL: https://github.com/tfnrp/axonbody3
- Owner: TFNRP
- License: mit
- Created: 2021-09-09T13:33:41.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-07-19T08:11:32.000Z (almost 3 years ago)
- Last Synced: 2024-05-01T11:24:18.100Z (about 2 years ago)
- Topics: fivem, lua
- Language: Lua
- Homepage:
- Size: 527 KB
- Stars: 5
- Watchers: 1
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
FiveM Axon Body 3
## Table of Contents
- [About](#about)
- [Installation](#installation)
- [Features](#features)
- [Configuration](#configuration)
- [Screenshots](#screenshots)
- [Contributing](#contributing)
- [Credits & Copyright](#credits--copyright)
## About
The most realistic Axon Body 3 script, based on [Axon Body Camera](https://forum.cfx.re/t/realistic-axon-body-camera/1155758).
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
```sh-session
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](https://github.com/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
## Contributing
Please read [Contributing](https://github.com/TFNRP/axonbody3/blob/main/CONTRIBUTING.md) before submitting a pull request.
## Credits & Copyright
- [@RCPisAwesome](https://forum.cfx.re/u/RCPisAwesome) for
- their [Axon Body Camera](https://github.com/RCPisAwesome/FiveMRCPAxonCamera) script; and
- providing and giving permission of use of `static/beep.wav` file.
Licensed under [MIT License](https://github.com/TFNRP/axonbody3/blob/main/LICENSE).