3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-25 04:02:45 +01:00
PyLink/docs/automode.md
James Lu d8768bcb73 Revise docs/automode.md
- The default bot name has been "Automode" instead of "ModeBot" for a while now; reflect that change here
- General edits for flow

[skip ci]
2017-10-04 23:28:27 -07:00

1.5 KiB
Raw Blame History

Automode Tutorial

The Automode plugin was introduced in PyLink 0.9 as a simple mechanism to manage channel access. That said, it is not designed to entirely replace traditional IRC services such as ChanServ.

Starting steps

Upon loading the automode plugin, you should see an Automode service bot connect, using the name that you defined (this guide uses the default, Automode). This service provides the commands used to manage access.

For a list of commands: - /msg Automode help

Adding access to a channel: - /msg Automode setacc #channel [MASK] [MODE LIST] - The mask can be a simple nick!user@host hostmask or any of the extended targets (exttargets) mentioned below. MODE LIST is a string of any prefix modes that you want to set (no leading + needed): e.g. qo, h, or ov.

Removing access from a channel: - /msg Automode delacc #channel [MASK]

Listing access entries on a channel: - /msg Automode listacc #channel

Applying all access entries on a channel (sync): - /msg Automode syncacc #channel

Clearing all access entries on a channel: - /msg Automode clearacc #channel

Supported masks and extended targets

Automode supports any hostmask or PyLink extended target; see the Exttargets Guide for more details.

Permissions

See the Permissions Reference for a list of permissions defined by Automode.

Caveats