mayday 0.1.0

A multi-messaging-sevice aggregator into an all-in-one application (android's app beeper-like)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

MAYDAY 🗣️✉️
===

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
![GitHub Release](https://img.shields.io/github/v/release/julien-cpsn/mayday?link=https%3A%2F%2Fgithub.com%2FJulien-cpsn%2FmaydayC%2Freleases%2Flatest)
[![Crates.io](https://repology.org/badge/version-for-repo/crates_io/mayday.svg)](https://crates.io/crates/mayday)

A multi-messaging-sevice aggregator into an all-in-one application (android's app beeper-like).
The goal is to extend the supported messaging services by writing and sharing your drivers!

Please fully read [How to use](#how-to-use)

Currently supported:
- [x] loopback
- [x] IRC
- [x] ChatGPT
- [ ] Telegram
- [ ] Messenger
- [ ] Matrix
- [ ] ...add yours! see [contribute](#contribute)

![demo](./demo.gif)

## How to use

The app is splat in two:
- a TUI client which displays messages
- a worker which receive messages

### Install

```shell
cargo install mayday
```

### Compile

```shell
cargo build
```

```shell
cargo build --release
```

### Run

You can replace `mayday` with `cargo run --`

TUI client

```shell
mayday
```

worker

```shell
mayday worker
```

### Using messaging services

After the first usage, mayday will create a config repository which stores messaging service drivers:
- Linux: `/home/$USER/.config/mayday`
- Windows: `C:\Users\$USER\AppData\Roaming\Julien-cpsn\mayday`
- macOS: `Users/$USER/Library/Application Support/com.Julien-cpsn.mayday`

Add your desired messing service configuration file in this folder. Each service template is available in [`example_resources`](./example_resources).

E.g. for IRC
```toml
uuid = "60de91cf-41fc-48ab-893e-b50ff514a706"
discussion_name = "IRC freenode"

[driver]
type = "irc"
channel = "#rust"
server = "chat.freenode.net"
#port = 6697
nickname = "mayday user"
alt_nicks = ["[mayday-user]"]
```

### Cleaning conversations

After the first usage, mayday will create a cache repository which stores messages history:
- Linux: `/home/$USER/.config/mayday`
- Windows: `C:\Users\$USER\AppData\Roaming\Julien-cpsn\mayday`
- macOS: `Users/$USER/Library/Application Support/com.Julien-cpsn.mayday`

Erasing a file will reset the history.

## Contribute

You can develop a new messaging service driver as follows.

1. Copy `loopback.rs` from `src/drivers` to `src/drivers<my_awesome_driver>.rs`
2. Add your driver to the `MessagingDriverConfigs` enum in `src/drivers/mod.rs`
3. Fill with your code. Keep in mind that
    - `active_poll_received_messages` is called by the client (so when you are using the app)
    - `passive_poll_received_messages` is called by the background worker
4. Update this README
5. Add a configuration example in [`example_resources`](./example_resources)
5. Create a pull request!

## Star history

<a href="https://www.star-history.com/#julien-cpsn/mayday&Date">
 <picture>
   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=julien-cpsn/mayday&type=Date&theme=dark" />
   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=julien-cpsn/mayday&type=Date" />
   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=julien-cpsn/mayday&type=Date" />
 </picture>
</a>

## License

The MIT license for this project can be seen [here](./LICENSE)