Skip to content
This repository was archived by the owner on Sep 2, 2021. It is now read-only.

Plugins

Jump to bottom
Gareth Coles edited this page Mar 17, 2014 · 4 revisions

Ultros currently ships with four plugins, plus a basic package manager. If you're looking to create a plugin, protocol or package, then see the development page.

Core plugins

Ultros ships with three core plugins - Auth, Bridge and URLs. These encapsulate three of the most-requested features for Ultros - that is to say, a permissions system, a cross-protocol messaging bridge, and a URL title and shortener service. It also ships with a dialectizer, which is essentially a plugin that can change messages that the bot sends - it's just for fun.

  • Auth is our basic permissions and login system. It's still in an early stage, and as such only provides basic permissions management and no management commands, but those are coming. It consists of two parts:
    • Login - Creation and storage of user accounts, along with salted and hashed passwords.
    • Permissions - Storage of permissions that can be used and checked by any plugin or protocol.
  • Bridge is our basic bridging plugin. It provides a simple way of relaying messages between any combination of users, channels and protocols. Right now, it only supports very basic message relaying, but its capabilities will change as we work on it.
  • Dialectizer - A plugin which includes various filters that modify Ultros' messages in some way. This plugin comes with the following filters: cheff, fudd, lower, olde, reverse, and upper. Setting the filter to off disabled the dialectizer.
  • URLs is a plugin designed to work with URLs that are pasted into chats. It can retrieve page titles (which can be extremely useful) and, on request, shorten URLs for easier copying. It also consists of two parts:
    • A URL title handler section - By default, this simply echoes the title of a page at the end of a link, but plugins may extend this to provide special handling for certain sites.
    • A URL shortener system - By default, only tinyurl is available, but other plugins may extend this to provide support for other URL shorteners.
    • Both of these systems can be used by other plugins for retrieving data.

Configuration and usage

You may find information on setting up and using these plugins at their respective wiki pages.

Previous (Configuration) | Home | Next (Development)

Clone this wiki locally