Catalyst provides a variety of useful functions to make installing, configuring, and updating plugins a breeze! This guide outlines some of the finer points of using Catalyst.
For basic installation and usage instructions, please visit the Catalyst extension page.
You can confirm the extension successfully installed by running:
You should see
Catalyst Version: #.#.#
If your server already had plugins installed, run the following command to add your existing plugins to the configuration:
You should see
Adding (#) plugins to requires directive
To ensure your requires directive synchronized correctly, run:
You should see:
[Catalyst] Validation success!
If you already know the name of the plugin you want to install, say for example, "NoEscape" simply run:
After queueing the installation, you should see the plugin installs shortly thereafter.
Following our previous example, if you decide you want to update NoEscape to the latest version, use the following command:
Upgrading all of your plugins to the most recent versions is easy with:
You may also specify multiple plugin names to be more specific:
catalyst.update EntityOwner NoEscape
Catalyst provides you a means to configure plugins from command-line. While we realize this may not always be optimal, it is a nice to have.
catalyst.config NoEscape blockAll true
This will set the "blockAll" configuration setting to true.
If you want to search for plugins, using the search command will not only search plugin names, but also authors, descriptions, and documentation.
If you want more information on a plugin after searching, use the
If you decide you no longer want a plugin installed on your server, try the
If the plugin you are removing installed any other dependencies, you will have to
remove those too.
Sometimes you may want to install a plugin that is under the Universal category. For example, HelpText
To install plugins from a different category, such as HelpText - you must specify the category when requiring the plugin
Developers will often have forks or different versions of plugins than are available in the public repository. If you are unsure, you may easily compare your current installation with the public repository by running: