Modules

Xtheme IRC Services Modules

This is intended to provide more information about modules, their intended use and more! (Please bear with us, this page is still under construction)

Core Modules
Protocol Modules (Select based on the ircd your network is using)
modules/protocol/asuka Asuka 1.2.1 or later
modules/protocol/bahamut Bahamut 1.8.x
modules/protocol/charybdis Charybdis IRCd
modules/protocol/dreamforge DreamForge 4.6.7 or later
modules/protocol/inspircd InspIRCd 2.0
modules/protocol/ratbox ircd-ratbox 2.0 and later
modules/protocol/ircnet IRCNet ircd (ircd 2.11)
modules/protocol/ircd-seven ircd-seven
modules/protocol/nefarious Nefarious IRCu 0.4.0 or later
modules/protocol/ngircd ngIRCd 19 or later experimental
modules/protocol/unreal Unreal 3.2.x
modules/protocol/unreal4 Unreal 4.x

Protocol Mixins (These should be used when you do not have/want to have certain features on your network)
modules/protocol/mixin_nohalfops Disable halfops
modules/protocol/mixin_noholdnick Disable holdnick (use enforcer clients)
modules/protocol/mixin_noprotect Disable "protect" mode on channels
modules/protocol/mixin_noowner Disable "owner" mode on channels

Database backend file (What type of database should Atheme use - only 1 can be used)
modules/backend/flatfile Atheme 0.1 flatfile database format
modules/backend/opensex Open Services Exchange database format recommended

Crypto Module (Encrypts passwords in your services database)
modules/crypto/pbkdf2v2 PBKDF2 cryptography (new)
modules/crypto/pbkdf2 PBKDF2 cryptography (old)
modules/crypto/posix POSIX-style crypt(3)
modules/crypto/ircservices IRCServices (also Anope etc) compatibility
modules/crypto/rawmd5 Raw MD5 (Anope compatibility)
modules/crypto/rawsha1 Raw SHA1 (Anope compatibility)
(The ircservices, rawmd5 and rawsha1 modules are only recommended for use with a database converted from other services with password encryption.)
To transition between crypto schemes, load the preferred scheme first and as users login, they will be migrated to the new preferred scheme.
Example
loadmodule "modules/crypto/pbkdf2v2";
loadmodule "modules/crypto/pbkdf2";
loadmodule "modules/crypto/posix";
loadmodule "modules/crypto/ircservices";
The rawsha1 and pbkdf2/pbkdf2v2 crypto methods require OpenSSL.

External Authentication Module
modules/auth/ldap LDAP

NickServ Modules
modules/nickserv/main Core NickServ components
modules/nickserv/access Nickname access lists (hostmasks) NickServ:ACCESS
modules/nickserv/badmail Bad email address blocking
modules/nickserv/cert CertFP fingerprint management NickServ:CERT
modules/nickserv/cracklib CrackLib password validation (Requires CrackLid be installed on your system)
modules/nickserv/drop NickServ:DROP command
modules/nickserv/enforce Nickname enforcement
modules/nickserv/ghost NickServ:GHOST command
modules/nickserv/group GROUP and UNGROUP commands
modules/nickserv/help HELP command
modules/nickserv/hold Nickname expiry override NickServ:HOLD
modules/nickserv/identify NickServ:IDENTIFY command
modules/nickserv/info NickServ:INFO command
modules/nickserv/info_lastquit Last quit message in INFO
modules/nickserv/list NickServ:LIST command
modules/nickserv/listmail NickServ:LISTMAIL command
modules/nickserv/listownmail NickServ:LISTOWNMAIL command
modules/nickserv/login NickServ:LOGIN command (for no_nick_ownership)
modules/nickserv/logout NickServ:LOGOUT command
modules/nickserv/mark NickServ:MARK command
modules/nickserv/freeze NickServ:FREEZE command
modules/nickserv/listchans NickServ:LISTCHANS command
modules/nickserv/listgroups NickServ:LISTGROUPS command
modules/nickserv/register NickServ:REGISTER command
modules/nickserv/regnolimit Bypass registration limits NickServ:REGNOLIMIT
modules/nickserv/resetpass Password reset NickServ:RESETPASS
modules/nickserv/restrict NickServ:RESTRICT command
modules/nickserv/return Password return NickServ:RETURN
modules/nickserv/sendpass Password retrieval NickServ:SENDPASS
modules/nickserv/sendpass_user Password retrieval allowed to normal users
modules/nickserv/set_core SET command core
modules/nickserv/set_accountname Change primary nickname NickServ:SET:ACCOUNTNAME
modules/nickserv/set_email NickServ:SET:EMAIL command
modules/nickserv/set_emailmemos NickServ:SET:EMAILMEMOS command
modules/nickserv/set_enforcetime NickServ:SET:ENFORCETIME command
modules/nickserv/set_hidemail NickServ:SET:HIDEMAIL command
modules/nickserv/set_language NickServ:SET:LANGUAGE command
modules/nickserv/set_nevergroup NickServ:SET:NEVERGROUP command
modules/nickserv/set_neverop NickServ:SET:NEVEROP command
modules/nickserv/set_nogreet NickServ:SET:NOGREET command
modules/nickserv/set_nomemo NickServ:SET:NOMEMO command
modules/nickserv/set_noop NickServ:SET:NOOP command
modules/nickserv/set_password NickServ:SET:PASSWORD command
modules/nickserv/set_privmsg PRIVMSG instead of NOTICE NickServ:SET:PRIVMSG
modules/nickserv/set_private Account info hiding NickServ:SET:PRIVATE
modules/nickserv/set_property NickServ:SET:PROPERTY command
modules/nickserv/set_pubkey NickServ:SET:PUBKEY command
modules/nickserv/set_quietchg NickServ:SET:QUIETCHG command
modules/nickserv/setpass Password retrieval uses code (SETPASS cmd)
modules/nickserv/status NickServ:STATUS command
modules/nickserv/taxonomy Nickname metadata viewer NickServ:TAXONOMY
modules/nickserv/vacation NickServ:VACATION command
modules/nickserv/verify NickServ:VERIFY command
modules/nickserv/vhost NickServ:VHOST command

ChanServ Modules
Please note that ChanServ requires an authentication service, either NickServ or UserServ will do.
modules/chanserv/main Core components
modules/chanserv/access ChanServ:ACCESS command (simplified ACL editing)
modules/chanserv/akick ChanServ:AKICK command
modules/chanserv/ban ChanServ:BAN / UNBAN commands
modules/chanserv/unban_self UNBAN self only (load ban or this, not both)
modules/chanserv/close ChanServ:CLOSE command
modules/chanserv/clone ChanServ:CLONE command
modules/chanserv/clear ChanServ:CLEAR command
modules/chanserv/clear_akicks CLEAR AKICKS command
modules/chanserv/clear_bans CLEAR BANS command
modules/chanserv/clear_flags CLEAR FLAGS command
modules/chanserv/clear_users CLEAR USERS command
modules/chanserv/count ChanServ:COUNT command
modules/chanserv/drop ChanServ:DROP command
modules/chanserv/fflags Forced flags changes ChanServ:FFLAGS
modules/chanserv/flags ChanServ:FLAGS command
modules/chanserv/ftransfer Forced foundership transfers ChanServ:FTRANSFER
modules/chanserv/getkey ChanServ:GETKEY command
modules/chanserv/halfop ChanServ:HALFOP / DEHALFOP commands
modules/chanserv/help HELP command
modules/chanserv/hold Channel expiry override (ChanServ:HOLD command)
modules/chanserv/info ChanServ:INFO command
modules/chanserv/invite ChanServ:INVITE command
modules/chanserv/kick ChanServ:KICK / ChanServ:KICKBAN commands
modules/chanserv/list ChanServ:LIST command
modules/chanserv/mark ChanServ:MARK command
modules/chanserv/moderate Services Operators must approve registration of channels instead of them being granted automatically. See also: ChanServ:ACTIVATE, ChanServ:REJECT and ChanServ:WAITING
modules/chanserv/op ChanServ:OP / DEOP commands
modules/chanserv/owner ChanServ:OWNER / DEOWNER commands
modules/chanserv/protect ChanServ:PROTECT / DEPROTECT commands
modules/chanserv/quiet ChanServ:QUIET command
modules/chanserv/recover ChanServ:RECOVER command
modules/chanserv/register ChanServ:REGISTER command
modules/chanserv/set_core SET command core
modules/chanserv/set_email [[ChanServ:SET:EMAIL] command
modules/chanserv/set_entrymsg ChanServ:SET:ENTRYMSG command
modules/chanserv/set_fantasy ChanServ:SET:FANTASY command
modules/chanserv/set_gameserv ChanServ:SET:GAMESERV command
modules/chanserv/set_guard ChanServ:SET:GUARD command
modules/chanserv/set_keeptopic ChanServ:SET:KEEPTOPIC command
modules/chanserv/set_limitflags ChanServ:SET:LIMITFLAGS command
modules/chanserv/set_mlock ChanServ:SET:MLOCK command
modules/chanserv/set_prefix ChanServ:SET:PREFIX command
modules/chanserv/set_private Channel info hiding (ChanServ:SET:PRIVATE command)
modules/chanserv/set_property ChanServ:SET:PROPERTY command
modules/chanserv/set_pubacl ChanServ:SET:PUBACL command
modules/chanserv/set_restricted ChanServ:SET:RESTRICTED command
modules/chanserv/set_secure ChanServ:SET:SECURE command
modules/chanserv/set_topiclock ChanServ:SET:TOPICLOCK command
modules/chanserv/set_url ChanServ:SET:URL command
modules/chanserv/set_verbose ChanServ:SET:VERBOSE command
modules/chanserv/status ChanServ:STATUS command
modules/chanserv/sync ChanServ:SYNC command (and automatic ACL syncing)
modules/chanserv/successor_acl Named Successor ACL flag (+S)
modules/chanserv/taxonomy Channel metadata viewer (ChanServ:TAXONOMY command)
modules/chanserv/template ChanServ:TEMPLATE command
modules/chanserv/topic ChanServ:TOPIC and TOPICAPPEND commands
modules/chanserv/voice ChanServ:VOICE / DEVOICE commands
modules/chanserv/why ChanServ:WHY command
modules/chanserv/xop VOP/HOP/AOP/SOP commands (This module provides emulation of the ircservices XOP scheme ONLY. Do not report discrepencies when using native commands to edit channel ACLs. This is intentional.)
modules/chanserv/antiflood Flood protection (This module should be loaded after at least chanserv/quiet if you want the autoquiet feature to work.)

ChanFix Modules
modules/chanfix/main Core components

OperServ Modules
modules/operserv/main Core components
modules/operserv/akill OperServ:AKILL system
modules/operserv/clearchan OperServ:CLEARCHAN command
modules/operserv/clones OperServ:CLONES system
modules/operserv/compare OperServ:COMPARE command
modules/operserv/greplog OperServ:GREPLOG command
modules/operserv/help HELP command
modules/operserv/ignore OperServ:IGNORE system
modules/operserv/identify OperServ:IDENTIFY command
modules/operserv/info OperServ:INFO command
modules/operserv/inject OperServ:INJECT command
modules/operserv/jupe OperServ:JUPE command
modules/operserv/mode OperServ:MODE command
modules/operserv/modinspect OperServ:MODINSPECT command
modules/operserv/modlist OperServ:MODLIST command
modules/operserv/modload OperServ:MODLOAD command
modules/operserv/modreload OperServ:MODRELOAD command
modules/operserv/modunload OperServ:MODUNLOAD command
modules/operserv/noop OperServ:NOOP system
modules/operserv/override Override access (OperServ:OVERRIDE command)
modules/operserv/rakill Regex mass akill (OperServ:RAKILL command)
modules/operserv/raw OperServ:RAW command Taints your support!
modules/operserv/readonly OperServ:READONLY command
modules/operserv/rehash OperServ:REHASH command
modules/operserv/restart [[OperServ:RESTART]] command modules/operserv/rmatchDisplay regex matching ([[OperServ:RMATCH]] command) modules/operserv/rncMost common realnames ([[OperServ:RNC]] command) modules/operserv/rwatch[[OperServ:RWATCH]] system modules/operserv/set**Temporarily** modify config options ([[OperServ:SET]] command) modules/operserv/sgline[[OperServ:SGLINE]] system modules/operserv/shutdown[[OperServ:SHUTDOWN]] command modules/operserv/soperNon-config oper privileges ([[OperServ:SOPER]] command) modules/operserv/specsOper privilege display ([[OperServ:SPECS]] command) modules/operserv/sqline[[OperServ:SQLINE]] system modules/operserv/update[[OperServ:UPDATE]] command _(save databases to disk)_ modules/operserv/uptime`` OperServ:UPTIME command (and information about Services registrations)

MemoServ Modules
modules/memoserv/main Core components
modules/memoserv/help HELP command
modules/memoserv/send MemoServ:SEND command
modules/memoserv/sendops Channel memos (MemoServ:SENDOPS command)
modules/memoserv/sendgroup Group memos (MemoServ:SENDGROUP command)
modules/memoserv/list MemoServ:LIST command
modules/memoserv/read MemoServ:READ command
modules/memoserv/forward MemoServ:FORWARD command
modules/memoserv/delete MemoServ:DELETE command
modules/memoserv/ignore MemoServ:IGNORE command

Global Module
modules/global/main Global Notice Service requires OperServ for full functionality

InfoServ Module
modules/infoserv/main Informational Notice Service

SASL Agent Modules
modules/saslserv/main Core components
modules/saslserv/plain PLAIN mechanism
modules/saslserv/ecdsa-nist256p-challenge ECDSA-NIST256p-CHALLENGE requires SSL
modules/saslserv/authcookie AUTHCOOKIE mechanism (for IRIS)
modules/saslserv/external EXTERNAL mechanism (IRCv3.1+)

GameServ Modules
modules/gameserv/main Core components
modules/gameserv/dice GameServ:DICE / WOD commands
modules/gameserv/eightball GameServ:EIGHTBALL command
modules/gameserv/gamecalc Game-specific dice calculators
modules/gameserv/help HELP commands
modules/gameserv/lottery GameServ:LOTTERY command
modules/gameserv/namegen GameServ:NAMEGEN command
modules/gameserv/rps GameServ:RPS command

RPGServ Modules

** Under construction - more content coming soon! **