## Overview

Thank you very much for purchasing Owl Chat. This documentation will help you get started and go into detail about using Owl Chat!.
If you need more assistance, please post a comment and I'll get to you ASAP!

## Installation

Installing Owl Chat is fairly simple. It only requries 3 steps.

#### 1. Upload the files found in main.zip to your site or directory.

#### 2. Visit the directory and navigate to htttp://YOURSITE.COM/PATH/TO/CHAT/install.php

#### 3. Input your database's host, name, username and password and run.

#### 4. DELETE INSTALL.PHP AFTER RUNNING INSTALLATION!

## Quick Start

After installing Owl Chat, the installation will create some default settings for you. An account is also created for you. To login user the following creds.

Username: admin
Password: admin

It is recommended you change your password before launching your script. Once logged in, you'll see the link to the admin dashboard. If you would like to create a chat, then go to Admin > Chats > Create.

## Settings

Let's talk about what each setting does in Owl Chat

### General Settings

- Site Name - Your site's name.
- Site Description - Your site's description.
- Header Ad - This will be displayed every page in the main section.
- Footer Ad - This will be displayed on every page in the footer section.
- Sidebar Ad - This will be displayed every page on the bottom of the sidebar.
- Bad Words Filter - Words that will be censored when entered. This is applied globally.

### User Settings

- Registration - Allow visitors to register and create profiles on your site.
- Max Upload Size - Users can upload profile images. Limit the size of their images by KB.
- Allow File Uploads - Allow users to upload files. Only applies to regular users. Admins & Super mods can upload.
- Allow Poll Creation - Allow users to create polls. Only applies to regular users. Admins & Super mods can upload.

### Chat Settings

- Auto Clean DB - The DB will be cleaned every certain amount of hours. You can set this to 0 to never clean the DB.
- Regular Member Room Creation - Allows regular members to create chat rooms as well.
- Guests can Chat - Allows guest users to chat in the room as well.
- Buttons - There are various options to disable certain formatting options.

#### Emoticons

Here you can manage, update, add and delete emoticons from your chat. The command is the text a user hast to type in order to use an emoticon.

## Private Messaging

Users can private message each other easily. In order to do so, visit a chat room and click online users. From here you can private message anyone. You're free to move from room to room as you'll be notified if you receive any new private messages on the top right corner.

## Commands

There are currently 4 commands available to users.

- !ban USERNAME - Bans a user from a chat room
- !unban USERNAME - Unbans a user from a chat room
- !addmod USERNAME - Makes a user a mod in a chat room.
- !removemod USERNAME - removes mod status from a user in a chat room.

## Images, Links & Youtube

Embedding links and images is easy as using the [img][/img], [url][/url] and [yt][/yt] bbcodes. You need to place your links and images between these 2 codes

## Credits

Owl Chat have used the following jQuery plugins as listed.

Name | URL
--- | ---
jQuery | http://www.jquery.com
Font Awesome | http://fontawesome.io/
Spectrum | https://bgrins.github.io/spectrum/
Dropzone | http://www.dropzonejs.com/
Bootstrap 3 | http://getbootstrap.com/
AngularJS | https://angularjs.org/
Kanda | http://codecanyon.net/item/kanda-bootstrap-skin/8043799

## Change log

#### Version 2.0

- Updated Version
- Added File Uploads
- Faster Performance
- Gzip enabled
- Cleaner URLs
- Create Polls
- Advanced Chat Creator
- Brand New Design

#### Version 1.0

- Owl Chat Launches.