Installation

On this page, you will find the steps to make a successful installation of nPhone manually.

Step 1 - Installing dependences

nPhone relies on three dependencies: oxmysql, a customized variant of xsound, and screenshot-basic. Below are the links to these essential resources:

Step 2 - Setting up api keys

To enable the functionality of images, videos, and audio, it is necessary to configure a Discord webhook for file uploads. Below, you will find the path to the API keys:

To use ChatGPT APP, you will have to set up an OpenAI API Key.

If you're unsure about where to obtain this information, you can refer to the following tutorial:

Step 3 - Start order

On the server.cfg, you will have to start the resources in this order:

ensure oxmysql
ensure xsound
ensure screenshot-basic

ensure frameworkName
ensure inventoryName
ensure voiceSystemName

ensure nPhone

Step 4 - Creating SQL tables

When we have all set, we can start the script and it will automatically create the SQL tables.

If you want to install the SQL manually, you can get the SQL file on: nPhone/config/installation/nPhone.sql

Finishing - Last steps

If you are using the supported frameworks (esx or qbcore), the supported voice systems (pma-voice, mumble-voip or saltychat) and the supported inventory systems (qb-inventory, qs-inventory, ps-inventory, ox_inventory or lj-inventory), your installation has been successfully completed. nPhone will automatically detect the framework you are currently using. If you prefer to employ a custom framework, rest assured that our framework code is open source. This allows you the flexibility to modify and tailor it to suit your specific framework requirements. The file paths are as follows:

PreviousConfiguratorNextExports

Last updated