Skip to content

F5-Studio-FiveM/f5_board_calibrate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

F5 Board Calibrate

Developer tool for F5 Board

Interactive in-game surface calibrator for board prop models. Spawn any prop, fit the writable surface plane to the model in real time, and export ready-to-paste Config.PropModels entries for f5_board.

Read the Docs   ·   F5 Board Package   ·   Join Discord


About

f5_board_calibrate is a standalone development companion for the F5 Board script. It is not meant to ship on a production server — install it on your dev environment, calibrate the props you plan to use, copy the generated surface definitions into your f5_board config, then remove this resource.

The tool solves a specific problem: every GTA V board / corkboard / whiteboard prop has its own bounding box and pivot, so the writable surface plane needs per-model offsets and dimensions. Eyeballing these values is slow and error-prone. f5_board_calibrate measures the model automatically, lets you fine-tune the plane visually with a 3D wireframe overlay, and exports the final values as a copy-pasteable Lua table.


Why use it

Auto-measure Reads the model's bounding box on selection and seeds the surface plane with sane defaults — you usually only need a few clicks to finalize.
Live 3D overlay Cyan wireframe quad outlining the writable plane, yellow diagonals, red normal vector, entity axes, and corner labels (TL / TR / BL / BR / FWD) render in-world so you can see exactly where the plane sits.
Per-axis nudging Adjust forward, up, width and height independently with configurable step sizes and hard limits.
Custom models Add your own prop hashes at runtime — validated against the game CD image, model load timeout, and prop-only check (vehicles and peds are rejected).
One-click export Export the current model as a single entry, or all calibrated models wrapped in a Config.PropModels = { ... } block, ready to paste into f5_board.
Camera mode Free-look around the prop without losing focus on the NUI panel.

Quick Start

Place f5_board_calibrate in your development server's resources folder, then add to server.cfg:

ensure f5_board_calibrate

In-game, run:

/board_calibrate

Pick a model from the list, adjust the plane, and use Export to copy the values into your f5_board config.

Reminder: this resource is a dev tool. Do not deploy it to a live/production server.


Workflow

  1. Open the panel with /board_calibrate.
  2. Select a default prop or add a custom model hash.
  3. The tool spawns the prop in front of you and auto-measures the bounding box.
  4. Toggle the wireframe / axes / bbox overlays as needed.
  5. Nudge forward, up, width, height until the cyan quad sits flush with the writable face of the prop.
  6. Save to persist the values for the current session.
  7. Export One prints a bare model_name = { ... }, entry for the current prop; Export All wraps every saved model in a Config.PropModels = { ... } block.
  8. Paste the output into your f5_board config and you're done.

Default model list

The following props are pre-loaded. You can add any other prop hash at runtime through the Add custom model input.

prop_cork_board
prop_muster_wboard_01
prop_muster_wboard_02
p_planning_board_01
p_planning_board_02
p_planning_board_03
prop_w_board_blank_2
prop_w_board_blank
prop_b_board_blank
hei_prop_dlc_heist_board

Configuration
Config = {}

Config.Command       = 'board_calibrate'   -- chat command to open / close the tool
Config.SpawnDistance = 2.5                 -- meters in front of the player to spawn the prop

Config.Steps = {                           -- per-nudge step size (meters)
    forward = 0.005,
    up      = 0.005,
    width   = 0.010,
    height  = 0.010,
}

Config.Limits = {                          -- hard clamps for each axis (meters)
    forwardMin = -1.5, forwardMax = 1.5,
    upMin      = -2.0, upMax      = 3.0,
    widthMin   =  0.05, widthMax  = 5.00,
    heightMin  =  0.05, heightMax = 5.00,
}

Config.WireColor    = { r = 0,   g = 255, b = 255, a = 255 }  -- surface quad outline (cyan)
Config.NormalColor  = { r = 255, g = 80,  b = 80,  a = 255 }  -- normal vector (red)
Config.NormalLength = 0.25
Config.AxisLength   = 0.20
Requirements
Framework None — standalone
Game GTA V / FiveM
Lua 5.4
Persistence None — calibration is in-memory; use Export to persist
Companion F5 Board (this tool produces config for it)

Documentation  ·  F5 Board  ·  Discord  ·  f5stud.io

Made by F5 Studio

About

Interactive in-game surface calibrator for board prop models. Spawn any prop, fit the writable surface plane to the model in real time, and export ready-to-paste Config.PropModels entries for f5_board.

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages