39 lines
1.1 KiB
Markdown
39 lines
1.1 KiB
Markdown
# ChatAPP
|
|
An instant messaging app using Java and the UDP protocol.
|
|
|
|
## How to run
|
|
|
|
> [!WARNING]
|
|
> As of now, the app rely on ANSI escape character, thus not available on Windows.
|
|
> However, this feature is under development.
|
|
|
|
You can run the app by launching the `ChatApp` class. This will create the server (port `6665`) and a first client,
|
|
(creating by the way a room (`101`)).
|
|
|
|
You can then create more clients by launching the `Client` class. It will connect to the server
|
|
(be sure you launched it first) on the default port `6665`.
|
|
|
|
## How to use
|
|
As soon as you launch a client, you will be prompted to enter your name. You will then be in the lobby. From here you
|
|
can join whatever room that is created, and you will be able to chat with the other clients in the room.
|
|
You will also be able to create a new room.
|
|
|
|
## Commands
|
|
> [!TIP]
|
|
> The commands can be found by typing `/help` in the chat, in the lobby or in any room.
|
|
|
|
> [!NOTE]
|
|
> All the commands are prefixed by `/`.
|
|
|
|
- /createRoom *roomName*
|
|
- /listRooms
|
|
- /joinRoom *roomName*
|
|
- /leaveRoom
|
|
- /help
|
|
|
|
> [!NOTE]
|
|
> There are some aliases for the commands:
|
|
> - /create
|
|
> - /list
|
|
> - /join
|
|
> - /leave |