Installation

2 min readUpdated Today

Overview

ML Missions is a quest system with an in-game creator, NPC management, squad co-op, ElevenLabs TTS voice acting, XP/reputation tracking, and a community hub for sharing missions. All data is stored in MySQL.

Quick Start

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

ml_missions must start AFTER ml_bridge.

Database

Tables are created automatically on first start:

ml_missions: Mission definitions (JSON)

ml_mission_npc: NPC configurations (JSON)

ml_missions_xp: Player reputation/XP per NPC

ml_mission_completed: One-time completion tracking per player

TTS Setup (Optional)

  1. Open server/config_server.lua
  2. Set your ElevenLabs API key in Config.TTS.ElevenLabs.ApiKey
Disable TTS

Set Config.TTS.Enabled = false in shared/config/config.lua to disable TTS entirely. No API key needed.

Audio Cache

Generated audio is stored at cache/tts/ inside the resource folder. The cache is persistent across script updates and is not distributed in the release package. Each server owner builds their own cache over time.

To use your own recordings, drop .mp3, .wav or .ogg files in cache/tts/ and select Custom File as the audio source in the creator. Custom files skip the API entirely.

Verify

After starting, the console will print:

lua
1[ml_missions] Resource started
2[ml_missions] Developed by Micio Mods | miciomods.it

Open the mission creator with /missioncreator (requires admin permissions via your framework).

  • Script not starting. Verify all dependencies are running and ensure order is correct in server.cfg.
  • Creator not opening. Confirm admin permissions in your framework. Check console for permission errors.
  • NPCs not spawning. Verify the ped model exists in shared/config/peds.lua. Check console for database errors.
  • TTS not working. Verify Config.TTS.Enabled = true, API key is set in server/config_server.lua, and xsound is running.