From 591af52c78749570c233fba49358e3a207370672 Mon Sep 17 00:00:00 2001 From: random-singularity Date: Fri, 11 Feb 2022 23:29:16 +0530 Subject: [PATCH 1/2] Added Readme --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0b1e8cd --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# **Project Mercurys** + +### _Welcome to Mercurys!_ + +Mercurys is a fun little side-project I'm working on in between my studies. +It's basically a console-based chat application that uses a simple Socket connection to transmit and receive data. +This is my first real programming project, and I have a lot of hopes for this! + +#### Features: + +* Uses a custom encryption-decryption algorithm [developed by myself] +* Uses multi-threading to simultaneously read and write messages to and from the server/client +* Works on a LAN connection [as of yet] + +### How does one use Mercurys? + +Well it's as simple as can be, really. All one needs to do is follow these steps: + +_If you are the host:_ +1. Download the project and open it in your IDE of choice. +2. In the TextServer.java file, set the "hostAddress" variable to your own LAN IP address. + [That should look something like "192.168._.___" +3. Compile and run TextServer.java +4. Now the server has been initialised and will wait for a client socket to connect. +5. Once a client socket has connected to the IP [set by you in step 2], the program will show a confirmatory message. +6. Now you can send and receive messages from the user at the other end of the connection! + +_If you are the client:_ +1. Download the project and open it in your IDE of choice. +2. Compile and run the TextClient.java file, and enter the IP address of the host +3. Once the connection is successful, the program will show a confirmatory message. +4. Now you can send and receive messages from the user at the other end of the connection! + +Once you have finished with your talks and wish to close the connection, both of the users have to enter "-x-" +[without the double quotes] to close the connection and stop the program. + +#### Future Plans: + +I have many new features and upgrades planned for this project, such as: +* Enabling WAN connections +* Upgrading to multi-client chatting, thus making it a sort of chat room +* Enabling media transfer such as images [you can see the work in progress in the "unfinished" folder] +* Adding a GUI and making this a proper chat application + +### Thank you for visiting! From 5dea0b1c3d1ca048133a295a670faaf6bd7f8388 Mon Sep 17 00:00:00 2001 From: random-singularity Date: Fri, 11 Feb 2022 23:33:02 +0530 Subject: [PATCH 2/2] Update README.md --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0b1e8cd..080ca8f 100644 --- a/README.md +++ b/README.md @@ -17,19 +17,20 @@ This is my first real programming project, and I have a lot of hopes for this! Well it's as simple as can be, really. All one needs to do is follow these steps: _If you are the host:_ -1. Download the project and open it in your IDE of choice. -2. In the TextServer.java file, set the "hostAddress" variable to your own LAN IP address. - [That should look something like "192.168._.___" -3. Compile and run TextServer.java -4. Now the server has been initialised and will wait for a client socket to connect. -5. Once a client socket has connected to the IP [set by you in step 2], the program will show a confirmatory message. +1. Download the project and open it in your IDE of choice +2. In the TextServer.java file, set the "hostAddress" variable to your own LAN IP address. + [That should look something like "192.168._.___"] +3. Compile and run TextServer.java [src/com/mercurys/TextServer.java] +4. Now the server has been initialised and will wait for a client socket to connect +5. Once a client socket has connected to the IP [set by you in step 2], the program will show a confirmatory message 6. Now you can send and receive messages from the user at the other end of the connection! _If you are the client:_ -1. Download the project and open it in your IDE of choice. -2. Compile and run the TextClient.java file, and enter the IP address of the host -3. Once the connection is successful, the program will show a confirmatory message. -4. Now you can send and receive messages from the user at the other end of the connection! +1. Download the project and open it in your IDE of choice +2. Compile and run the TextClient.java file [src/com/mercurys/TextClient.java] +3. Enter the IP address of the host when prompted +4. Once the connection is successful, the program will show a confirmatory message +5. Now you can send and receive messages from the user at the other end of the connection! Once you have finished with your talks and wish to close the connection, both of the users have to enter "-x-" [without the double quotes] to close the connection and stop the program.