ModuleA Z - Read the Docs

Module𝐴𝑍
Version latest-0.1.0-24-g0b21bf6
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 − 𝑔0𝑏21𝑏𝑓 6
Erebot_Module_AZ is a module for Erebot that provides a game called “AZ”. A word is randomly selected from a
dictionary. Contestants must find this word. Each time a word is proposed, the range of possible words is reduced.
Contents :
Table des matières
1
Module𝐴 𝑍, 𝑉 𝑒𝑟𝑠𝑖𝑜𝑛𝑙𝑎𝑡𝑒𝑠𝑡 − 0.1.0 − 24 − 𝑔0𝑏21𝑏𝑓 6
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_Module_Wordlists. This module provides several lists of words that the AZ game may use and adds its
own dependencies.
— The pecl.php.net/intl extension.
Erebot (core) adds its own set of prerequisites which usually superseed those.
3
Module𝐴 𝑍, 𝑉 𝑒𝑟𝑠𝑖𝑜𝑛𝑙𝑎𝑡𝑒𝑠𝑡 − 0.1.0 − 24 − 𝑔0𝑏21𝑏𝑓 6
4
Chapitre 1. Prerequisites
CHAPITRE 2
Configuration
2.1 Options
This module provides several configuration options.
Tableau 2.1 – Options for Module_AZ
Name
trigger
Type Default value
string “az”
destring all available
fault_lists
dictionaries
Description
The command to use to start a new AZ game. May be passed a list of
dictionaries.
A list of dictionaries from which the random word will be chosen, separated by
spaces. Used if “az” is called without any argument.
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.
<?xml version=''1.0'' ?>
<configuration
xmlns=''http://localhost/Erebot/''
version=''...''
language=''fr-FR''
timezone=''Europe/Paris''
commands-prefix=''!''>
<modules>
<!-- Other modules ignored for clarity. -->
<!-Configure the module:
- the game will be started using the ''!az''
- the random word to guess will be a Pokémon
from either the first or second generation
-->
<module name=''Module_AZ``>
<param name=''trigger'' value=''az'' />
<param name=''default_list'' value=''pkmn1en
</module>
command.
name
:)
pkmn2en'' />
5
Module𝐴 𝑍, 𝑉 𝑒𝑟𝑠𝑖𝑜𝑛𝑙𝑎𝑡𝑒𝑠𝑡 − 0.1.0 − 24 − 𝑔0𝑏21𝑏𝑓 6
</modules>
</configuration>
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_AZ
Command
!az wordlists...
!az list or !az
lists
!az cancel or !az
end or !az stop
Description
Starts a new game using the given wordlists or the default wordlist if none is
given. Once the game starts, you may propose words directly to the bot.
Displays a list of available wordlists.
Stops the current game.
3.2 Examples
The listing below shows a game (in french) played using Pokemon names from the first generation as the dictionary.
10:51:13 <@Clicky> !az list
10:51:13 < Erebot> Les listes de mots suivantes sont disponibles : english, french, haddock, pkmn1en
11:06:19
11:06:19
11:06:40
11:06:40
11:06:42
11:06:42
11:06:47
11:06:47
11:06:51
11:06:51
11:06:54
11:06:54
11:06:58
11:06:58
<@Clicky>
< Erebot>
<@foobar>
< Erebot>
<@foobar>
< Erebot>
<@foobar>
< Erebot>
<@foobar>
< Erebot>
<@foobar>
< Erebot>
<@foobar>
< Erebot>
!az pkmn1fr
Une nouvelle partie de A-Z commence sur #erebot avec les listes suivantes : pkmn1f
ah
ah n'existe pas ou n'est pas admissible pour ce jeu.
pikachu
Nouvel intervalle : ??? -- pikachu
evoli
Nouvel intervalle : evoli -- pikachu
lamantine
Nouvel intervalle : evoli -- lamantine
feunard
Nouvel intervalle : feunard -- lamantine
grodoudou
Nouvel intervalle : grodoudou -- lamantine
7
Module𝐴 𝑍, 𝑉 𝑒𝑟𝑠𝑖𝑜𝑛𝑙𝑎𝑡𝑒𝑠𝑡 − 0.1.0 − 24 − 𝑔0𝑏21𝑏𝑓 6
11:07:07
11:07:07
11:07:11
11:07:11
11:08:49
11:08:49
11:08:49
<@foobar>
< Erebot>
<@foobar>
< Erebot>
<@foobar>
< Erebot>
< Erebot>
insecateur
Nouvel intervalle : grodoudou -- insecateur
grolem
Nouvel intervalle : grolem -- insecateur
herbizarre
BINGO ! La réponse était effectivement herbizarre. Félicitations foobar !
La réponse a été trouvée après 8 essais et 1 mots incorrects.
14:50:53
14:50:53
14:50:56
14:50:56
<@Clicky>
< Erebot>
<@Clicky>
< Erebot>
!az pkmn1fr
Une nouvelle partie de A-Z commence sur #erebot avec les listes suivantes : pkmn1f
!az cancel
La partie de A-Z a été arrêtée après 0 essais et 0 mots incorrects. La réponse éta
Current status on http://travis-ci.org/ :
8
Chapitre 3. Usage