Skip to content
Johnny Mast edited this page May 3, 2020 · 10 revisions

Welcome to the Mysql Websocket Chat wiki!

Before we start let me state that this Wiki is work in progress. With that out of the way, welcome once more.

This project was started back in 2016 as a project for https://www.phpclasses.org/ and received 2nd price for an innovation award for the month September 😲. After finishing up the first version I decided to host the package on GitHub as a boilerplate for developers to start working from.

This boilerplate can be used as a starting point for all kinds of realtime work between browser and server. Especially developers working on customer service solutions take in the project. However, the most awesome use case for it has been the hear of a realtime game engine 😎

Features

The boilerplate is fairly rich with features to start with. The following functions are supported.

  • Chat indicators for who is typing a new message
  • Sending and receiving private messages from other
  • One chat channel for multiple chat clients to connect to
  • Database logging of chats

Features that might be added

Of course, work is never complete, that's why I completed a small list of features that might be added to later versions of the project.

  • SSL support for the WebSocket server
  • Translation for index.php
  • Multi Channel support
  • Emoticon support
  • Backend cms ?
  • More detailed documentation

Installation

Have a look at the installation & configuration page.

Using SSL or

Using SSL

Setting up Apache or Nginx as a proxy

[Setting up a proxy](Proxy Setup)

The protocol

For more information see the protocol page.

Author

This package is created and maintained by Johnny Mast. In my 28 years of development, I have had many roles in my name. System administrator / Web developer and since 2018 I can add Game Developer to that list.