Installation & Setup

This guide walks you through installing, configuring, and verifying MTM-PADUI on your FiveM server.

---

Prerequisites

Before starting MTM-PADUI, ensure your server meets the following requirements:

1. FXServer Build: Recommended server build 6683 or newer (Cerulean fx_version).
2. Database Engine (Optional): If using Config.UseDatabase = true, ensure oxmysql (version 2.0.0+) is installed and running. If oxmysql is absent or disabled, the resource automatically uses native FiveM server-side KVP.
3. Framework (Optional): MTM-PADUI is 100% standalone and works out of the box without any roleplay framework. If you use ESX Legacy, QBCore, or Qbox, the system automatically detects them for job and gang permissions.

---

Installation Steps

1. Extract Resource

Place the resource folder into your server’s resources directory (e.g. resources/[mtm]/MTM-PADUI).

Caution

Keep the folder name exactly as MTM-PADUI. Renaming the resource folder may break dynamic NUI iframe links and client export calls from other scripts.

2. Configure server.cfg Boot Order

Open your server configuration file (server.cfg) and ensure that your database driver and any integrated MTM resources are started in the correct order:

# Database layer (if Config.UseDatabase = true)
ensure oxmysql

# Roleplay framework (optional)
ensure es_extended     # or qb-core / qbx_core

# MTM Tablet Ecosystem Core
ensure MTM-PADUI

# Integrated MTM Resources (Start after MTM-PADUI)
ensure MTM-MATRIXBORDEN
ensure MTM-TRAJECTCONTROLE
ensure MTM-ANPR

---

Database Configuration

When Config.UseDatabase = true and oxmysql is running, MTM-PADUI automatically executes the table creation query upon server startup.

Automated Schema Creation

Upon booting, the server checks for the existence of mtm_tablet_data. The table schema structure is:

CREATE TABLE IF NOT EXISTS `mtm_tablet_data` (
    `identifier` VARCHAR(100) NOT NULL PRIMARY KEY,
    `data` LONGTEXT NOT NULL,
    `updated_at` TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
);

Data Storage & Privacy

Every player’s data is stored under their unique FiveM license (license:xxx). This guarantees:

• Private Data Isolation: Notes, personal folders, alarms, and custom app preferences remain strictly bound to the individual player. No data is shared across multiple clients or leaked to other users.
• Persistent App Layout: Installed and uninstalled App Store applications persist across server restarts and relogs.
• Failover Protection: If the MySQL server is unreachable, the system automatically switches to internal JSON caching (tablet_data.json) and native FiveM KVP (SetResourceKvp).

---

Ped Animation & Prop Setup

MTM-PADUI includes integrated ped animations and prop attachment to enhance in-game immersion.

When a player opens the tablet:

1. The animation dictionary amb@code_human_in_bus_passenger_idles@female@tablet@idle_a is loaded.
2. The prop_cs_tablet prop model is spawned and attached to the player’s right hand (SKEL_R_Hand, bone index 28422).
3. Animation flag 49 (upper body only + looped) is applied, allowing players to walk, turn, and navigate while using the tablet.
4. When the tablet is closed, ragdoll occurs, or the player is incapacitated, the prop and animation are cleaned up immediately.

All animation and prop parameters can be adjusted or completely disabled in config.lua:

Config.EnableAnimation = true
Config.AnimDict = "amb@code_human_in_bus_passenger_idles@female@tablet@idle_a"
Config.AnimName = "idle_a"
Config.PropModel = "prop_cs_tablet"
Config.PropBone = 28422
Config.PropOffset = vector3(-0.05, 0.0, 0.0)
Config.PropRotation = vector3(0.0, 0.0, 0.0)

---

Controls & Keybinding Configuration

Players can access the tablet via chat command or a dedicated keybind.

Default Controls

• Chat Command: /tablet (configurable via Config.OpenCommand)
• Keyboard Shortcut: F3 (configurable via Config.OpenKey)
• Close Shortcut: ESC key (configurable via Config.AllowEscClose)
• Chassis Recenter: Double-click the top drag handle or camera dot

FiveM Key Mapping

MTM-PADUI utilizes FiveM’s native RegisterKeyMapping engine. This allows players to rebind the key in their local client settings:

1. Open FiveM Settings (ESC -> Settings).
2. Navigate to Key Bindings -> FiveM.
3. Locate Open MtmPad Tablet and assign any preferred key.

---

Verification & Testing

Once installed and started, verify the resource by following these steps:

1. Join the server and press F3 (or execute /tablet in chat).
2. Verify that your ped holds the physical tablet prop and starts the upper-body typing animation.
3. Verify that the tablet interface opens with the Home Screen and active clock/date widgets.
4. Open the Notes application, type a sample test note, and close the tablet using the bottom home indicator or ESC.
5. Reopen the tablet and verify that your note is saved and present.
6. Open your server console and confirm that no errors or missing table warnings are reported.