Skip to main content ↑ ↓
[Addon] Ultimate Shoutbox & Chatroom v1.1.0 Started by vbgamer45 · · Read 9773 times 0 Members and 1 Guest are viewing this topic.

[Addon] Ultimate Shoutbox & Chatroom v1.1.0

Ultimate Shoutbox & Chatroom v1.1.0
====================================
A feature-rich, AJAX-powered shoutbox and chatroom for Elkarte 1.1

Features:
- Real-time shoutbox widget on every page (configurable placement)
- Full-page chatroom with online users sidebar
- Multi-room support with public/private rooms and group-based access
- Whisper (private) messages via /whisper or /w commands
- Admin messages visible to moderators only via /admin or /a commands
- Message reactions with 5 icon types (like, dislike, star, heart, award)
- GIF picker with Tenor and Giphy support (server-side proxy)
- @mention autocomplete (searches online users + Elk member DB)
- Slash command autocomplete (/whisper, /prune, /clean, /mute, etc.)
- Inline message editing and deletion
- Moderation tools: ban/mute/unmute users, prune/clean messages
- /me action messages
- Sound notifications with tab-away title flash and unread counter
- Searchable message history with date filtering and CSV/text export
- Auto-prune old messages (configurable retention period)
- Flood protection for non-moderators
- Per-room online presence tracking via cache
- BBCode and smiley parsing support
- Fully responsive design with dark mode support
- 100% hook-based installation (zero core file edits)
- 5 configurable permissions (view, post, moderate, whisper, gif)
- Guest read-only access (optional)
- Adaptive polling with exponential backoff on errors
- Elk cache integration for reduced database load

Installation:
1. Go to Admin > Packages > Install a New Package
2. Upload the mod package or install from directory
3. Set permissions under Admin > Permissions > Shoutbox
4. Configure settings under Admin > Configuration > Shoutbox Settings

For GIF support:
- Tenor: Get a free API key from Google Cloud Console
  (APIs & Services > Enable "Tenor API" > Create Credentials)
- Giphy: Get a free API key from developers.giphy.com
- Klipy: https://partner.klipy.com

Notification Sound:
- A WAV notification chime is included.
- For smaller file sizes, optionally provide notification.mp3
  and/or notification.ogg in the shoutbox-sounds directory.
  The player will prefer MP3 > OGG > WAV automatically.

Credits & Licenses:
- Icons: FamFamFam Silk icon set by Mark James
  http://www.famfamfam.com/lab/icons/silk/
  Licensed under
  Creative Commons Attribution-ShareAlike 4.0 International
  https://creativecommons.org/licenses/by-sa/4.0/
- Notification sound generated procedurally (public domain)
- This modification is provided as-is with no warranty.

Requirements:
- Elk 1.1.x
- PHP 7.0+
- MySQL 5.6+ / MariaDB 10.0+

Re: [Addon] Ultimate Shoutbox & Chatroom v1.1.0

Reply #1 –

Looks cool :cool:

Re: [Addon] Ultimate Shoutbox & Chatroom v1.1.0

Reply #2 –

Very interesting, I had used something like it in old days, but this one, I haven't tested it.

Though I was wondering if multiple chat group is a feature or possible (on membergroup basis) yet limited to its members access only.

Also in my mind, if chat button is clicked, it will list the chat rooms he is a member to, or something like that, with such a feature.

Sorry for wondering too much.  :cheesy:

Re: [Addon] Ultimate Shoutbox & Chatroom v1.1.0

Reply #3 –

Currently admins can create chatrooms. They can be public, private or restricted by member group.

The chatroom button right now when clicked goes to the default chatroom which you can set up. And on the top of the chatroom interface is different tabs whith each chatroom name.

Re: [Addon] Ultimate Shoutbox & Chatroom v1.1.0

Reply #4 –

Meaning multiple chat room is possible? Great. I will test this soon.

By the way, will multiple chat rooms have side affects on server performance? Or what are the server requirements to have such multiple chat rooms?

Re: [Addon] Ultimate Shoutbox & Chatroom v1.1.0

Reply #5 –

Quote from: vbgamer45 – Currently admins can create chatrooms. They can be public, private or restricted by member group.

The chatroom button right now when clicked goes to the default chatroom which you can set up. And on the top of the chatroom interface is different tabs whith each chatroom name.

Here's a ponder.... a new user privilege "Host"? Members given a chatroom "Host" privilege can establish one or more private chat rooms (limit..2? 3? rooms, Or "tabs"?), and control invitations to it (admin is automatically a member for monitoring purposes).  And only the admin can delete chatroom posts or edit a post (after the edit timeout), remove a chatroom member (besides that member his/herself,) or close the chatroom (legality/liability concerns).  :undecided:

Not quite allowing members to set up mini-forums in your forum.. maybe time-limited private chat room access (one week, month? admin extendible..)
Last Edit: February 26, 2026, 11:04:42 am by Steeley
// Deep inside every dilemma lies a solution that involves explosives //

Re: [Addon] Ultimate Shoutbox & Chatroom v1.1.0

Reply #6 –

That's a good idea. I am sure I can extend the mod to do that.

Re: [Addon] Ultimate Shoutbox & Chatroom v1.1.0

Reply #9 –

Thanks good now!

Re: [Addon] Ultimate Shoutbox & Chatroom v1.1.0

Reply #10 –

Small update Klipy support added. Fix a bug with images inserted just being displayed instead of BBC code.