MetaBuild

MetaBuild - The Ultimate Building & Construction Tool for FiveM

A guide to install MetaBuild for FiveM

📋 Table of Contents

🎯 Overview
🎥 Video Showcase
🛒 Purchase Information
⚠️ Important Pre-Installation Notes
🔧 System Requirements & Compatibility
📦 Installation Process
🗄️ Database Setup (Required)
🔌 oxmysql Installation (Required)
⚙️ Configuration Setup
🎮 How It Works
🔗 Integration & Compatibility
🛠️ Troubleshooting
💡 Best Practices
🆘 Support

🎯 Overview

Take your server customization to the next level with MetaBuild! Whether you’re crafting a post-apocalyptic world or building a large-scale military training facility, MetaBuild gives you complete freedom to construct, edit, and manage objects effortlessly. MetaBuild even allows you to save your creations after server restarts!

Key Features

✅ Build Mode (No Clip) - Easily move and place objects without restrictions
✅ Synchronized - Everything you build is synchronized over all players
✅ Saved - Everything you build is saved, unless you configure to refresh on restarts
✅ Advanced Snapping Tools - Rotate and snap objects with precision
✅ Ground Placement Option - Ensure stable and realistic object positioning
✅ Demolish Mode - Quickly remove unwanted structures
✅ Comprehensive Object Menu - Manage objects (Build, edit, delete, customize categories)
✅ Built-in Door Lock System - Secure areas with key-based access
✅ Key Management - Give, take, or reset duplicate keys
✅ Object Customization - Add, edit, and delete objects with ease
✅ High Performance Rendering - Supports up to 1,500 objects per 750 GTA meters
✅ Custom Object Lifespan - Define how long objects remain in-game
✅ Paid Construction Option - Monetize object placement if desired
✅ Flexible Permissions - Configure access for Admins, Moderators, Trusted Users
✅ Detailed Permission Settings - Control building zones, editing, road construction
✅ Powerful Management Panel - Mass delete objects/keys, track stats
✅ Discord Webhook Integrations - Built-in Discord notifications
✅ Multi-Framework Support - ESX/QBCore/Standalone compatible
✅ Escrow Protection - Secure resource with multi-language support

🎥 Video Showcase

Watch MetaBuild in action:

Video Showcase

🛒 Purchase Information

Get MetaBuild:

Purchase on Nights Software Store

⚠️ Important Pre-Installation Notes

Critical Installation Order: Always follow this exact sequence to avoid parsing errors in the F8 console:

Download ZIP Package from CFX Portal

Unpack in a folder on your local machine

Set File Transfer Protocol (FTP) type to binary

Drag files from local machine to server resources folder

Add to server.cfg (ensure script)

Boot up the server

Support Policy: Follow this guide step by step. If you’re stuck, ask for support in our Discord and provide the specific step name. Do not skip steps.

Database Requirement: MetaBuild requires a MySQL database and oxmysql resource to function properly.

🔧 System Requirements & Compatibility

OneSync Compatibility

✅ OneSync Legacy: Fully tested and compatible
✅ OneSync Infinity: Fully tested and compatible

Framework Compatibility

✅ ESX: Full compatibility with ESX framework
✅ QBCore: Full compatibility with QBCore framework
✅ Standalone: Works without any framework

Dependencies

✅ MySQL Database - Required for data storage
✅ oxmysql - Required database API
✅ Dynamic Door Creation - Server setting required

Note: MetaBuild works seamlessly with all major FiveM frameworks and requires proper database setup.

📦 Installation Process

Step 1: Download the Resource

Access CFX Portal
- Go to CFX Portal Assets
- Find “MetaBuild” in your granted assets
- Download the ZIP package

Step 2: Extract and Transfer

Extract the ZIP file
- Unpack the downloaded ZIP package to a local folder
- Ensure all files are properly extracted
Transfer to Server
- Set your FTP client to binary transfer mode
- Upload the night_metabuild folder to your server’s resources directory
- Maintain the original folder structure

Step 3: Server Configuration

Add the following line to your server.cfg file:

ensure night_metabuild

Server Restart: After adding the ensure line, restart your server for the resource to load properly.

🗄️ Database Setup (Required)

Step 1: Enable Dynamic Door Creation

Add this line to your server.cfg above the starting of scripts:

setr game_enableDynamicDoorCreation "true"

Step 2: Database Connection String

Add your MySQL connection string to server.cfg above the ensure/start of resources:

set mysql_connection_string "user=Your_Database_Username;password=Your_Database_Password;host=Your_Database_Host;port=3306;database=Your_Database_Name;charset=utf8mb4_general_ci"

Localhost Example:

set mysql_connection_string "user=root;password=;host=localhost;port=3306;database=Your_Database_Name;charset=utf8mb4_general_ci"

Step 3: Automatic Table Installation

When you boot up the server, MetaBuild will automatically run queries to install the required tables into your database.

Manual Installation: The files include a datatables.sql file if you prefer to manually install the tables.

🔌 oxmysql Installation (Required)

Step 1: Download oxmysql

If you don’t have oxmysql installed, download it from: Download oxmysql

Step 2: Install oxmysql

Place oxmysql into your resources folder
Add to server.cfg - Ensure it starts before MetaBuild:

ensure oxmysql

Documentation: For oxmysql questions, visit oxmysql documentation

Step 3: Test Database Connection

Start your server and check the console for oxmysql connection messages. You should see confirmation that the database connection is working.

⚙️ Configuration Setup

Required Tools

Visual Studio Code: We strongly recommend downloading VS Code for editing Lua files.

Configuration Files

File	Purpose
`night_metabuild/config/config.lua`	Main configuration settings
`night_metabuild/client/c_functions.lua`	Client-side functions
`night_metabuild/server/s_functions.lua`	Server-side functions

Configuration Process

Open VS Code and navigate to the config files
Read thoroughly - each line has explanatory comments
Configure in order - work from top to bottom
Watch for notes - important warnings are clearly marked
Test frequently - use F8 console and server console for error checking

Time Investment: Plan adequate time for configuration. Each variable is named descriptively to help you understand its purpose.

🎮 How It Works

Building System

Build Mode - No-clip movement and object placement
Advanced Snapping - Precise object rotation and positioning
Ground Placement - Stable and realistic object positioning
High Performance - Supports up to 1,500 objects per 750 GTA meters
Object Lifespan - Customizable object persistence

Management Features

Comprehensive Menu - Build, edit, delete, and customize objects
Door Lock System - Key-based access control
Key Management - Give, take, or reset duplicate keys
Mass Operations - Bulk delete objects and keys
Statistics Tracking - Monitor object usage and performance

Permission System

Flexible Access - Configure for Admins, Moderators, Trusted Users
Zone Control - Define building zones and restrictions
Road Construction - Control road building permissions
Menu Access - Manage who can access building menus

🔗 Integration & Compatibility

Framework Support

Standalone - Works independently without framework dependencies
ESX - Full ESX framework integration
QBCore - Full QBCore framework integration

Database Integration

MySQL Database - Persistent storage for all constructions
oxmysql API - Reliable database connectivity
Automatic Backups - Built-in data protection

Database Setup: Ensure your MySQL database is properly configured and accessible.

🛠️ Troubleshooting

Common Issues

Parsing Errors in F8 Console

Ensure files are transferred in binary mode via FTP

Follow the installation order: ZIP → Unpack → Binary FTP → Resources → server.cfg

Database Connection Issues

Verify MySQL connection string is correct

Check database credentials and accessibility

Ensure oxmysql is properly installed and started

Objects Not Saving

Verify database tables are created

Check oxmysql connection status

Ensure proper permissions are set

Performance Optimization

Object Limits - Monitor object count per area
Database Performance - Optimize MySQL queries
Rendering Distance - Configure appropriate render distances

💡 Best Practices

Configuration Tips

Permission Planning - Set up appropriate access levels
Zone Management - Define logical building zones
Object Organization - Use categories for better management
Backup Configurations - Keep backups of working configurations

Database Management

Regular Backups - Backup your database regularly
Performance Monitoring - Monitor database performance
Table Maintenance - Periodically optimize database tables

Server Performance

Object Limits - Respect recommended object limits
Render Optimization - Configure appropriate render distances
Resource Management - Monitor resource usage with large builds

🆘 Support

Read through the instructions again if you have not managed to install the resource. Can’t get it to work still? Create a ticket through our dedicated support system in Discord:

Nights Software Discord