https://github.com/saphereye/lan-chat

Program to create server/client using TCP/IP for communication over LAN
https://github.com/saphereye/lan-chat

rust tcp

Last synced: 11 months ago
JSON representation

Program to create server/client using TCP/IP for communication over LAN

• Host: GitHub
• URL: https://github.com/saphereye/lan-chat
• Owner: Saphereye
• License: mit
• Created: 2023-09-29T01:30:30.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-26T06:20:40.000Z (almost 2 years ago)
• Last Synced: 2025-07-09T14:54:20.128Z (12 months ago)
• Topics: rust, tcp
• Language: Rust
• Homepage: https://crates.io/crates/lan-chat
• Size: 571 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Lan Chat ![crates.io](https://img.shields.io/crates/v/lan-chat.svg) ![Build Passing](https://github.com/Saphereye/lan-chat/actions/workflows/rust.yml/badge.svg)

![Running example](https://github.com/Saphereye/lan-chat/blob/main/assets/example.png)

Lan Chat is a terminal-based chat application featuring a user-friendly terminal interface.

## Installation

> This requires `cargo` to be installed on your target system. Refer to the [cargo installation guide](https://doc.rust-lang.org/cargo/getting-started/installation.html) if `cargo` is absent on your system.

To install Lan Chat, use the following command:

```bash

cargo install lan-chat --locked

```

This will install the binary. For usage instructions, refer to the [Usage](#usage) section.

Alternatively, the project can be cloned and built using `cargo`.

## Usage

1. To learn about the available commands, run:

```bash

lan-chat --help

```

2. To start the server, run:

```bash

lan-chat -i

```

The output will display the server IP.

3. To connect to the server, use:

```bash

lan-chat -s 

```

You will be prompted to enter a pseudonym. Alternatively, you can set the pseudonym directly using the following command:

```bash

lan-chat -s  -p 

```

4. To insert emojis in the chat, use the following format: `::`. For example is you type `That's funny :laughing:` it will be rendered as `That's funny 😂`.

The supported emojis are as follows

| Command     | Emoji |

|-------------|-------|

| `:smile:`     | 😊     |

| `:laughing:`     | 😂     |

| `:thumbsup:` | 👍     |

| `:cry: `      | 😢     |

For all codes please refer to [Emoji Cheat Sheet](https://github.com/ikatyang/emoji-cheat-sheet/tree/master).