This repository contains example code to help you get started with working on and extending Ultros. You can find a full set of API documentation at this site.
There are a number of example plugins here.
This is the standard example plugin - A fully documented, simple example of how to write a plugin with a simple command. This is intended to be an example of how you should structure your plugin.
This is our standard example plugin, rewritten in ClojurePy.
If you want to test this on your instance, you'll need to install clojure-py
from pip. Remember to add that to your module requirements if you're submitting
your package to the contrib repo!
This is our standard example plugin, rewritten in Hy. Hy is not a default requirement for Ultros, and will require that you add it to your module requirements if you're submitting your package to the contrib repo. This allows Ultros to import Hy plugins directly, for full integration with Ultros.
This is our standard example plugin, rewritten in Lua. Lua is supported by an optional plugin loader available from the contrib repo via the package manager. For more information on setting this up and using Lua with Ultros, check out the readme.
This is a plugin that shows how to work with the Web plugin - Specifically, the correct way to add a route. As this plugin doesn't check for permissions, we do recommend that you don't load this plugin on a production server.