OPIChat is a simple IRC-like chat software. It is written in C and aims to be a simple, secured and easy to use. The project includes a client and a server.
-
Make sure to have the following dependencies:
- (GNU) make
- gcc
-
Clone the repository
-
Build the project using the
makecommand. -
Both of client and server are where in the root of the repository.
The server executable is called opichat_server.
To start the server, you must run the following command:
./opichat_server <ip> <port>Where <ip> is the IP address of the server and <port> is the port where clients will connect to.
Note that you can use
localhostor127.0.0.1as a loopback<ip>address to start the server.
No action is required for the server
The client executable is called opichat_client.
To start the client, you must run the following command:
./opichat_client <ip> <port>Where <ip> is the IP address of the server and <port> is the port where the server is listening to.
When the client launchs, you will deal with the command prompt.
Command:
At this step, you must enter a valid command name (as described in the protocol).
If you enter a valid command, you will have one or both of these 2 following prompts:
Parameters At this step, the client program estimated that you entered a command which requires parameters.
Parameters:
To enter a parameter as a key/value pair, you must type:
<key>=<value>
Where <key> and <value> are respectively the key and the value of the parameter.
Then press ENTER.
The parameters prompt will always asks you key/value pairs forever until you press ENTER and nothing else.
Payload At this step, you must enter the content of the payload. Unless Parameters, no specific format is applied here.
Payload:
Some command (like
SEND-DMorBROADCAST) will loop on the payload prompt forever. To exit the payload prompt, type/quit.
If you are interested in the architecture of the project, check ARCH.md.
Also, if you want a detailled documentation about the communication protocol, read PROTOCOL.md.