0.1.0 • Published 3 years ago

ircgrampp-plugin-commands v0.1.0

Weekly downloads
4
License
GPL-2.0
Repository
github
Last release
3 years ago

Plugin for ircgrampp to adda commands

Install & Configure

Install as globaly:

# npm install -g ircgrampp-plugin-commands

Add file {ircgrampp_config_dir}/plugins/commands.yml with the follow content:

name commands 
enable true

Bridge configuration

Each bridge is defined with the bridge name and params, for example, if you have a bridge name friends:

name commandas 
enable true

friends:
  enable: true
  permissions:
   - admin
   - custom
  admins:
   - jhon
   - jonny
  namespaces:
    example:
      prefix: "myplug:" # All comands like !myplug:list !myplug:save , etc
      permissions:
        - admin

Options (By bridge)

OptionTypeRequiredDefaultDescription
enableboolNofalseEnable plugin
permissionsstring, string[]NoallGeneral types of permisions*
adminsstring, string[]NoemptyList of users in case of custom
allowBotsboolNofalseAllow bots to execute command
namespacesobject[]NoemptyCusto config for namespaces

* Permisions can be: all, admin, custom

Options (By namespace)

OptionTypeRequiredDefaultDescription
prefixstringNoSame as namePrefix to match, ex. ban
permissionsstring, string[]NoemptyExtends access permissions
adminsstring, string[]NoemptyExtends access users
allowBotsboolNofalseAllow bots to execute command