matrix-3ds-client/README.md

65 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

2023-12-10 15:39:01 +01:00
# Matrix For 3ds
## Roadmap
- [ ] E2EE messaging
- [x] Generating Keys
- [x] Uploading Keys
- [ ] Device Verification
- [ ] QR Code Scan/Display
- [ ] Emoji Display
- [ ] Key Cross-Signing
- [ ] Secure backup
- [ ] Loading
- [ ] Saving (optional)
- [ ] Download device list
- [ ] Olm messages (claimed key, D=>O keysharing)
- [ ] MegOlm Session
- [ ] Basic messaging
- [ ] D<=>D Keysharing
- [ ] Attachment encryption
- [ ] User verification
- [ ] Membership changes
- [ ] Origin Verification
- [ ] Basic UI
- [ ] Room Selection
- [ ] Sending / Receiving basic messages
- [ ] Decoding custom html messages
- [ ] Sending custom html messages (via markdown)
- [ ] Rich Replies (Send/Receive)
- [ ] MXC Attachments (Receive/maybe send)
- [ ] Reaction emotes (Send/Receive)
- [ ] Redact events (& show redacted events)
- [ ] Opening DMs
- [ ] Joining Rooms
- ~~Creating new rooms~~ too complex
- [ ] Presence checks (typing indicator)
- [ ] Read receipts (Send / Receive)
- [ ] Spaces
- [ ] Threading
## How to compile
2023-12-10 15:43:50 +01:00
Ths projects depends on [devkitPro](https://devkitpro.org/wiki/Getting_Started) make sure to install it
2023-12-10 15:39:01 +01:00
2023-12-10 15:43:50 +01:00
You can then add this project's dependencies
2023-12-10 15:39:01 +01:00
```shell
pacman -S 3ds-curl 3ds-jansson 3ds-dev
# Note !! This adds to profile.d, make sure to restart your current terminal
```
### Cloning
```shell
git clone --recurse-submodules https://gitea.ahur.ac/timoreo/matrix-3ds-client.git && cd matrix-3ds-client
```
### Building
```shell
cmake -Bbuild .
cd build
2023-12-10 15:45:29 +01:00
cmake --build . -j$(nproc) --target matrix-3ds-client_3dsx
2023-12-10 15:39:01 +01:00
```
Then grab the created .3dsx file and enjoy ! (.cia files later)