{"id":26411410,"url":"https://github.com/tfnrp/axonbody3","last_synced_at":"2025-03-17T20:33:38.163Z","repository":{"id":46155223,"uuid":"404734594","full_name":"TFNRP/axonbody3","owner":"TFNRP","description":"Axon Body 3 realism","archived":false,"fork":false,"pushed_at":"2023-07-19T08:11:32.000Z","size":540,"stargazers_count":5,"open_issues_count":4,"forks_count":7,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-05-01T11:24:18.100Z","etag":null,"topics":["fivem","lua"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TFNRP.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-09-09T13:33:41.000Z","updated_at":"2023-06-22T16:57:47.000Z","dependencies_parsed_at":"2022-08-27T16:52:06.681Z","dependency_job_id":null,"html_url":"https://github.com/TFNRP/axonbody3","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TFNRP%2Faxonbody3","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TFNRP%2Faxonbody3/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TFNRP%2Faxonbody3/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TFNRP%2Faxonbody3/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TFNRP","download_url":"https://codeload.github.com/TFNRP/axonbody3/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244106049,"owners_count":20398950,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fivem","lua"],"created_at":"2025-03-17T20:33:12.807Z","updated_at":"2025-03-17T20:33:38.156Z","avatar_url":"https://github.com/TFNRP.png","language":"Lua","funding_links":["https://patreon.com/yeen"],"categories":[],"sub_categories":[],"readme":"\u003ch2 align=\"center\"\u003eFiveM Axon Body 3\u003c/h2\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://patreon.com/yeen\"\u003e\u003cimg alt=\"Patreon\" src=\"https://img.shields.io/badge/patreon-donate?color=F77F6F\u0026labelColor=F96854\u0026logo=patreon\u0026logoColor=ffffff\"\u003e\u003c/a\u003e\n\u003ca href=\"https://discord.gg/xHaPKfSDtu\"\u003e\u003cimg alt=\"Discord\" src=\"https://img.shields.io/discord/463778631551025187?color=7389D8\u0026labelColor=6A7EC2\u0026logo=discord\u0026logoColor=ffffff\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Table of Contents\n\n- [About](#about)\n- [Installation](#installation)\n- [Features](#features)\n- [Configuration](#configuration)\n- [Screenshots](#screenshots)\n- [Contributing](#contributing)\n- [Credits \u0026 Copyright](#credits--copyright)\n\n## About\n\nThe most realistic Axon Body 3 script, based on [Axon Body Camera](https://forum.cfx.re/t/realistic-axon-body-camera/1155758).  \n![img](https://i.imgur.com/Kzf8WpA.png \"Real AB3 overlay\")  \n![img](https://i.imgur.com/1QQ5LmF.png \"This script\")  \n\nImage 1: a real AB3 overlay  \nImage 2: this script  \n\nTFNRP’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.  \n\n## Installation\n\nClone from Git or download manually  \n\n```sh-session\ngit clone https://github.com/TFNRP/axonbody3.git\n```\n\nTo be able to use AB3, implement the `ab3.user.toggle` ace in your server config.  \n\n\u003e **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`.\n\n## Features\n\n- Supports the [TFNRP framework](https://github.com/TFNRP/framework) to allow use for LEO.  \n- Just like the real thing. Beeps every 2 minutes whilst recording, **audible to nearby players**.  \n- Realistic overlay, with the same font used by Axon, ISO-8601 date format and transparent Axon logo.\n- Maximum server performance. Everything that can be done client-side, is.\n- Two commands included:  \n  - `/axon`, `/axonon`, `/axonoff` - Starts/stops Axon recording\n  - `/axonhide`, `/axonshow` - Hide/show the first-person overlay\n\n## Configuration\n\nThe `config.lua` is shared between the client and server.  \nConfig variables are explained in greater detail in `config.lua`, but here's an overview.\n\n\u003e **Warning**  \n\u003e Do not enter server secrets in `config.lua`.\n\nproperty | type | description\n-- | -- | --\n`CommandBinding` = `'u'` | string\\|nil | Keybind to use for on/off command. May be nil for no keybind  \n`ThirdPersonMode` = `false` | boolean | Whether the axon overlay is also visible in third person  \n||\n`CommandAccessHandling` | function | Handling used to verify if the client should be able to enable AB3  \n`CommandAccessAce` = `'ab3'` | string\\|nil | Use ACL to determine whether the client should be able to enable AB3  \n`ThrottleServerEvents` = `false` | boolean | Whether server events should be throttled server-side  \n`ThrottleDropPlayer` = `true` | boolean | Whether the player should be dropped if the throttle is violated\n\n## Screenshots\n\n![img](https://i.imgur.com/mGZXo3l.png)\n\n## Contributing\n\nPlease read [Contributing](https://github.com/TFNRP/axonbody3/blob/main/CONTRIBUTING.md) before submitting a pull request.\n\n## Credits \u0026 Copyright\n\n- [@RCPisAwesome](https://forum.cfx.re/u/RCPisAwesome) for\n  - their [Axon Body Camera](https://github.com/RCPisAwesome/FiveMRCPAxonCamera) script; and\n  - providing and giving permission of use of `static/beep.wav` file.\n\nLicensed under [MIT License](https://github.com/TFNRP/axonbody3/blob/main/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftfnrp%2Faxonbody3","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftfnrp%2Faxonbody3","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftfnrp%2Faxonbody3/lists"}