Skip to content

Latest commit

 

History

History
108 lines (83 loc) · 5.22 KB

README.md

File metadata and controls

108 lines (83 loc) · 5.22 KB
Raw

IRC Definition Lists

These are IRC definition lists. Things like lists of IRC numerics, channel modes, user modes and other things that are implemented in various bits of IRC software.

Base data was taken from alien.net.au, converted to YAML via the tools in the _legacy_data/ folder and adapted for use with the Jekyll static site generator (used by Github Pages).

Pull requests to correct or update these lists are welcomed.

Online Site: https://defs.ircdocs.horse/

Available Pages

Repo Structure

Given that this is a Jekyll site, there's a very particular way this repo is laid out, which I'll go through here:

  • _data/ - contains the data files, which make up our tables;
    • validation/ - contains validation files, which yamltypes uses to validate the data files;
    • chanmembers.yaml - data for Channel Member Prefixes;
    • chanmodes.yaml - data for Channel Modes;
    • chantypes.yaml - data for Channel Type Prefixes;
    • clientcaps.yaml - data for Client Capabilities;
    • ctcp.yaml - data for CTCP Messages;
    • extbans.yaml - data for Extended Bans (banning/excluding by account, etc.);
    • formatting.yaml - data for Formatting Characters support in different clients;
    • isupport.yaml - data for RPL_ISUPPORT Tokens;
    • numerics.yaml - data for Numerics;
    • selfmessage.yaml - data for self-message support in different clients;
    • servermodes.yaml - data for Server Modes;
    • snomasks.yaml - data for Server Notice Masks;
    • stats.yaml - data for STATS Characters;
    • tags.yaml - data for Message Tags;
    • usermodes.yaml - data for User Modes;
  • _includes/ - contains Jekyll HTML includes;
    • table.html - this is the main data-table printer, outputs based on the content of the YAML data files;
  • _layouts/ - contains Jekyll HTML layouts;
  • _legacy_data/ - contains the original data files from alient.net.au, which we used, along with our original conversion script;
  • defs/ - contains the front-end HTML for each definitions page;
  • discover_numerics - script to discover numerics for various IRC servers from their source repo.

YAML Structure

To interpret YAML data files:

//TODO

License

The following license information is from the alien.net.au website:

You may be interested in using the definition files in your own project;
There are no license restrictions, other than to retain the copyright information.

Copyright information is listed in the specific converted spec files in the _data/ folder (as in the original .def files downloaded from alien.net.au).

Discovering Numerics

I've written a script called discover_numerics that helps me search for numerics that aren't currently listed in our list. It's helpful to use this to search new releases of ircd-hybrid, inspircd, charybdis, unrealircd, etc.

It requires the pyyaml and docopt python modules. To install the required modules, install python3-pip, then run:

pip3 install pyyaml docopt

Usage Examples

Searching a typical numeric.h file

Searching a single numeric.h file, such as in ircd-hybrid, charybdis, unrealircd, etc:

./discover_numerics search /path/to/ircd/include/numerics.h

Searching InspIRCd

Because inspircd scatters its numeric definitions all over its source directory, you can't just search a single file. Because of this, you need to search multiple files in the directory like this:

find /path/to/inspircd/ -type f | xargs ./discover_numerics search

This also does not find every numeric, thanks to how inspircd likes to use numerics directly rather than #define them.

Numerics will output as lines like this, which makes it simple to grep through the source directory to discover the format and usage of these numerics:

Could not find numeric: RPL_STATSCLONE (225)
Could not find numeric: RPL_USINGSSL (275)
Could not find numeric: RPL_EXEMPTLIST (348)
Could not find numeric: RPL_ENDOFEXEMPTLIST (349)
Could not find numeric: RPL_RWHOREPLY (354)
Could not find numeric: ERR_TARGETTOFAST (439)
Could not find numeric: ERR_NOSSL (488)
Could not find numeric: ERR_NOSHAREDCHAN (493)
Could not find numeric: ERR_LAST_ERR_MSG (504)