mirror of
https://github.com/tcsenpai/telnet_retro_chat.git
synced 2025-06-07 03:35:36 +00:00
added hosted details
This commit is contained in:
parent
88ae2655b0
commit
74f17b90ff
43
README.md
43
README.md
@ -2,6 +2,10 @@
|
|||||||
|
|
||||||
A lightweight telnet chat server designed with retro computers in mind. Perfect for your Commodore 64, ZX Spectrum, Amiga, or any other vintage computer with telnet capabilities!
|
A lightweight telnet chat server designed with retro computers in mind. Perfect for your Commodore 64, ZX Spectrum, Amiga, or any other vintage computer with telnet capabilities!
|
||||||
|
|
||||||
|
Hosted instance: [discus.sh:2323](telnet://discus.sh:2323)
|
||||||
|
|
||||||
|
Connect using any telnet client (e.g. `telnet discus.sh 2323` or `atdt discus.sh:2323`)
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Multi-room chat system
|
- Multi-room chat system
|
||||||
@ -35,22 +39,49 @@ This is a fun project for retro computing enthusiasts. Please note:
|
|||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
1. Install Python 3.6 or higher
|
1. Install Python 3.6 or higher and the dependencies:
|
||||||
2. Run the server: python main.py
|
|
||||||
|
```bash
|
||||||
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Run the server:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python main.py
|
||||||
|
```
|
||||||
|
|
||||||
3. Connect using any telnet client
|
3. Connect using any telnet client
|
||||||
4. Default admin credentials: admin/admin (change these!)
|
4. Default admin credentials: admin/admin (change these!)
|
||||||
|
|
||||||
## Commands
|
## Commands
|
||||||
|
|
||||||
Basic commands:
|
Basic commands (available to all, including guests):
|
||||||
|
|
||||||
- /help - Show available commands
|
- /help - Show available commands
|
||||||
- /login - Log into your account
|
- /login - Log into your account
|
||||||
- /register - Create new account
|
- /register - Create new account
|
||||||
- /rooms - List chat rooms
|
- /whoami - Show current username
|
||||||
- /join - Enter a chat room
|
- /quit - Disconnect from server
|
||||||
|
|
||||||
Admin commands available after login with admin privileges.
|
Authenticated user commands:
|
||||||
|
|
||||||
|
- /rooms - List available chat rooms
|
||||||
|
- /join - Enter a chat room
|
||||||
|
- /users - List online users
|
||||||
|
- /broadcast - Send message to all users
|
||||||
|
- /passwd - Change your password
|
||||||
|
|
||||||
|
Admin commands:
|
||||||
|
|
||||||
|
- /op - Give admin privileges to user
|
||||||
|
- /deop - Remove admin privileges from user
|
||||||
|
- /kick - Disconnect a user from the server
|
||||||
|
- /ban - Ban a username from the server
|
||||||
|
- /createroom - Create a new chat room
|
||||||
|
|
||||||
|
Note: Admin commands are only available after logging in with admin privileges.
|
||||||
|
Messages are sent by simply typing without any command prefix.
|
||||||
|
|
||||||
## Community
|
## Community
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user