Configuration

Main Configuration (config.lua)

The main configuration file controls the app's behavior and appearance.

Config = {
    Debug = false,                    -- Enable debug logs and console output
    AppName = "Zelp",                 -- App name displayed in phone
    AppDescription = "Review and rate local businesses", -- App description
    DefaultApp = false,               -- Install app by default for all players
    AppSize = 59812,                  -- App size in KB (for phone storage)
    AppPrice = 0                      -- App price in game currency (0 = free)
}

return Config

Configuration Options

Option
Type
Default
Description

Debug

boolean

false

Enable debug logging and console output

AppName

string

"Zelp"

Name of the app in the phone

AppDescription

string

"Review and rate local businesses"

Description shown in app store

DefaultApp

boolean

false

Whether to install the app by default

AppSize

number

59812

App size in KB for phone storage

AppPrice

number

0

Price to download the app (0 = free)

Discord Webhooks (server/webhook.lua)

Configure Discord webhooks for notifications and logging.

-- Discord Webhook Configuration
local webhookUrl = "YOUR_DISCORD_WEBHOOK_URL"

-- Webhook Events:
-- - Review Creation
-- - Review Deletion  
-- - Account Registration
-- - Business Registration
-- - User Login/Logout

Webhook Events

The script sends notifications for the following events:

  1. Review Creation - When a user creates a new review

  2. Review Deletion - When a user deletes their review

  3. Account Registration - When a new user account is created

  4. Business Registration - When a new business account is created

  5. User Activity - Login/logout events

Webhook Format

Each webhook includes:

  • User Information - Player name, identifiers

  • Event Details - What happened and when

  • Review Data - Rating, text, images (for reviews)

  • Business Information - Business name and details

Localization (locales/)

Zelp supports multiple languages through locale files.

English Locale (locales/en.lua)

Locales['en'] = {
    -- Navigation
    ['home'] = 'Home',
    ['explore'] = 'Explore', 
    ['profile'] = 'Profile',
    
    -- Account
    ['login'] = 'Login',
    ['signup'] = 'Sign Up',
    ['logout'] = 'Logout',
    
    -- Reviews
    ['write_review'] = 'Write Review',
    ['rating'] = 'Rating',
    ['review_text'] = 'Review Text',
    
    -- Messages
    ['success'] = 'Success',
    ['error'] = 'Error',
    ['loading'] = 'Loading...'
}

Adding New Languages

  1. Create Language File

    -- locales/es.lua (Spanish example)
    Locales['es'] = {
        ['home'] = 'Inicio',
        ['explore'] = 'Explorar',
        ['profile'] = 'Perfil',
        -- ... more translations
    }
  2. Update Configuration

    -- In config.lua, add:
    Config.Locale = 'es'  -- Set default language

Last updated