Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-23 02:49:27 +01:00
Code Issues Projects Releases Wiki Activity
833af36b08
Limnoria/plugins/NickAuth
History
Valentin Lorentz 833af36b08 all plugins: auto-generate READMEs 
Starting with this commit, there should be no "original" text
in READMEs.
Instead, the entire text should be in docstrings, and READMEs
should be automatically generated from these docstrings.

Motivation:

* The same help is available both via IRC and in the README
  (although the README can be more detailed, as only the first
  paragraph will be shown on IRC)
* This will allow auto-generating plugin help on docs.limnoria.net
  using the same content as the README, as it's sourced from the
  docstrings

Additionally, this converts all READMEs from Markdown to ReST,
because the documentation already uses ReST, and other docstrings
in the codebase are in ReST for this reason.
2021-04-05 17:42:31 +02:00
..
local NickAuth: First commit. 2012-11-03 23:06:57 +01:00
locales Fix msgfmt warnings. 2020-03-26 22:10:28 +01:00
__init__.py Use importlib instead of imp. 2020-01-26 12:00:08 +01:00
config.py Fix neutral pronouns. 2014-04-11 21:56:42 +00:00
messages.pot Squashed commit of the following: 2014-12-20 14:37:27 +01:00
plugin.py all plugins: auto-generate READMEs 2021-04-05 17:42:31 +02:00
README.rst all plugins: auto-generate READMEs 2021-04-05 17:42:31 +02:00
test.py NickAuth: Add WHOX test. 2020-06-12 19:29:08 +02:00

README.rst

Documentation for the NickAuth plugin for Supybot

Purpose

Support authentication based on nicks and network services.

Usage

This plugin allows users to use their network services account to authenticate to the bot.

They first have to use @nickauth nick add <the nick> while being identified to the bot and then use @auth when they want to identify to the bot.

Commands

auth takes no argument

Tries to authenticate you using network services. If you get no reply, it means you are not authenticated to the network services.

nick add [<network>] <user> <nick>

Add <nick> to the list of nicks owned by the <user> on the <network>. You have to register this nick to the network services to be authenticated. <network> defaults to the current network.

nick list [<network>] [<user>]

Lists nicks of the <user> on the network. <network> defaults to the current network.

nick remove [<network>] <user> <nick>

Remove <nick> from the list of nicks owned by the <user> on the <network>. <network> defaults to the current network.

Configuration

supybot.plugins.NickAuth.public

This config variable defaults to "True", is not network-specific, and is not channel-specific.

Determines whether this plugin is publicly visible.