-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the Yaib wiki!
You can pretty much jump in anywhere and help -- Yaib needs testing (manual AND automated), cleanup, bugs filed, documentation, examples, and more plugins. If you want to contribute code, make sure your code is clear, the problem it solves is well documented, and your code is well formatted. If you want to be extra awesome, include tests. Get feedback early and often in irc and open a pull request when your code is ready.
Yaib uses a plugin system to provide functionality by reacting to various events and adding command handlers. Each plugin has access to configuration, its own settings, and optionally a database persistence layer provided using SQLAlchemy. Plugins can do pretty much anything - the list of available plugins below is always growing, and if what you need doesn't exist, you can create your own or request help.
- Logger - Log chat activity to a database.
- Countdown - Count down to the various stages of an event.
- LeaveMessage - Leave messages for other users.
- SimpleResponse - Make Yaib respond to messages and actions
- Poem - Store and display simple haiku/limericks
Need Yaib to do something new or a special plugin? Jump in #yaib on irc.afternet.org and talk about it.
- plugin development documentation
- list all of the events
- walkthrough of the sqlalchemy stuff (see example plugin)
- instructions for migrating plugins
- tests for the rest of the modules, Yaib, and the core plugins
- test setup for plugins
- clean up all the #TODOs
- config.json documentation
- contributing guide
- plugin list/repository/search