aboutsummaryrefslogtreecommitdiff
path: root/readme.md
blob: 1dc56e6c4a0a488c3e531826b85cf68e5f13ac7b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# karlender

A bloated calender software.

## Features

-   flexible condition-based recurring tasks
-   automatic scheduling of tasks, based on priority
-   blazing fast and highly configurable 🚀🚀
-   undocumented

## Protocol

Packets with JSON-serialized instances of either `ServerboundPacket` or `ClientboundPacket` respectively as declared in ([karlcommon/protocol.d.ts](./karlcommon/protocol.d.ts)) are sent over one of the supported methods.

### Unix domain socket

Every line is a packet. Default location for the socket is `/run/user/<uid>/karlender`.

### Websocket

Packets are text messages. Default bind address is `127.0.0.1:18752`.