Bodyboard Activity Documentation
You’re right, my bad. Here is the complete version: ```html
This guide explains how to install and configure Tdev Bodyboard for your FiveM server.
Compatibility
- ESX Legacy
- QBCore
- Qbox
- ox_inventory
Requirements
- ESX Legacy, QBCore, Qbox, or ox_inventory
- Framework resource if you use a framework mode
- OneSync required for stable networked bodyboard entities
- ox_lib optional for modern notifications
- ox_inventory optional for item-based usage
- GTA bodyboard prop: prop_boogieboard_03
Installation
- Download the resource from your Tebex purchases.
- Extract the folder.
- Place the tdev_bodyboard folder inside your server resources folder.
- Start your framework before the resource.
- Start ox_inventory before the resource if you use ox_inventory.
- Start ox_lib before the resource if you want ox_lib notifications.
- Open the config.lua file.
- Select your framework or leave it on auto detection.
- Select your inventory mode or leave it on auto detection.
- Add the body_board item to your inventory system.
- Configure the bodyboard model, carry position, water placement, controls, animations, movement, and safety settings.
- Add the resource to your server.cfg.
- Restart your server or run refresh followed by ensure tdev_bodyboard.
- Give yourself the body_board item and test carrying, dropping, mounting, crawling movement, exiting, cleanup, and item return.
Server CFG Example
ESX Example:
ensure es_extended
ensure ox_lib
ensure ox_inventory
ensure tdev_bodyboard
QBCore Example:
ensure qb-core
ensure ox_lib
ensure ox_inventory
ensure tdev_bodyboard
Qbox Example:
ensure qbx_core
ensure ox_lib
ensure ox_inventory
ensure tdev_bodyboard
Configuration
- Set Config.Framework to auto, esx, qb, qbox, or standalone.
- Set Config.Inventory to auto, framework, or ox_inventory.
- Configure Config.Items.board if you want to rename the body_board item.
- Configure Config.Commands for recovery, reset, and optional testing command names.
- Configure Config.Controls for drop, mount, exit, pickup, movement, and steering keys.
- Configure Config.Carry for the bodyboard model, back bone, carry offset, and carry rotation.
- Keep Config.Carry.anim.enabled disabled if you want the player to walk normally with the bodyboard on their back.
- Configure Config.Drop for water placement distance, water height offset, and water detection behavior.
- Configure Config.Board for bodyboard model, hidden movement vehicle, enter distance, pickup distance, speed, and steering.
- Configure Config.Board.attach.pedToBoard.crawling to adjust the player position on the bodyboard.
- Configure Config.Animation for crawling/prone idle animation and paddle animation.
- Configure Config.Safety for cooldowns, maximum board distance, death cleanup, board missing cleanup, and production anti-abuse settings.
Item Setup
- ox_inventory users should copy install/ox_inventory_items.lua into ox_inventory/data/items.lua.
- QBCore users should copy install/qb-core_items.lua into qb-core/shared/items.lua.
- Qbox users should use the ox_inventory item snippet or install/qbox_items.lua.
- ESX users should run install/esx_items.sql.
- The default item name is body_board.
- The item is removed server-side only when the bodyboard is dropped over water.
- The item is returned server-side when the player exits, picks up, resets, disconnects, dies, or cleanup is triggered.
Bodyboard System
- Players use the body_board item from their inventory.
- The player carries the bodyboard on their back and can walk normally.
- Players press Y to drop the bodyboard over water.
- Players press F near the bodyboard to get on it.
- The bodyboard supports one riding position only: crawling/prone.
- Players use W/S for forward and reverse movement.
- Players use A/D to steer the bodyboard.
- Players press X while mounted to exit the bodyboard.
- Players press E near an unmounted bodyboard to pick it up.
- The body_board item automatically returns to the player inventory after exiting or picking it up.
- Players can use /bodyboardrecover if the item could not be returned because their inventory was full.
- Players can use /bodyboardreset to force clean their active bodyboard session.
Custom Props and Animations
- The resource uses the GTA bodyboard prop prop_boogieboard_03 by default.
- The resource uses GTA crawling/prone animations for the mounted bodyboard position.
- No custom streamed animation file is required for the default setup.
- Do not rename the bodyboard model unless you also update Config.Carry.model and Config.Board.model.
- Use Config.Board.attach.pedToBoard.crawling.offset to adjust the player higher, lower, forward, or backward on the bodyboard.
- Fully restart the resource after changing model, animation, or attach configuration.
Security
- Do not move item remove or item return logic client-side.
- Do not trust client-side inventory state.
- Keep item usage, item removal, item return, recovery, and cleanup server-side.
- Keep Config.Safety.actionCooldownMs enabled on production servers.
- Keep Config.Safety.serverMaxDropDistance enabled on production servers.
- Keep Config.Safety.forceReturnOnDeath enabled on production servers.
- Keep Config.Safety.forceReturnWhenBoardMissing enabled on production servers.
- Keep Config.Safety.cleanupPendingItemsOnResourceStop enabled on production servers.
- Back up config.lua before updating the resource.
Anticheat Whitelist
If your anticheat blocks custom resource events, whitelist the Tdev Bodyboard events from the README.
Important server events include tdev_bodyboard:server:tryUseBoard, tdev_bodyboard:server:cancelCarry, tdev_bodyboard:server:tryDropBoard, tdev_bodyboard:server:returnBoard, and tdev_bodyboard:server:forceCleanup.
Important client events include tdev_bodyboard:client:notify, tdev_bodyboard:client:useBoard, tdev_bodyboard:client:carryApproved, tdev_bodyboard:client:boardApproved, and tdev_bodyboard:client:forceCleanup.
Common Issues
Item does nothing: Check that the body_board item exists, is marked usable, and that tdev_bodyboard starts after your framework or inventory.
ox_inventory item does nothing: Check that the item has client export tdev_bodyboard.useBodyBoard and restart ox_inventory after editing items.lua.
Bodyboard does not drop: Make sure the player is standing over valid water and press Y while carrying the bodyboard.
Bodyboard does not appear: Check that prop_boogieboard_03 exists, OneSync is enabled, and there are no F8 errors.
Player cannot get on the bodyboard: Stand closer to the bodyboard and press F. You can increase Config.Board.enterDistance if needed.
Player position is too low, too high, too forward, or too far back: Adjust Config.Board.attach.pedToBoard.crawling.offset in config.lua.
Player does not walk normally while carrying: Make sure Config.Carry.anim.enabled is false and Config.Carry.disableControls is false.
Bodyboard item does not return: Check inventory weight/slots. Free space and use /bodyboardrecover.
Framework detection is wrong: Set Config.Framework manually to esx, qb, or qbox.
Inventory detection is wrong: Set Config.Inventory manually to framework or ox_inventory.
Support
If you need help, open a support ticket in the Tdev Scripts Discord.
Provide your order ID, script name, framework, inventory, full F8 error, server console error, and a screenshot or video.
Support is only available for verified customers.
Support is not provided for leaked, resold, or heavily modified versions.
Discord: https://discord.gg/5MYzXemM4q
```