Onex
Onex
Home
Products
Documentation
Changelog
Login with FiveM
  • 👋 Welcome
  • Claim Purchase
  • Translations
    • Weaponmeta
    • Voice Interaction
      Integrations
      ⭐ Convars
      Llm-setup
      Stt-setup
      Tts-setup
      Configuration
      Features
      Api
Artifacts Tracker
  1. Onex Scripts
  2. Scripts_guides / Installation
Ctrl K

INSTALLATION#

This page walks you from download → placement → startup order → first launch for onex-voiceInteraction.

ASSET DOWNLOAD#

  1. Go to the CFX Portal (Keymaster)
  2. Navigate to Granted Assets section
  3. Locate onex-voiceInteraction in your asset list
  4. Click Download to get the latest version
  5. Extract the downloaded archive to a temporary location

ASSET DEPENDENCIES#

The following resources must be installed and started before onex-voiceInteraction:

When you purchase onex-voiceInteraction, the dependency onex-base is included.

DependencyRequired
onex-baseYes

ASSET POSITIONING#

Extract both resource folders into your server's resources/[onex]/ directory. If the [onex] folder does not exist, create it manually. Do not rename either folder — the scripts reference their own names internally.

resources
[onex]
onex-base
onex-voiceInteraction

CONFIGURE —server.cfg#

Add the following to your server.cfg, after your framework and its dependencies (e.g. qb-core, ox_core).

ensure [onex]

By default the script runs without any API keys using the built-in STT backend and Edge TTS — no setup required. API keys are only needed to unlock additional providers or features.

Optional BYOK keys#

# ── STT (Speech-to-Text) ──────────────────────────────────────────────────── # set stt_api_key "your_key_here" # set stt_provider "groq" # groq | azure | google # ── TTS (Text-to-Speech) ──────────────────────────────────────────────────── # set tts_api_key "your_key_here" # set tts_provider "elevenlabs" # elevenlabs | azure # ── LLM ───────────────────────────────────────────────────────────────────── # set llm_api_key "your_key_here" # set llm_provider "groq" # groq (default)

Uncomment and fill in only the categories you need. Full setup guides:

  • STT Setup — multi-language support, provider options, secondary fallback
  • TTS Setup — ElevenLabs, Azure, or free Edge TTS
  • LLM Setup — AI matching fallback and ambient NPC AI responses
  • All Convars — complete reference for every setting

START YOUR SERVER#

Start or restart your server. Open the server console and confirm there are no red error lines from onex-voiceInteraction. A clean startup logs the resource as started and prints a summary of active providers.

Last updated 3 months ago

Quick Links

All DocumentationOur Products