Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/revertit/mybb-rt_chat

RT Chat Is a modern and responsive MyBB chat plugin which utilizes MyBB cache system when retrieving messages via ajax. For high performance and no database queries, you can speed up ajax requests to even 1-2 seconds per request for better message sync.
https://github.com/revertit/mybb-rt_chat

ajax chat-application fetch-api mybb-plugin php

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/revertit/mybb-rt_chat
Owner: RevertIT
License: mit
Created: 2023-04-11T12:35:27.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-04-02T22:33:50.000Z (9 months ago)
Last Synced: 2024-10-12T06:21:07.028Z (2 months ago)
Topics: ajax, chat-application, fetch-api, mybb-plugin, php
Language: PHP
Homepage:
Size: 86.9 KB
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        ## RT Chat

Is a modern and responsive MyBB chat plugin which utilizes MyBB cache system when retrieving messages via ajax. For high performance and no database queries, you can speed up ajax requests to even 1-2 seconds per request for better message sync.

### Table of contents

1. [❗ Dependencies](#-dependencies)

2. [📃 Features](#-features)

3. [➕ Installation](#-installation)

4. [🔼 Update](#-update)

5. [➖ Removal](#-removal)

6. [📜 Usage](#-usage)

7. [💡 Feature request](#-feature-request)

8. [🙏 Questions](#-questions)

9. [🐞 Bug reports](#-bug-reports)

10. [📷 Preview](#-preview)

### ❗ Dependencies

- MyBB 1.8.x

- https://github.com/frostschutz/MyBB-PluginLibrary (>= 13)

- https://github.com/RevertIT/mybb-rt_extendedcache (>= 2.0)

- PHP >= 8.0

### 📃 Features

- Responsive design (CSS, templates, and settings included)

- Ajax chat with cached messages. (**No database stress!**)

- Whispers system. (Private chat messages)

- Popup modal for top 10 chat posters

- Chat bot (Get configurable notifications from bot in chat)

- Chat actions like (/clear, /ban, /unban, /check)

- Anti flood system

- Live message timer update

- Infinite scroll for older messages

- Set refresh time

- Set away time (Ajax won't be called when user is afk)

- Supports BBCodes and Smiles

- Max message length

- Edit/delete messages

- Groups which can access chat

- Separated chat page at `/misc.php?ext=rt_chat`

- and many more features.

### ➕ Installation

1. Copy the directories from the plugin inside your root MyBB installation.

2. Settings for the plugin are located in the "Plugin Settings" tab. (`/admin/index.php?module=config-settings`)

### 🔼 Update

1. Deactivate the plugin.

2. Replace the plugin files with the new files.

3. Activate the plugin again.

### ➖ Removal

1. Uninstall the plugin from your plugin manager.

2. _Optional:_ Delete all the RT Chat plugin files from your MyBB folder.

### 📜 Usage

#### Chat actions

All chat actions are case-insensitive.

- **Ban user via chat action**

```php

/ban "username" "ban reason" 60

```

Will ban the user with username `username` and set reason as `ban reason` for `60` minutes.

- **Unban user via chat action**

```php

/unban "username"

```

Will unban the user with username `username`.

- **Clear chat via chat action**

```php

/clear

```

Will clear all the chat messages.

- **Check user status via chat action**

```php

/check "username"

```

Will check the details about user with username `username` and the message will be displayed only to moderator who called the command.

### 💡 Feature request

Open a new idea by [clicking here](https://github.com/RevertIT/mybb-rt_chat/discussions/new?category=ideas)

### 🙏 Questions

Open a new question by [clicking here](https://github.com/RevertIT/mybb-rt_chat/discussions/new?category=q-a)

### 🐞 Bug reports

Open a new bug report by [clicking here](https://github.com/RevertIT/mybb-rt_chat/issues/new)

### 📷 Preview