I'm a developer
Build IRC software that works with ConferenceRooms features: protocols, modules and test tools.
Operators only. This section is for IRC operators.
This section is for people who write IRC software: IRC client authors, ircd authors and IRC services authors. If you only want to use ConferenceRooms, you do not need anything here.
What is here
| Page | For | What you get |
|---|---|---|
| What is CR-Avatar? | everybody | The idea, the four moving parts and who does what. |
| CR-Avatar for ircd-hybrid: download, install and test | ircd operators and authors | One page: the download, the install steps, how to check it works, the 74 automated tests (including links, netsplit and TLS), troubleshooting and the license. |
| CR-Avatar for services authors | services authors | What your services must send, and the two details that matter. |
| CR-Avatar for IRC client authors | client authors | A short checklist: detection, the capability, the AVATAR message, display, and being polite. |
The full protocol text, with every rule and test vector, is the CR-AVATAR specification. These pages are the practical companion.
Rules of this section
- Everything here is open: the protocol, the ircd-hybrid module and its tests are published so anybody can implement and check them. The ircd-hybrid module is GPL-2.0-or-later like ircd-hybrid itself; the protocol may be implemented under any license.
- CR-AVATAR is an experimental protocol of ConferenceRooms.org. It is not an IETF or IRCv3 standard.
- Tell us what you build, and what you find unclear: the specification gets fixed when two implementers disagree.
More in I'm a developer
- What is CR-Avatar?A tiny open protocol that lets IRC networks show one emoji next to a nickname.
- CR-Avatar for ircd-hybridOne page: get the open-source module, install it on ircd-hybrid 8.2.47, check it works, and run its 74 automated tests.
- CR-Avatar for services authorsWhat your services must store, send and avoid so ircds can announce avatars.
- CR-Avatar for IRC client authorsA short checklist for showing avatars without flooding anyone.