ModuleH elpeг - Read the Docs

Module𝐻 𝑒𝑙𝑝𝑒𝑟
Version latest-0.1.0-24-geabd891
06 February 2017
Table des matières
1
Prerequisites
3
2
Configuration
2.1 Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5
5
5
3
Usage
3.1 Provided commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3.2 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7
7
7
i
ii
Module𝐻 𝑒𝑙𝑝𝑒𝑟, 𝑉 𝑒𝑟𝑠𝑖𝑜𝑛𝑙𝑎𝑡𝑒𝑠𝑡 − 0.1.0 − 24 − 𝑔𝑒𝑎𝑏𝑑891
Erebot_Module_Helper is a module for Erebot that provides help on other modules and commands.
Contents :
Table des matières
1
Module𝐻 𝑒𝑙𝑝𝑒𝑟, 𝑉 𝑒𝑟𝑠𝑖𝑜𝑛𝑙𝑎𝑡𝑒𝑠𝑡 − 0.1.0 − 24 − 𝑔𝑒𝑎𝑏𝑑891
2
Table des matières
CHAPITRE 1
Prerequisites
The following dependencies must be installed in order for this module to work properly :
— PHP >= 5.2.2
— Erebot (some specific version may be required depending on this module’s version)
— Erebot_API (some specific version may be required depending on this module’s version)
Erebot (core) adds its own set of prerequisites which usually superseed those.
3
Module𝐻 𝑒𝑙𝑝𝑒𝑟, 𝑉 𝑒𝑟𝑠𝑖𝑜𝑛𝑙𝑎𝑡𝑒𝑠𝑡 − 0.1.0 − 24 − 𝑔𝑒𝑎𝑏𝑑891
4
Chapitre 1. Prerequisites
CHAPITRE 2
Configuration
2.1 Options
This module provides only one configuration option.
Tableau 2.1 – Options for Module_Helper
Name
trigger
Type
string
Default value
“help”
Description
The command to use to get help on other modules and commands.
2.2 Example
The recommended way to use this module is to have it loaded at the general configuration level and to disable it only
for specific networks, if needed.
The listing below shows how to change this module’s trigger so that help becomes available using the command !helpme (instead of !help).
<?xml version=''1.0''?>
<configuration
xmlns=''http://localhost/Erebot/''
version=''...''
language=''fr-FR''
timezone=''Europe/Paris''
commands-prefix=''!''>
<modules>
<!-- Other modules ignored for clarity. -->
<!-- We only change the default command name. -->
<module name=''Module_Helper``>
<param name=''trigger'' value=''helpme'' />
</module>
</modules>
<!-- Rest of the configuration (networks, etc.) -->
</configuration>
5
Module𝐻 𝑒𝑙𝑝𝑒𝑟, 𝑉 𝑒𝑟𝑠𝑖𝑜𝑛𝑙𝑎𝑡𝑒𝑠𝑡 − 0.1.0 − 24 − 𝑔𝑒𝑎𝑏𝑑891
6
Chapitre 2. Configuration
CHAPITRE 3
Usage
This section assumes default values are used for all triggers. Please refer to configuration options for more information
on how to customize triggers.
3.1 Provided commands
This module provides the following commands :
Tableau 3.1 – Commands provided by Module_Helper
Command
!help
!help Module
!help command
!help
Erebot_Module_Helper
!help help
Description
Gives a brief summary of usage.
Retrieves help on module Module. The name of the module MUST start with an
uppercase letter.
Retrieves help on command command. The command’s name MAY NOT start
with an uppercase letter.
Displays all available modules.
Same as if !help had been used.
3.2 Examples
The listing below shows different sessions where commands have been used to get help on other modules and commands, in the same order as in the array above.
23:51:23 <@Clicky> !help
23:51:24 < Erebot> Usage : "!help <Module> [commande]" ou "!help <commande>". Fournit de l'aide sur u
Erebot_Module_Helper" pour voir la liste des modules actuellement chargés.
23:53:35 <@Clicky> !help Erebot_Module_Roulette
23:53:35 < Erebot> Fournit la commande !roulette qui vous fait jouer à la Roulette Russe.
23:53:43 <@Clicky> !help roulette
23:53:43 < Erebot> Usage : !roulette. Appuie sur la gachette du pistolet de la Roulette Russe.
23:53:07 <@Clicky> !help Erebot_Module_Helper
23:53:07 < Erebot> Usage : "!help <Module> [commande]". Les noms de modules doivent commencer par une
Les modules suivants sont chargés : Erebot_Module_AutoJoin, Erebot_Module_AZ, Ereb
7
Module𝐻 𝑒𝑙𝑝𝑒𝑟, 𝑉 𝑒𝑟𝑠𝑖𝑜𝑛𝑙𝑎𝑡𝑒𝑠𝑡 − 0.1.0 − 24 − 𝑔𝑒𝑎𝑏𝑑891
Erebot_Module_AutoConnect, Erebot_Module_Countdown, Erebot_Module_Helper, Erebot_M
23:53:08 < Erebot> Erebot_Module_GoF, Erebot_Module_IrcConnector, Erebot_Module_IrcTracker, Erebot_Mo
Erebot_Module_PhpFilter, Erebot_Module_PingReply, Erebot_Module_RateLimiter, Erebo
Erebot_Module_ServerCapabilities, Erebot_Module_TV, Erebot_Module_Uno, Erebot_Modu
23:53:09 < Erebot> Erebot_Module_Wordlists.
23:54:09 <@Clicky> !help help
23:54:09 < Erebot> Usage : "!help <Module> [commande]" ou "!help <commande>". Fournit de l'aide sur u
Erebot_Module_Helper" pour voir la liste des modules actuellement chargés.
Current status on http://travis-ci.org/ :
8
Chapitre 3. Usage