protocols/ircv3/README.md

Mon, 25 Mar 2024 21:43:28 -0500

author
Gary Kramlich <grim@reaperworld.com>
date
Mon, 25 Mar 2024 21:43:28 -0500
changeset 42652
225762d4e206
parent 42056
libpurple/protocols/ircv3/README.md@ced07483f66a
permissions
-rw-r--r--

Move the Demo and IRCv3 protocols to the new protocols directory

Testing Done:
Ran `meson dist` and `ninja turtles`

Reviewed at https://reviews.imfreedom.org/r/3047/

42041
b9ef2851fdc0 IRCv3: Add a basic README.md
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
1 # IRCv3
b9ef2851fdc0 IRCv3: Add a basic README.md
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
2
b9ef2851fdc0 IRCv3: Add a basic README.md
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
3 This is a brand new from-scratch protocol plugin which is the first protocol
b9ef2851fdc0 IRCv3: Add a basic README.md
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
4 plugin to be 100% code reviewed. It uses regex to tokenize messages.
b9ef2851fdc0 IRCv3: Add a basic README.md
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
5
b9ef2851fdc0 IRCv3: Add a basic README.md
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
6 We are intending for it to be subclass-able so other networks like Twitch.tv can
b9ef2851fdc0 IRCv3: Add a basic README.md
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
7 be supported but we're not quite there yet.
b9ef2851fdc0 IRCv3: Add a basic README.md
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
8
b9ef2851fdc0 IRCv3: Add a basic README.md
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
9 We also are intending to support subclassing in other languages but we've run
b9ef2851fdc0 IRCv3: Add a basic README.md
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
10 into some issues with dynamic GObject types and GObject introspection that have
b9ef2851fdc0 IRCv3: Add a basic README.md
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
11 slowed us down.
b9ef2851fdc0 IRCv3: Add a basic README.md
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
12
b9ef2851fdc0 IRCv3: Add a basic README.md
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
13 ## Capability Support
b9ef2851fdc0 IRCv3: Add a basic README.md
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
14
b9ef2851fdc0 IRCv3: Add a basic README.md
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
15 This is a list of capabilities that we currently support. We'll do our best to
b9ef2851fdc0 IRCv3: Add a basic README.md
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
16 keep this list up to date, but if you notice we've missed something please let
b9ef2851fdc0 IRCv3: Add a basic README.md
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
17 us know!
b9ef2851fdc0 IRCv3: Add a basic README.md
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
18
42055
2f5bbcc91854 IRCv3: Negotiate the message-tags capability and make sure our regex matches the BNF
Gary Kramlich <grim@reaperworld.com>
parents: 42041
diff changeset
19 * cap-notify
42041
b9ef2851fdc0 IRCv3: Add a basic README.md
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
20 * sasl (right now just PLAIN works)
42055
2f5bbcc91854 IRCv3: Negotiate the message-tags capability and make sure our regex matches the BNF
Gary Kramlich <grim@reaperworld.com>
parents: 42041
diff changeset
21 * message-tags
42056
ced07483f66a IRCv3: Add support for the msgid specification
Gary Kramlich <grim@reaperworld.com>
parents: 42055
diff changeset
22 * msgid

mercurial