Directory Structure - CometChat Docs

The exported UI Kit Builder code is organized in a standard iOS project structure. This guide helps you navigate the structure so you know exactly where to make changes.

Root Files

File	Purpose
`AppDelegate.swift`	App lifecycle, CometChat initialization, and Builder settings loading
`SceneDelegate.swift`	Scene lifecycle management for iOS 13+
`AppConstants.swift`	CometChat credentials (APP_ID, AUTH_KEY, REGION)
`FrameworkManager.swift`	Helper for initializing CometChat framework
`cometchat-builder-settings.json`	Builder configuration with feature flags, layout, and styling

Key Folders

`Assets.xcassets/`

Contains all image and color assets for the app.

`Base.lproj/`

Contains storyboards and localization base files.

`Helper/`

Utility classes and Swift extensions.

`View Controllers/`

All view controllers organized by feature.

Configuration Files

`cometchat-builder-settings.json`

The main configuration file containing all Builder settings:

{
  "builderId": "your-builder-id",
  "settings": {
    "chatFeatures": { ... },
    "callFeatures": { ... },
    "layout": { ... },
    "style": { ... }
  }
}

`AppConstants.swift`

Contains CometChat credentials:

struct AppConstants {
    static let APP_ID = "YOUR_APP_ID"
    static let AUTH_KEY = "YOUR_AUTH_KEY"
    static let REGION = "YOUR_REGION"
}

Quick Reference: Where to Customize

What you want to change	Where to look
Enable/disable features	`cometchat-builder-settings.json`
CometChat credentials	`AppConstants.swift`
Theme colors & styles	`cometchat-builder-settings.json` → `style` section
App icons	`Assets.xcassets/AppIcon.appiconset/`
Launch screen	`Base.lproj/LaunchScreen.storyboard`
Messages screen behavior	`View Controllers/CometChat Components/MessagesVC.swift`
Login flow	`View Controllers/LoginVC/`
Home screen layout	`View Controllers/HomeScreenViewController.swift`
Custom UI extensions	`Helper/Extentions.swift`

Prefer using cometchat-builder-settings.json for feature toggles and styling. For extensive changes, extend existing view controllers instead of modifying core files directly.

CometChat Components

The CometChat Components folder contains wrappers around CometChat UI Kit components:

Component	File	Purpose
Messages	`MessagesVC.swift`	Main messaging interface
Threaded Messages	`ThreadedMessagesVC.swift`	Thread view for replies
Create Conversation	`CreateConversations.swift`	Start new conversations
Add Members	`Add Members/`	Add users to groups
Banned Members	`Banned Members/`	View/manage banned users
Call Log Details	`Call Log Details/`	Call history details
Details Page	`DetailsPage/`	User/Group profile details
Group Component	`Group Component/`	Group management views
Transfer Ownership	`Transfer ownership/`	Transfer group ownership

Next Steps

UI Kit Builder Settings

Configure feature toggles and behavior

Customizations

Modify component props, styling, and behavior

Theming

Customize colors, typography, and styling

Components Overview

Explore all available UI components

​Root Files

​Key Folders

​Assets.xcassets/

​Base.lproj/

​Helper/

​View Controllers/

​Configuration Files

​cometchat-builder-settings.json

​AppConstants.swift

​Quick Reference: Where to Customize

​CometChat Components

​Next Steps

UI Kit Builder Settings

Customizations

Theming

Components Overview

Root Files

Key Folders

`Assets.xcassets/`

`Base.lproj/`

`Helper/`

`View Controllers/`

Configuration Files

`cometchat-builder-settings.json`

`AppConstants.swift`

Quick Reference: Where to Customize

CometChat Components

Next Steps