# Functions

## **Quick Installation**

{% stepper %}
{% step %}

### Add resource

Add axr\_resource into your resources folder and ensure it in server.cfg server file.
{% endstep %}

{% step %}

### Add SQL File

If you are using oxmysql/ghmattimysql or any sql type add the sql.sql file in your server database.\
\
For MongoDB you don't need to add nothing, just be sure to edit Config.Sql and Config.SqlType
{% endstep %}

{% step %}

### Edit config.lua

Open config/config.lua file in order to work for your framework. \
\
Important hints:

```lua
Config.Framework = 'vrp'
Config.SqlType = 'sql'                                    -- sql for oxmysql/ghmattimysql | nonsql for mongodb
Config.Sql = 'oxmysql'                                    -- db resource name for exports[]
Config.useItem = true                                     -- use item in order to open the menu
Config.item = 'octa_tablet'                               -- item code
Config.command = 'octastore'                              -- command to open the menu
Config.Inventory = 'axr_inventory'                        -- vrp/esx/qb-core/axr_inventory
Config.notifySystem = 'vrp'                               -- vrp/esx/qb-core/etc
Config.expirePosts = true                                 -- use expire system or not
Config.expireCooldown = 3                                 -- in days
Config.itemsImg = 'nui://axr_inventory/nui/assets/items/' -- items directory path (can use custom cdn)
```

{% endstep %}

{% step %}

### Edit the fxmanifest.lua

Edit the fxmanifest.lua for your framework.
{% endstep %}

{% step %}

### Edit lang files

Edit all lang files for your needed language.\
\
Lua file - config/lang.lua\
Javascript File - nui/js/config.lua
{% endstep %}

{% step %}

### Edit framework functions

vRP default files - [vRP](/axr-documentation/resources/axr_octastore/functions/vrp.md)

ESX default files -  [ESX](/axr-documentation/resources/axr_octastore/functions/esx.md)

QB-CORE default files - [QB-CORE](/axr-documentation/resources/axr_octastore/functions/qb-core.md)

Note: you can add any custom framework file, just make sure to sync it with config.lua
{% endstep %}
{% endstepper %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://axero-scripts.gitbook.io/axr-documentation/resources/axr_octastore/functions.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.