Getting Started
MergeCore is a desktop agent that runs on the same machine as your FiveM server (or on your local development machine). It connects to the MergeCore API for manifest synchronization and license verification.
Installation
System Requirements
Windows 10/11 or Linux · 50MB disk space · Internet connection · FiveM server with resources folder
Download the MergeCore Agent installer from the download page. Run the installer and follow the setup wizard.
# Download from mergecore.net/subscription
# Run the installer:
mergecore-agent-setup.exe
# Activate with your Patreon token
# Set server directory in Settings
First Setup
After installation, the agent will ask you to:
- Paste your Patreon activation token (from the subscription page after subscribing)
- Point to your FiveM server's resources folder
- Set your Server Directory path in Settings (your FiveM server txData folder)
ℹ️ The agent automatically scans your resources folder to detect installed scripts and determine your subscription eligibility.
Updating Scripts
MergeCore supports two update flows depending on whether the developer has submitted a manifest.
Verified Updates (with Manifest)
When a partnered developer publishes a manifest via the Developer Portal, MergeCore knows exactly what changed. This enables:
- Automated three-way config merge
- SQL migration execution with pre-flight preview
- Force-replace orchestration for critical files
- Full rollback guarantee with pre-update snapshot
✅ Verified updates show a green shield badge in the agent. Your configs are automatically preserved.
Unverified Updates (no Manifest)
For scripts without a manifest, MergeCore operates in limited analysis mode:
- Structure analysis and file diff visualization
- Manual file replacement (at your own risk)
- Blueprint generation for future reference
⚠️ Unverified updates cannot use automated merging. You must manually review and replace files.
Handling Merge Conflicts
When both you and the developer changed the same value, MergeCore presents a clear conflict view:
-- config.lua line 50
- Config.Hotbar = 5 -- YOUR value
+ Config.Hotbar = 6 -- DEVELOPER value
Choose: [Keep Mine] [Accept Theirs] [Edit Manually]
You decide for each conflict. MergeCore never makes silent decisions about conflicting values.
Backups & Rollback
Before every update, MergeCore creates a complete snapshot:
- Full file backup of the script folder (ZIP archive)
- Database dump if SQL migrations are involved
- Metadata file with version info and timestamp
Backups are stored locally in the MergeCore data directory. You can rollback to any previous version with one click — both files and database are restored.
Backup location: ~/.mergecore/backups/
Format: backup_{script}_{version}_{date}.zip
Database: backup_{script}_{version}_{date}.sql
SQL Migrations
When a developer declares sql_required: true in their manifest, MergeCore handles database changes safely:
- Pre-flight preview shows every SQL statement before execution
- Full database backup created before any changes
- Migrations run in version order (important for chained updates)
- Schema drift detection warns about manual table modifications
- Instant rollback if any migration fails
⚠️ SQL execution is only available for verified (manifest-driven) updates. Unverified updates cannot modify your database.
Developer Portal (For Partners)
The MergeCore Developer Portal is the official hub for partners. Register scripts, upload ZIPs for structure analysis, and publish versioned update manifests.
Getting Started
As a MergeCore partner, you manage everything through the Developer Portal:
1. Register Your Scripts
Go to My Scripts and click + Register Script. Enter the script name and slug. New scripts require admin approval before appearing in customer agents.
2. Upload ZIP for Analysis
Upload your script ZIP to analyze its structure: files, folders, escrow status, and metadata. MergeCore does not store the ZIP or source code — analysis only.
3. Publish Manifests
When you release an update, go to Manifests and publish a new version. Declare changed files, protected configs, SQL requirements, and changelog notes.
4. Configure Discord Verification
In Discord Setup, add your server and Customer role. MergeCore bot verifies that users own your scripts, enabling Premium tier eligibility (€5/mo instead of €10/mo).
5. Companion Scripts
If your script ships with companion resources (bridges, dependencies), configure them in Companion Scripts so MergeCore handles them together during updates.
Manifest Publishing
When you publish a manifest through the Developer Portal, it generates this structure:
{
"developer": "quasar-store",
"script": "qs-inventory",
"version": "2.5.0",
"previous_version": "2.4.1",
"changed_files": [
"fxmanifest.lua",
"client/main.lua",
"server/main.lua"
],
"protected_files": ["config.lua", "items.lua"],
"sql_required": false,
"sql_files": [],
"force_replace": false,
"multi_resource": false,
"resources": [],
"notes": "OxInventory v2.8 support"
}
Subscription & Premium
MergeCore uses Patreon for subscription management. Two tiers are available:
Standard — €10/mo
Full access to all MergeCore features. Available to everyone.
Premium — €5/mo
Discounted tier for users who own scripts from a Premium Partner developer. Eligibility is verified automatically through Discord role checking.
How Premium Verification Works
- Premium Partners add the MergeCore bot to their Discord server
- Partners configure a "Customer" role that buyers receive after purchase
- When you connect Discord on the subscription page, the bot checks your roles
- If you have a Customer role in any Premium Partner server → you qualify for €5/mo
ℹ️ You don't need to be on the MergeCore Discord server for verification — the bot checks partner servers directly.
API Reference
The MergeCore API is used by the desktop agent for synchronization. Base URL: https://mergecore.net/api
Endpoints
GET /api/health
Server health check. Returns status, time, and version.
GET /api/partners
List all registered partners with tier information.
GET /api/scripts
List all supported scripts with partner and version info.
GET /api/manifests
List all submitted manifests, ordered by date.
GET /api/manifests/:scriptSlug
Get manifests for a specific script (last 10).
POST /api/eligibility
Check Premium tier eligibility. Send array of script slugs, returns eligibility status and matched premium partners.
POST /api/patreon/verify
Validate a Patreon subscription. Send activation token and hwid, returns subscription status, tier, and discord_id.
ℹ️ All API endpoints return JSON. Authentication will be required for production endpoints (JWT token in Authorization header).