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:
๐ 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โsresources
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: