Installation

2 min readUpdated 2 weeks ago

Overview

ML Board is an interactive whiteboard and corkboard system. Players can view, post notes, and pin photos on boards placed around the map or crafted from inventory items.

Quick Start

  1. Download from CFX Portal
  2. Extract to your resources folder as ml_board
  3. Add to server.cfg:
server.cfg
1ensure oxmysql
2ensure ox_lib
3ensure ml_bridge
4ensure ml_board
Load Order

ml_board must start AFTER ml_bridge. Incorrect order causes startup errors.

Items Setup

Copy the contents of _INSTALL/ox_items.lua into your ox_inventory/data/items.lua.

Items included:

  • Notes: sticky_note, sticky_note_yellow, photo
  • Boards: whiteboard_large, corkboard, board_wood (the wooden board ships with the resource, no extra prop pack needed)

Copy the .png images from _INSTALL/ into your ox_inventory/web/images/ folder.

The folder also carries spare images for notes and boards added later. A note item belongs to a variant in shared/config_notes.lua, a board item to an entry in Config.BoardTypes.

Item Requirement

If Config.UseItems = false, notes can be placed without consuming items.

Database

Tables are created automatically on first start:

  • ml_boards: every board, player-placed boards and the notes of static boards (keyed by static_id)

A whiteboards table from an older board resource is imported on first start, then dropped. To move older notes to the current surface layout, run /mlboard_migrate once.

Verify

Start the server and check for:

lua
1[ml_board] Resource started
2[ml_board] Ensuring ml_boards schema...
3[ml_board] Schema ready.
4[ml_board] Loaded 0 dynamic boards.

Place a board item to test. The /postit command is off by default, turn it on in Config.Command.

  • Script not starting. Verify all dependencies are running. Check ensure order in server.cfg.
  • Notes not appearing: check the F8 console for interface errors, and that you stand within RenderDistance.
  • Board prop not spawning. Verify the player is within RenderDistance (default 30m).