Skip to content

Latest commit

 

History

History
67 lines (40 loc) · 1.32 KB

README.md

File metadata and controls

67 lines (40 loc) · 1.32 KB

ChatApp

A Terminal Chat Application that makes you 'shut up' heuheuheu :)

Setup

To clone the repository:

$ git clone https://github.com/alexemanuelol/ChatApp.git

Install the required packages:

$ cd chatapp
$ pip install -r requirements.txt
$ pip install -r src/terminal-text-boxes/requirements.txt

Port-forward the used port on your router by following This guide.

Set the server ip address and port in the config.ini file located here.

Example

The server application

An image of the server application

The client application

An image of the client application

You press <ESC> to exit the client application

Documentation

Package structure

Every package sent between clients and the server is structured like this:

package = {
    "type"          : None,
    "data"          : None,
    "info"          : None,
    "initiator"     : None
}

The different package types:

types = {
    "command"       : 0,
    "message"       : 1,
    "notify"        : 2,
    "error"         : 3
}

Client Commands

Command prefix is set to: !

Commands:

  • setNickname
  • getUsers

Example:

!setNickname Awesom-O