https://github.com/eze-kiel/parrot

A TUI irc-like chat written in go.
https://github.com/eze-kiel/parrot

chat golang tui

Last synced: 3 months ago
JSON representation

A TUI irc-like chat written in go.

• Host: GitHub
• URL: https://github.com/eze-kiel/parrot
• Owner: eze-kiel
• Created: 2020-04-09T21:43:09.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-04-19T00:39:31.000Z (about 5 years ago)
• Last Synced: 2025-01-05T11:43:45.691Z (4 months ago)
• Topics: chat, golang, tui
• Language: Go
• Homepage:
• Size: 51.8 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Parrot :bird: :speech_balloon:

![Licence](https://img.shields.io/badge/License-GPL-brightgreen)

[![Go Report Card](https://goreportcard.com/badge/github.com/eze-kiel/parrot)](https://goreportcard.com/report/github.com/eze-kiel/parrot)

![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)

A TUI irc-like chat written in go.

## Launch

```

options:

    -server

        default: false

        launch parrot as a server

    -addr 

        default: 127.0.0.1:3333

        server mode: address of the server

        client mode: address to connect to

    

    -nick 

        default: guest

        nickname used to connect to a server

    -sound

        default: false

        play a sound a every new message

```

Note that when a client doesn't provide a nickname, a random number will be appended to 'guest' in order to avoid duplicates nicknames.

## Usage

Typical use as a server:

`parrot -server -addr 192.168.0.20:3333`

as a client:

`parrot -addr 192.168.0.20:3333 -nick JohnDoe -sound`

## Commands

```

    /date

        print the date following "Monday, 2006/01/02" format

```

## Roadmap :soon:

* [x] Manage rate limiting

* [x] Add notification sound

* [x] Add a disconnect message

* [x] Embed notification sound in the binary file

* [ ] Add the following commands:

    * `/nick [new nick]` - change the nickname

    * `/who` - list all users

    * `/quit` - quit the room

* [ ] Write tests (in progress...)

* [ ] Add encryption

* [ ] Add basic UTF-8 emojis support