tchux
| Crates.io | tchux |
| lib.rs | tchux |
| version | 0.1.3 |
| source | src |
| created_at | 2024-09-23 17:35:12.993262 |
| updated_at | 2024-10-15 17:23:37.452725 |
| description | LAN chat app |
| homepage | |
| repository | https://github.com/zochlas/tchux |
| max_upload_size | |
| id | 1384320 |
| size | 38,555 |
Zoclhas (zoclhas)
documentation
README
tchux - the secure LAN chat app
Made to chat covertly over LANs like computer labs
What is tchux?
tchux (pronounced chuks) is a LAN chat app that aims to be secure and easy to set up.
Installation
tchux can be installed via cargo :-
cargo install tchux
Alternatively, download a release of your choice from the various releases and run it without Installation
Usage
tchux instances operate in 2 modes, client mode and server mode.
Client mode is used to connect to tchux servers on the LAN whereas server mode initializes a tchux server on your machine and then pops a client too so you can join in :P
Server mode
tchux server <port> <password>
the default port in 8080 and the default password is IWasTooDumbToSetAPassword
Incase it was not obvious, use a password!
[!NOTE] the server command starts an instance of the client too
Client mode
tchux client <ip:port> <password>
If left blank, the password is assumed to be IWasSoDumbIDidNotSetAPassword
The client supports commands --prefixed with an \.
Currently only 2 exist :-
| Command | Function |
|---|---|
| \exit | exits the client |
| \p | panic-mode |
[!NOTE] panic mode exits the client, deletes a few lines from shell history and clears the screen. :)