wildphp/module-factoids

Factoids module for WildPHP

Factoids Module

, _(*1)

This module provides basic factoids support for WildPHP. It allows you to store small bits of information to recall later., _(*2)

System Requirements

If your setup can run the main bot, it can run this module as well., _(*3)

Installation

To install this module, we will use composer:, _(*4)

composer require wildphp/module-factoids, _(*5)

That will install all required files for the module. In order to activate the module, add the following line to your modules array in config.neon:, _(*6)

- WildPHP\Modules\Factoids\Factoids

The bot will run the module the next time it is started., _(*7)

Usage

A target can be either a channel name or global (for factoids which exist everywhere). If no target is specified, most commands assume the current channel., _(*8)

For standard users, the following commands are available:, _(*9)

• lsfactoids ([target])
• factoidinfo ([target]) [key]

Standard users may also invoke any factoid., _(*10)

Authenticated users have access to the following commands: * addfactoid ([target]) [key] [value] * Required permission: addfactoid * delfactoid ([target]) [key] * Required permission: delfactoid * editfactoid ([target]) [key] [value] * Required permission: editfactoid * movefactoid [key] ([source target]) [destination target] * Required permission: movefactoid * renamefactoid ([target]) [key] [new key] * Required permission: renamefactoid, _(*11)

Channel-bound factoids will always override global factoids of the same name., _(*12)

Saving factoids

The module will automatically save factoid state in JSON format, to a storage named factoids.dat These factoids will be restored on the next startup., _(*13)

License

This module is licensed under the MIT license. Please see LICENSE to read it., _(*14)