Railgun

if it ain't broke, we'll break it

User Tools

Site Tools


senses:start
You were redirected here from senses.

Sense API documentation

This section contains the documentation for the Komeiji Sense Lua API. This only covers libraries and behaviour provided by the runtime, not libraries that are written as Sense packages themselves.

The Komeiji Sense system is the plugin system for the Satori and Koishi bots in Flashii Chat. Currently the runtime targets Lua 5.4. The primary collaboration and distribution method is the komeiji-senses repository on Patchii. Through this repository you are invited to bring up your own ideas either by forking the repository and implementing the feature yourself or creating an issue on Patchii or feature request topic on Flashii, with which this documentation will hopefully serve as helpful.

Each subdirectory in the komeiji-senses repository functions as its own plugin for Satori and Koishi, referred to as a “Sense” from here on out. A sense is required to have at least a sense.toml info file, actual Lua code isn't even required, but wouldn't get accepted in the repository for obvious reasons. The name of directory is also used as the name of the Sense package where required.

Meta

Types

Packages

Globals

senses/start.txt · Last modified: by flash