public-mirrors/reflectionircd
1
0
Fork 0
mirror of https://git.sr.ht/~emerson/reflectionircd synced 2025-08-05 16:59:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add info to README

Browse source
This commit is contained in:
emerson 2022-02-02 12:00:51 -05:00
parent 600c1cec8b
commit 8c48d095e5
1 changed files with 17 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -41,29 +41,30 @@ Note that there are no PMs, because Matrix doesn't differentiate between DMs and
| Name | M->I | I->M | Notes |
| ---- | :--: | :--: | ----- |
| text, notice, emote messages | ✅ | ✅ | Highlighting users with their IRC nick doesn't translate into highlighting their Matrix user yet |
| text, notice, emote messages | ✅ | ✅ | Highlighting users with their IRC nick doesn't translate into highlighting their Matrix user [#23](https://todo.sr.ht/~emerson/reflectionircd/23) |
| image, file, audio, video messages | 🟨 | ❌ | Show up as links on IRC |
| Channel joins | ✅ | ❌ ||
| Channel joins | ✅ | ❌ | [#1](https://todo.sr.ht/~emerson/reflectionircd/1) |
| Channel parts | ✅ | ✅ ||
| Channel kicks | ✅ | ✅ ||
| Channel bans | 🟨 | ❌ | Single-user bans show up on IRC as kicks, there's no banlist yet |
| Channel bans | 🟨 | ❌ | [#24](https://todo.sr.ht/~emerson/reflectionircd/24) Single-user bans show up on IRC as kicks, there's no banlist yet |
| Channel invites | ✅ | ✅ ||
| Channel topics | ✅ | ✅ ||
| Channel powers | ✅ | ❌ ||
| Channel lists/searching | ❌ | ❌ ||
| Encrypted rooms | ❌ | ❌ ||
| Rich text | ❌ | ❌ ||
| Presence | ❌ | ❌ | Note that not all homeservers have presence enabled |
| Channel renaming <small>(IRCv3)</small> | 🟨 | ❌ | Only when the canonical alias changes |
| Channel powers | ✅ | ❌ | [#6](https://todo.sr.ht/~emerson/reflectionircd/6) |
| Channel lists/searching | ❌ | ❌ | [#30](https://todo.sr.ht/~emerson/reflectionircd/30) |
| Encrypted rooms | ❌ | ❌ | [#20](https://todo.sr.ht/~emerson/reflectionircd/20) |
| Rich text | ❌ | ❌ | [#31](https://todo.sr.ht/~emerson/reflectionircd/31) |
| Presence | ❌ | ❌ | [#25](https://todo.sr.ht/~emerson/reflectionircd/25) Note that not all homeservers have presence enabled |
| Channel renaming <small>(IRCv3)</small> | 🟨 | ❌ | [#29](https://todo.sr.ht/~emerson/reflectionircd/29) [#16](https://todo.sr.ht/~emerson/reflectionircd/16) Only when the canonical alias changes |
| Message replies <small>(IRCv3)</small> | ✅ | ✅ | Clients without support will still receive the reply message, but it won't be marked as a reply |
| Message reactions <small>(IRCv3)</small> | 🟨 | 🟨 | Can't undo reactions yet |
| Message reactions <small>(IRCv3)</small> | ✅ | ✅ | Can't undo reactions yet |
| Extended invites <small>(IRCv3)</small> | ✅ | ✅ ||
| Chat history <small>(IRCv3)</small> | ❌ | ❌ ||
| Multiline messages <small>(IRCv3)</small> | ❌ | ❌ ||
| Global display names <small>(IRCv3)</small> | ❌ | ❌ ||
| Per-room display names <small>(IRCv3)</small> | ❌ | ❌ ||
| Message editing <small>(IRCv3)</small> | ❌ | ❌ ||
| Message deletion <small>(IRCv3)</small> | ❌ | ❌ ||
| Typing notifications <small>(IRCv3)</small> | ❌ | ❌ | [#26](https://todo.sr.ht/~emerson/reflectionircd/26) |
| Chat history <small>(IRCv3)</small> | ❌ | ❌ | [#9](https://todo.sr.ht/~emerson/reflectionircd/9) |
| Multiline messages <small>(IRCv3)</small> | ❌ | ❌ | [#10](https://todo.sr.ht/~emerson/reflectionircd/10) |
| Global display names <small>(IRCv3)</small> | ❌ | ❌ | [#11](https://todo.sr.ht/~emerson/reflectionircd/11) |
| Per-room display names <small>(IRCv3)</small> | ❌ | ❌ | [#13](https://todo.sr.ht/~emerson/reflectionircd/13) |
| Message editing <small>(IRCv3)</small> | ❌ | ❌ | [#14](https://todo.sr.ht/~emerson/reflectionircd/14) |
| Message deletion/redaction <small>(IRCv3)</small> | ❌ | ❌ | [#14](https://todo.sr.ht/~emerson/reflectionircd/14) |
## Running
Copy `config.example.json` to `config.json`, edit the values if needed, then `npm run build` and then `node reflection.js` to start it