Parsee/README.MD
LDA 6b0f08c49e [ADD/WIP] One-way chatstates, capabilities
No avatarwerk today because avatars are an absolute sore.
2024-07-02 02:21:31 +02:00

41 lines
1.4 KiB
Markdown

# Parsee - the jealous XMPP<=>Matrix bridge
Parsee is a Matrix<=>XMPP bridge written in C99, with Cytoplasm, similar to Bifrost,
but it is NOT a drop-in replacment.
## Why?
### Naming
The name 'Parsee' is actually a reference to [Parsee Mizuhashi](https://en.touhouwiki.net/wiki/Parsee_Mizuhashi), a
"*bridge* princess".
### Reasoning (personal to LDA)
I hate Bifrost. I also wanted to dip my toes in XMPP, XML, and bridges a bit. Also, as a sister project to KappaChat,
this means that I can integrate Parsee with KappaChat however I wish it to be, which allows me to mess around with a
codebase I'm already familiar with.
### "Why not just use Matrix lol"
### "Why not just use XMPP lol"
These two having the same answer should be enough information. Also can I *just* have fun?
~~Also dependency bad.~~
## BUILDING
```sh
$ make # This generates a 'parsee' executable.
$
```
### DEPENDENCIES
Parsee tries to avoid dependencies aside from [Cytoplasm](https://git.telodendria.io/Telodendria/Cytoplasm).
## RUNNING
TODO
## DOCS
TODO
## TODOS
- Look at XEPS-TBD.TXT for XEPs to be done
- Achievements
### Why?
> "[...] and it [BoVeX] has an achievement system, because another thing I don't like is when software will not acknowledge that you've reached an obscure error state, essentially outsmarting it."
- Tom Murphy VII