Installation Guide

This guide will walk you through installing and setting up Prodigy Chat on your FiveM server.

Before installing Prodigy Chat, ensure you have the following dependencies installed:

Required Dependencies

1. ESX Framework

   • Must be installed and configured

   • Required for player management and job system

2. ox_lib

   • Required for notifications and UI components

   • Download: ox_lib

3. oxmysql

   • Required for database operations

   • Download: oxmysql

Optional Dependencies

1. LB Phone (Optional)

   • Required only if you want to use phone text commands

   • Set Config.phonetext = true in config.lua

   • Download: LB Phone

2. cd_easytime (Optional)

   • Required only if you want real weather data

   • Set Config.weatherUseEasytime = true in config.lua

   • Download: cd_easytime

Installation Steps

Step 1: Download the Resource

1. Download the Prodigy Chat resource

2. Extract the files to your server's resources folder

3. Place it in: resources/[base]/[cfx-default]/prodigy-chat/

Step 2: Configure Dependencies

Ensure your server.cfg includes the required dependencies before Prodigy Chat:

# Required Dependencies (must be loaded first)
ensure ox_lib
ensure oxmysql
ensure es_extended

# Optional Dependencies
ensure lb-phone  # Only if using phone commands
ensure cd_easytime  # Only if using real weather data

# Prodigy Chat
ensure prodigy-chat

Step 3: Database Setup

Prodigy Chat uses the ESX framework's existing database structure. No additional database tables are required.

Note: The resource uses the users table's group column for permission management. Ensure your ESX installation has this column.

Step 4: Configure the Resource

1. Open config.lua in the resource folder

2. Configure all settings according to your server's needs

3. See the Configuration guide for detailed options

Step 5: Start the Server

1. Start your FiveM server

2. Check the server console for any errors

3. You should see: ^2[prodigy-chat]: Chat system successfully started

Verification

To verify the installation is working:

1. Join your server

2. Type /help in chat - you should see the help ticket system

3. Type /s Hello - you should see a local chat message

4. Type /me waves - you should see a roleplay action

Troubleshooting

Resource Not Starting

• Check dependencies: Ensure all required dependencies are installed and started

• Check console: Look for error messages in the server console

• Check permissions: Ensure the resource folder has proper read permissions

Commands Not Working

• Check config.lua: Ensure the feature is enabled in the configuration

• Check permissions: Verify your player group has the required permissions

• Check framework: Ensure ESX is properly initialized

Database Errors

• Check oxmysql: Ensure oxmysql is properly configured and connected

• Check ESX: Verify ESX database connection is working

• Check users table: Ensure the group column exists in the users table

Updating

When updating Prodigy Chat:

1. Backup your config.lua: Always backup your configuration before updating

2. Download new version: Download the latest version

3. Replace files: Replace all files except config.lua

4. Merge config: Compare and merge any new configuration options

5. Restart server: Restart your server to apply changes

Support

If you encounter issues during installation:

1. Check the troubleshooting section above

2. Review the configuration guide

3. Check server console for error messages

4. Verify all dependencies are properly installed