fedserv/echo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

List every pseudo-client as a first-class service in the README

Browse source 
They were appended to the module list as a bare afterthought; give each
service its own line and one-line role, formatted identically to the
others. The code already treated them as equals — same Service trait,
same store access, same registration; the docs now match.
This commit is contained in:
Jean Chevronnet 2026-07-14 15:00:18 +00:00
parent 92383cee0e
commit de11939f2e
No known key found for this signature in database
1 changed files with 15 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -26,12 +26,21 @@ workspace, each depending only on the `fedserv-api` SDK crate.
`Protocol` impl maps raw server-to-server lines to and from the normalized `Protocol` impl maps raw server-to-server lines to and from the normalized
model, so the engine never touches a raw line and a new ircd is one new crate model, so the engine never touches a raw line and a new ircd is one new crate
under `modules/protocol/`. under `modules/protocol/`.
- **`modules/nickserv/`, `modules/chanserv/`, `modules/botserv/`, - the pseudo-clients, each a crate implementing `Service` and reaching the
`modules/memoserv/`, `modules/statserv/`, `modules/hostserv/`, `modules/operserv/`** network only through the `Store`/`NetView` traits:
and diceserv, infoserv, reportserv, groupserv, chanfix, helpserv — the - **`modules/nickserv/`** — account registration, identification, grouped nicks.
pseudo-clients, each a crate implementing `Service`. OperServ holds the - **`modules/chanserv/`** — channel registration, access lists, mode-lock.
network-operator tools (AKILL network bans to start); the rest follow the same - **`modules/botserv/`** — per-channel service bots, fantasy commands, kickers.
shape. - **`modules/hostserv/`** — virtual hosts, self-serve and operator-approved.
- **`modules/memoserv/`** — messages to accounts, delivered whether online or not.
- **`modules/operserv/`** — network-operator tools: akills, DEFCON, jupes, sessions, log search.
- **`modules/statserv/`** — network and channel statistics.
- **`modules/groupserv/`** — user groups (`!group`) whose members inherit channel access.
- **`modules/chanfix/`** — reops an opless channel from accumulated op-time.
- **`modules/helpserv/`** — a help-desk ticket queue worked by operators.
- **`modules/infoserv/`** — network bulletins shown on connect and on login.
- **`modules/reportserv/`** — user abuse reports feeding the operator audit trail.
- **`modules/diceserv/`** — dice rolls and math for tabletop games.
Writing your own module — a service or a new ircd protocol — is documented in Writing your own module — a service or a new ircd protocol — is documented in
[MODULES.md](MODULES.md); `modules/example/` is a minimal service to copy from. [MODULES.md](MODULES.md); `modules/example/` is a minimal service to copy from.